ed00537775249c74760fd5f22747073dd6995ad9
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2019
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part$&"
1403 .vindex "&$local_part_suffix$&"
1404 .cindex affix "router precondition"
1405 If the &%local_parts%& option is set, the local part of the address must be in
1406 the set of local parts that it defines. If &%local_part_prefix%& or
1407 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1408 part before this check. If you want to do precondition tests on local parts
1409 that include affixes, you can do so by using a &%condition%& option (see below)
1410 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1411 &$local_part_suffix$& as necessary.
1412 .next
1413 .vindex "&$local_user_uid$&"
1414 .vindex "&$local_user_gid$&"
1415 .vindex "&$home$&"
1416 If the &%check_local_user%& option is set, the local part must be the name of
1417 an account on the local host. If this check succeeds, the uid and gid of the
1418 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1419 user's home directory is placed in &$home$&; these values can be used in the
1420 remaining preconditions.
1421 .next
1422 If the &%router_home_directory%& option is set, it is expanded at this point,
1423 because it overrides the value of &$home$&. If this expansion were left till
1424 later, the value of &$home$& as set by &%check_local_user%& would be used in
1425 subsequent tests. Having two different values of &$home$& in the same router
1426 could lead to confusion.
1427 .next
1428 If the &%senders%& option is set, the envelope sender address must be in the
1429 set of addresses that it defines.
1430 .next
1431 If the &%require_files%& option is set, the existence or non-existence of
1432 specified files is tested.
1433 .next
1434 .cindex "customizing" "precondition"
1435 If the &%condition%& option is set, it is evaluated and tested. This option
1436 uses an expanded string to allow you to set up your own custom preconditions.
1437 Expanded strings are described in chapter &<<CHAPexpand>>&.
1438 .endlist
1439
1440
1441 Note that &%require_files%& comes near the end of the list, so you cannot use
1442 it to check for the existence of a file in which to lookup up a domain, local
1443 part, or sender. However, as these options are all expanded, you can use the
1444 &%exists%& expansion condition to make such tests within each condition. The
1445 &%require_files%& option is intended for checking files that the router may be
1446 going to use internally, or which are needed by a specific transport (for
1447 example, &_.procmailrc_&).
1448
1449
1450
1451 .section "Delivery in detail" "SECID18"
1452 .cindex "delivery" "in detail"
1453 When a message is to be delivered, the sequence of events is as follows:
1454
1455 .ilist
1456 If a system-wide filter file is specified, the message is passed to it. The
1457 filter may add recipients to the message, replace the recipients, discard the
1458 message, cause a new message to be generated, or cause the message delivery to
1459 fail. The format of the system filter file is the same as for Exim user filter
1460 files, described in the separate document entitled &'Exim's interfaces to mail
1461 filtering'&.
1462 .cindex "Sieve filter" "not available for system filter"
1463 (&*Note*&: Sieve cannot be used for system filter files.)
1464
1465 Some additional features are available in system filters &-- see chapter
1466 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1467 filter only once per delivery attempt, however many recipients it has. However,
1468 if there are several delivery attempts because one or more addresses could not
1469 be immediately delivered, the system filter is run each time. The filter
1470 condition &%first_delivery%& can be used to detect the first run of the system
1471 filter.
1472 .next
1473 Each recipient address is offered to each configured router, in turn, subject to
1474 its preconditions, until one is able to handle it. If no router can handle the
1475 address, that is, if they all decline, the address is failed. Because routers
1476 can be targeted at particular domains, several locally handled domains can be
1477 processed entirely independently of each other.
1478 .next
1479 .cindex "routing" "loops in"
1480 .cindex "loop" "while routing"
1481 A router that accepts an address may assign it to a local or a remote
1482 transport. However, the transport is not run at this time. Instead, the address
1483 is placed on a list for the particular transport, which will be run later.
1484 Alternatively, the router may generate one or more new addresses (typically
1485 from alias, forward, or filter files). New addresses are fed back into this
1486 process from the top, but in order to avoid loops, a router ignores any address
1487 which has an identically-named ancestor that was processed by itself.
1488 .next
1489 When all the routing has been done, addresses that have been successfully
1490 handled are passed to their assigned transports. When local transports are
1491 doing real local deliveries, they handle only one address at a time, but if a
1492 local transport is being used as a pseudo-remote transport (for example, to
1493 collect batched SMTP messages for transmission by some other means) multiple
1494 addresses can be handled. Remote transports can always handle more than one
1495 address at a time, but can be configured not to do so, or to restrict multiple
1496 addresses to the same domain.
1497 .next
1498 Each local delivery to a file or a pipe runs in a separate process under a
1499 non-privileged uid, and these deliveries are run one at a time. Remote
1500 deliveries also run in separate processes, normally under a uid that is private
1501 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1502 run in parallel. The maximum number of simultaneous remote deliveries for any
1503 one message is set by the &%remote_max_parallel%& option.
1504 The order in which deliveries are done is not defined, except that all local
1505 deliveries happen before any remote deliveries.
1506 .next
1507 .cindex "queue runner"
1508 When it encounters a local delivery during a queue run, Exim checks its retry
1509 database to see if there has been a previous temporary delivery failure for the
1510 address before running the local transport. If there was a previous failure,
1511 Exim does not attempt a new delivery until the retry time for the address is
1512 reached. However, this happens only for delivery attempts that are part of a
1513 queue run. Local deliveries are always attempted when delivery immediately
1514 follows message reception, even if retry times are set for them. This makes for
1515 better behaviour if one particular message is causing problems (for example,
1516 causing quota overflow, or provoking an error in a filter file).
1517 .next
1518 .cindex "delivery" "retry in remote transports"
1519 Remote transports do their own retry handling, since an address may be
1520 deliverable to one of a number of hosts, each of which may have a different
1521 retry time. If there have been previous temporary failures and no host has
1522 reached its retry time, no delivery is attempted, whether in a queue run or
1523 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1524 .next
1525 If there were any permanent errors, a bounce message is returned to an
1526 appropriate address (the sender in the common case), with details of the error
1527 for each failing address. Exim can be configured to send copies of bounce
1528 messages to other addresses.
1529 .next
1530 .cindex "delivery" "deferral"
1531 If one or more addresses suffered a temporary failure, the message is left on
1532 the queue, to be tried again later. Delivery of these addresses is said to be
1533 &'deferred'&.
1534 .next
1535 When all the recipient addresses have either been delivered or bounced,
1536 handling of the message is complete. The spool files and message log are
1537 deleted, though the message log can optionally be preserved if required.
1538 .endlist
1539
1540
1541
1542
1543 .section "Retry mechanism" "SECID19"
1544 .cindex "delivery" "retry mechanism"
1545 .cindex "retry" "description of mechanism"
1546 .cindex "queue runner"
1547 Exim's mechanism for retrying messages that fail to get delivered at the first
1548 attempt is the queue runner process. You must either run an Exim daemon that
1549 uses the &%-q%& option with a time interval to start queue runners at regular
1550 intervals or use some other means (such as &'cron'&) to start them. If you do
1551 not arrange for queue runners to be run, messages that fail temporarily at the
1552 first attempt will remain in your queue forever. A queue runner process works
1553 its way through the queue, one message at a time, trying each delivery that has
1554 passed its retry time.
1555 You can run several queue runners at once.
1556
1557 Exim uses a set of configured rules to determine when next to retry the failing
1558 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1559 should give up trying to deliver to the address, at which point it generates a
1560 bounce message. If no retry rules are set for a particular host, address, and
1561 error combination, no retries are attempted, and temporary errors are treated
1562 as permanent.
1563
1564
1565
1566 .section "Temporary delivery failure" "SECID20"
1567 .cindex "delivery" "temporary failure"
1568 There are many reasons why a message may not be immediately deliverable to a
1569 particular address. Failure to connect to a remote machine (because it, or the
1570 connection to it, is down) is one of the most common. Temporary failures may be
1571 detected during routing as well as during the transport stage of delivery.
1572 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1573 is on a file system where the user is over quota. Exim can be configured to
1574 impose its own quotas on local mailboxes; where system quotas are set they will
1575 also apply.
1576
1577 If a host is unreachable for a period of time, a number of messages may be
1578 waiting for it by the time it recovers, and sending them in a single SMTP
1579 connection is clearly beneficial. Whenever a delivery to a remote host is
1580 deferred,
1581 .cindex "hints database" "deferred deliveries"
1582 Exim makes a note in its hints database, and whenever a successful
1583 SMTP delivery has happened, it looks to see if any other messages are waiting
1584 for the same host. If any are found, they are sent over the same SMTP
1585 connection, subject to a configuration limit as to the maximum number in any
1586 one connection.
1587
1588
1589
1590 .section "Permanent delivery failure" "SECID21"
1591 .cindex "delivery" "permanent failure"
1592 .cindex "bounce message" "when generated"
1593 When a message cannot be delivered to some or all of its intended recipients, a
1594 bounce message is generated. Temporary delivery failures turn into permanent
1595 errors when their timeout expires. All the addresses that fail in a given
1596 delivery attempt are listed in a single message. If the original message has
1597 many recipients, it is possible for some addresses to fail in one delivery
1598 attempt and others to fail subsequently, giving rise to more than one bounce
1599 message. The wording of bounce messages can be customized by the administrator.
1600 See chapter &<<CHAPemsgcust>>& for details.
1601
1602 .cindex "&'X-Failed-Recipients:'& header line"
1603 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1604 failed addresses, for the benefit of programs that try to analyse such messages
1605 automatically.
1606
1607 .cindex "bounce message" "recipient of"
1608 A bounce message is normally sent to the sender of the original message, as
1609 obtained from the message's envelope. For incoming SMTP messages, this is the
1610 address given in the MAIL command. However, when an address is expanded via a
1611 forward or alias file, an alternative address can be specified for delivery
1612 failures of the generated addresses. For a mailing list expansion (see section
1613 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1614 of the list.
1615
1616
1617
1618 .section "Failures to deliver bounce messages" "SECID22"
1619 .cindex "bounce message" "failure to deliver"
1620 If a bounce message (either locally generated or received from a remote host)
1621 itself suffers a permanent delivery failure, the message is left in the queue,
1622 but it is frozen, awaiting the attention of an administrator. There are options
1623 that can be used to make Exim discard such failed messages, or to keep them
1624 for only a short time (see &%timeout_frozen_after%& and
1625 &%ignore_bounce_errors_after%&).
1626
1627
1628
1629
1630
1631 . ////////////////////////////////////////////////////////////////////////////
1632 . ////////////////////////////////////////////////////////////////////////////
1633
1634 .chapter "Building and installing Exim" "CHID3"
1635 .scindex IIDbuex "building Exim"
1636
1637 .section "Unpacking" "SECID23"
1638 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1639 creates a directory with the name of the current release (for example,
1640 &_exim-&version()_&) into which the following files are placed:
1641
1642 .table2 140pt
1643 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1644 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1645   documented"
1646 .irow &_LICENCE_&         "the GNU General Public Licence"
1647 .irow &_Makefile_&        "top-level make file"
1648 .irow &_NOTICE_&          "conditions for the use of Exim"
1649 .irow &_README_&          "list of files, directories and simple build &&&
1650   instructions"
1651 .endtable
1652
1653 Other files whose names begin with &_README_& may also be present. The
1654 following subdirectories are created:
1655
1656 .table2 140pt
1657 .irow &_Local_&           "an empty directory for local configuration files"
1658 .irow &_OS_&              "OS-specific files"
1659 .irow &_doc_&             "documentation files"
1660 .irow &_exim_monitor_&    "source files for the Exim monitor"
1661 .irow &_scripts_&         "scripts used in the build process"
1662 .irow &_src_&             "remaining source files"
1663 .irow &_util_&            "independent utilities"
1664 .endtable
1665
1666 The main utility programs are contained in the &_src_& directory and are built
1667 with the Exim binary. The &_util_& directory contains a few optional scripts
1668 that may be useful to some sites.
1669
1670
1671 .section "Multiple machine architectures and operating systems" "SECID24"
1672 .cindex "building Exim" "multiple OS/architectures"
1673 The building process for Exim is arranged to make it easy to build binaries for
1674 a number of different architectures and operating systems from the same set of
1675 source files. Compilation does not take place in the &_src_& directory.
1676 Instead, a &'build directory'& is created for each architecture and operating
1677 system.
1678 .cindex "symbolic link" "to build directory"
1679 Symbolic links to the sources are installed in this directory, which is where
1680 the actual building takes place. In most cases, Exim can discover the machine
1681 architecture and operating system for itself, but the defaults can be
1682 overridden if necessary.
1683 .cindex compiler requirements
1684 .cindex compiler version
1685 A C99-capable compiler will be required for the build.
1686
1687
1688 .section "PCRE library" "SECTpcre"
1689 .cindex "PCRE library"
1690 Exim no longer has an embedded PCRE library as the vast majority of
1691 modern systems include PCRE as a system library, although you may need to
1692 install the PCRE package or the PCRE development package for your operating
1693 system. If your system has a normal PCRE installation the Exim build
1694 process will need no further configuration. If the library or the
1695 headers are in an unusual location you will need to either set the PCRE_LIBS
1696 and INCLUDE directives appropriately,
1697 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1698 If your operating system has no
1699 PCRE support then you will need to obtain and build the current PCRE
1700 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1701 More information on PCRE is available at &url(https://www.pcre.org/).
1702
1703 .section "DBM libraries" "SECTdb"
1704 .cindex "DBM libraries" "discussion of"
1705 .cindex "hints database" "DBM files used for"
1706 Even if you do not use any DBM files in your configuration, Exim still needs a
1707 DBM library in order to operate, because it uses indexed files for its hints
1708 databases. Unfortunately, there are a number of DBM libraries in existence, and
1709 different operating systems often have different ones installed.
1710
1711 .cindex "Solaris" "DBM library for"
1712 .cindex "IRIX, DBM library for"
1713 .cindex "BSD, DBM library for"
1714 .cindex "Linux, DBM library for"
1715 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1716 Linux distribution, the DBM configuration should happen automatically, and you
1717 may be able to ignore this section. Otherwise, you may have to learn more than
1718 you would like about DBM libraries from what follows.
1719
1720 .cindex "&'ndbm'& DBM library"
1721 Licensed versions of Unix normally contain a library of DBM functions operating
1722 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1723 versions of Unix seem to vary in what they contain as standard. In particular,
1724 some early versions of Linux have no default DBM library, and different
1725 distributors have chosen to bundle different libraries with their packaged
1726 versions. However, the more recent releases seem to have standardized on the
1727 Berkeley DB library.
1728
1729 Different DBM libraries have different conventions for naming the files they
1730 use. When a program opens a file called &_dbmfile_&, there are several
1731 possibilities:
1732
1733 .olist
1734 A traditional &'ndbm'& implementation, such as that supplied as part of
1735 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1736 .next
1737 .cindex "&'gdbm'& DBM library"
1738 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1739 compatibility interface it makes two different hard links to it with names
1740 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1741 filename is used unmodified.
1742 .next
1743 .cindex "Berkeley DB library"
1744 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1745 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1746 programmer exactly the same as the traditional &'ndbm'& implementation.
1747 .next
1748 If the Berkeley package is used in its native mode, it operates on a single
1749 file called &_dbmfile_&; the programmer's interface is somewhat different to
1750 the traditional &'ndbm'& interface.
1751 .next
1752 To complicate things further, there are several very different versions of the
1753 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1754 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1755 Maintenance of some of the earlier releases has ceased. All versions of
1756 Berkeley DB could be obtained from
1757 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1758 page with far newer versions listed.
1759 It is probably wise to plan to move your storage configurations away from
1760 Berkeley DB format, as today there are smaller and simpler alternatives more
1761 suited to Exim's usage model.
1762 .next
1763 .cindex "&'tdb'& DBM library"
1764 Yet another DBM library, called &'tdb'&, is available from
1765 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1766 operates on a single file.
1767 .endlist
1768
1769 .cindex "USE_DB"
1770 .cindex "DBM libraries" "configuration for building"
1771 Exim and its utilities can be compiled to use any of these interfaces. In order
1772 to use any version of the Berkeley DB package in native mode, you must set
1773 USE_DB in an appropriate configuration file (typically
1774 &_Local/Makefile_&). For example:
1775 .code
1776 USE_DB=yes
1777 .endd
1778 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1779 error is diagnosed if you set more than one of these.
1780
1781 At the lowest level, the build-time configuration sets none of these options,
1782 thereby assuming an interface of type (1). However, some operating system
1783 configuration files (for example, those for the BSD operating systems and
1784 Linux) assume type (4) by setting USE_DB as their default, and the
1785 configuration files for Cygwin set USE_GDBM. Anything you set in
1786 &_Local/Makefile_&, however, overrides these system defaults.
1787
1788 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1789 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1790 in one of these lines:
1791 .code
1792 DBMLIB = -ldb
1793 DBMLIB = -ltdb
1794 .endd
1795 Settings like that will work if the DBM library is installed in the standard
1796 place. Sometimes it is not, and the library's header file may also not be in
1797 the default path. You may need to set INCLUDE to specify where the header
1798 file is, and to specify the path to the library more fully in DBMLIB, as in
1799 this example:
1800 .code
1801 INCLUDE=-I/usr/local/include/db-4.1
1802 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1803 .endd
1804 There is further detailed discussion about the various DBM libraries in the
1805 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1806
1807
1808
1809 .section "Pre-building configuration" "SECID25"
1810 .cindex "building Exim" "pre-building configuration"
1811 .cindex "configuration for building Exim"
1812 .cindex "&_Local/Makefile_&"
1813 .cindex "&_src/EDITME_&"
1814 Before building Exim, a local configuration file that specifies options
1815 independent of any operating system has to be created with the name
1816 &_Local/Makefile_&. A template for this file is supplied as the file
1817 &_src/EDITME_&, and it contains full descriptions of all the option settings
1818 therein. These descriptions are therefore not repeated here. If you are
1819 building Exim for the first time, the simplest thing to do is to copy
1820 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1821
1822 There are three settings that you must supply, because Exim will not build
1823 without them. They are the location of the runtime configuration file
1824 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1825 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1826 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1827 a colon-separated list of filenames; Exim uses the first of them that exists.
1828
1829 There are a few other parameters that can be specified either at build time or
1830 at runtime, to enable the same binary to be used on a number of different
1831 machines. However, if the locations of Exim's spool directory and log file
1832 directory (if not within the spool directory) are fixed, it is recommended that
1833 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1834 detected early in Exim's execution (such as a malformed configuration file) can
1835 be logged.
1836
1837 .cindex "content scanning" "specifying at build time"
1838 Exim's interfaces for calling virus and spam scanning software directly from
1839 access control lists are not compiled by default. If you want to include these
1840 facilities, you need to set
1841 .code
1842 WITH_CONTENT_SCAN=yes
1843 .endd
1844 in your &_Local/Makefile_&. For details of the facilities themselves, see
1845 chapter &<<CHAPexiscan>>&.
1846
1847
1848 .cindex "&_Local/eximon.conf_&"
1849 .cindex "&_exim_monitor/EDITME_&"
1850 If you are going to build the Exim monitor, a similar configuration process is
1851 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1852 your installation and saved under the name &_Local/eximon.conf_&. If you are
1853 happy with the default settings described in &_exim_monitor/EDITME_&,
1854 &_Local/eximon.conf_& can be empty, but it must exist.
1855
1856 This is all the configuration that is needed in straightforward cases for known
1857 operating systems. However, the building process is set up so that it is easy
1858 to override options that are set by default or by operating-system-specific
1859 configuration files, for example, to change the C compiler, which
1860 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1861 do this.
1862
1863
1864
1865 .section "Support for iconv()" "SECID26"
1866 .cindex "&[iconv()]& support"
1867 .cindex "RFC 2047"
1868 The contents of header lines in messages may be encoded according to the rules
1869 described RFC 2047. This makes it possible to transmit characters that are not
1870 in the ASCII character set, and to label them as being in a particular
1871 character set. When Exim is inspecting header lines by means of the &%$h_%&
1872 mechanism, it decodes them, and translates them into a specified character set
1873 (default is set at build time). The translation is possible only if the operating system
1874 supports the &[iconv()]& function.
1875
1876 However, some of the operating systems that supply &[iconv()]& do not support
1877 very many conversions. The GNU &%libiconv%& library (available from
1878 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1879 systems to remedy this deficiency, as well as on systems that do not supply
1880 &[iconv()]& at all. After installing &%libiconv%&, you should add
1881 .code
1882 HAVE_ICONV=yes
1883 .endd
1884 to your &_Local/Makefile_& and rebuild Exim.
1885
1886
1887
1888 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1889 .cindex "TLS" "including support for TLS"
1890 .cindex "encryption" "including support for"
1891 .cindex "OpenSSL" "building Exim with"
1892 .cindex "GnuTLS" "building Exim with"
1893 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1894 command as per RFC 2487. It can also support clients that expect to
1895 start a TLS session immediately on connection to a non-standard port (see the
1896 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1897 line option).
1898
1899 If you want to build Exim with TLS support, you must first install either the
1900 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1901 implementing SSL.
1902
1903 If you do not want TLS support you should set
1904 .code
1905 DISABLE_TLS=yes
1906 .endd
1907 in &_Local/Makefile_&.
1908
1909 If OpenSSL is installed, you should set
1910 .code
1911 USE_OPENSL=yes
1912 TLS_LIBS=-lssl -lcrypto
1913 .endd
1914 in &_Local/Makefile_&. You may also need to specify the locations of the
1915 OpenSSL library and include files. For example:
1916 .code
1917 USE_OPENSSL=yes
1918 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1919 TLS_INCLUDE=-I/usr/local/openssl/include/
1920 .endd
1921 .cindex "pkg-config" "OpenSSL"
1922 If you have &'pkg-config'& available, then instead you can just use:
1923 .code
1924 USE_OPENSSL=yes
1925 USE_OPENSSL_PC=openssl
1926 .endd
1927 .cindex "USE_GNUTLS"
1928 If GnuTLS is installed, you should set
1929 .code
1930 USE_GNUTLS=yes
1931 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1932 .endd
1933 in &_Local/Makefile_&, and again you may need to specify the locations of the
1934 library and include files. For example:
1935 .code
1936 USE_GNUTLS=yes
1937 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1938 TLS_INCLUDE=-I/usr/gnu/include
1939 .endd
1940 .cindex "pkg-config" "GnuTLS"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_GNUTLS=yes
1944 USE_GNUTLS_PC=gnutls
1945 .endd
1946
1947 You do not need to set TLS_INCLUDE if the relevant directory is already
1948 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1949 given in chapter &<<CHAPTLS>>&.
1950
1951
1952
1953
1954 .section "Use of tcpwrappers" "SECID27"
1955
1956 .cindex "tcpwrappers, building Exim to support"
1957 .cindex "USE_TCP_WRAPPERS"
1958 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1959 .cindex "tcp_wrappers_daemon_name"
1960 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1961 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1962 alternative to Exim's own checking facilities for installations that are
1963 already making use of &'tcpwrappers'& for other purposes. To do this, you
1964 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1965 &_tcpd.h_& to be available at compile time, and also ensure that the library
1966 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1967 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1968 you might have
1969 .code
1970 USE_TCP_WRAPPERS=yes
1971 CFLAGS=-O -I/usr/local/include
1972 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1973 .endd
1974 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1975 files is &"exim"&. For example, the line
1976 .code
1977 exim : LOCAL  192.168.1.  .friendly.domain.example
1978 .endd
1979 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1980 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1981 All other connections are denied. The daemon name used by &'tcpwrappers'&
1982 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1983 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1984 configure file. Consult the &'tcpwrappers'& documentation for
1985 further details.
1986
1987
1988 .section "Including support for IPv6" "SECID28"
1989 .cindex "IPv6" "including support for"
1990 Exim contains code for use on systems that have IPv6 support. Setting
1991 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1992 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1993 where the IPv6 support is not fully integrated into the normal include and
1994 library files.
1995
1996 Two different types of DNS record for handling IPv6 addresses have been
1997 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1998 currently seen as the mainstream. Another record type called A6 was proposed
1999 as better than AAAA because it had more flexibility. However, it was felt to be
2000 over-complex, and its status was reduced to &"experimental"&.
2001 Exim used to
2002 have a compile option for including A6 record support but this has now been
2003 withdrawn.
2004
2005
2006
2007 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2008 .cindex "lookup modules"
2009 .cindex "dynamic modules"
2010 .cindex ".so building"
2011 On some platforms, Exim supports not compiling all lookup types directly into
2012 the main binary, instead putting some into external modules which can be loaded
2013 on demand.
2014 This permits packagers to build Exim with support for lookups with extensive
2015 library dependencies without requiring all users to install all of those
2016 dependencies.
2017 Most, but not all, lookup types can be built this way.
2018
2019 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2020 installed; Exim will only load modules from that directory, as a security
2021 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2022 for your OS; see &_OS/Makefile-Linux_& for an example.
2023 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2024 see &_src/EDITME_& for details.
2025
2026 Then, for each module to be loaded dynamically, define the relevant
2027 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2028 For example, this will build in lsearch but load sqlite and mysql support
2029 on demand:
2030 .code
2031 LOOKUP_LSEARCH=yes
2032 LOOKUP_SQLITE=2
2033 LOOKUP_MYSQL=2
2034 .endd
2035
2036
2037 .section "The building process" "SECID29"
2038 .cindex "build directory"
2039 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2040 created, run &'make'& at the top level. It determines the architecture and
2041 operating system types, and creates a build directory if one does not exist.
2042 For example, on a Sun system running Solaris 8, the directory
2043 &_build-SunOS5-5.8-sparc_& is created.
2044 .cindex "symbolic link" "to source files"
2045 Symbolic links to relevant source files are installed in the build directory.
2046
2047 If this is the first time &'make'& has been run, it calls a script that builds
2048 a make file inside the build directory, using the configuration files from the
2049 &_Local_& directory. The new make file is then passed to another instance of
2050 &'make'&. This does the real work, building a number of utility scripts, and
2051 then compiling and linking the binaries for the Exim monitor (if configured), a
2052 number of utility programs, and finally Exim itself. The command &`make
2053 makefile`& can be used to force a rebuild of the make file in the build
2054 directory, should this ever be necessary.
2055
2056 If you have problems building Exim, check for any comments there may be in the
2057 &_README_& file concerning your operating system, and also take a look at the
2058 FAQ, where some common problems are covered.
2059
2060
2061
2062 .section 'Output from &"make"&' "SECID283"
2063 The output produced by the &'make'& process for compile lines is often very
2064 unreadable, because these lines can be very long. For this reason, the normal
2065 output is suppressed by default, and instead output similar to that which
2066 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2067 each module that is being compiled or linked. However, it is still possible to
2068 get the full output, by calling &'make'& like this:
2069 .code
2070 FULLECHO='' make -e
2071 .endd
2072 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2073 command reflection in &'make'&. When you ask for the full output, it is
2074 given in addition to the short output.
2075
2076
2077
2078 .section "Overriding build-time options for Exim" "SECToverride"
2079 .cindex "build-time options, overriding"
2080 The main make file that is created at the beginning of the building process
2081 consists of the concatenation of a number of files which set configuration
2082 values, followed by a fixed set of &'make'& instructions. If a value is set
2083 more than once, the last setting overrides any previous ones. This provides a
2084 convenient way of overriding defaults. The files that are concatenated are, in
2085 order:
2086 .display
2087 &_OS/Makefile-Default_&
2088 &_OS/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile_&
2090 &_Local/Makefile-_&<&'ostype'&>
2091 &_Local/Makefile-_&<&'archtype'&>
2092 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2093 &_OS/Makefile-Base_&
2094 .endd
2095 .cindex "&_Local/Makefile_&"
2096 .cindex "building Exim" "operating system type"
2097 .cindex "building Exim" "architecture type"
2098 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2099 architecture type. &_Local/Makefile_& is required to exist, and the building
2100 process fails if it is absent. The other three &_Local_& files are optional,
2101 and are often not needed.
2102
2103 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2104 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2105 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2106 values are used, thereby providing a means of forcing particular settings.
2107 Otherwise, the scripts try to get values from the &%uname%& command. If this
2108 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2109 of &'ad hoc'& transformations are then applied, to produce the standard names
2110 that Exim expects. You can run these scripts directly from the shell in order
2111 to find out what values are being used on your system.
2112
2113
2114 &_OS/Makefile-Default_& contains comments about the variables that are set
2115 therein. Some (but not all) are mentioned below. If there is something that
2116 needs changing, review the contents of this file and the contents of the make
2117 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2118 default values are.
2119
2120
2121 .cindex "building Exim" "overriding default settings"
2122 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2123 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2124 need to change the original files. Instead, you should make the changes by
2125 putting the new values in an appropriate &_Local_& file. For example,
2126 .cindex "Tru64-Unix build-time settings"
2127 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2128 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2129 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2130 called with the option &%-std1%&, to make it recognize some of the features of
2131 Standard C that Exim uses. (Most other compilers recognize Standard C by
2132 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2133 containing the lines
2134 .code
2135 CC=cc
2136 CFLAGS=-std1
2137 .endd
2138 If you are compiling for just one operating system, it may be easier to put
2139 these lines directly into &_Local/Makefile_&.
2140
2141 Keeping all your local configuration settings separate from the distributed
2142 files makes it easy to transfer them to new versions of Exim simply by copying
2143 the contents of the &_Local_& directory.
2144
2145
2146 .cindex "NIS lookup type" "including support for"
2147 .cindex "NIS+ lookup type" "including support for"
2148 .cindex "LDAP" "including support for"
2149 .cindex "lookup" "inclusion in binary"
2150 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2151 lookup, but not all systems have these components installed, so the default is
2152 not to include the relevant code in the binary. All the different kinds of file
2153 and database lookup that Exim supports are implemented as separate code modules
2154 which are included only if the relevant compile-time options are set. In the
2155 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2156 .code
2157 LOOKUP_LDAP=yes
2158 LOOKUP_NIS=yes
2159 LOOKUP_NISPLUS=yes
2160 .endd
2161 and similar settings apply to the other lookup types. They are all listed in
2162 &_src/EDITME_&. In many cases the relevant include files and interface
2163 libraries need to be installed before compiling Exim.
2164 .cindex "cdb" "including support for"
2165 However, there are some optional lookup types (such as cdb) for which
2166 the code is entirely contained within Exim, and no external include
2167 files or libraries are required. When a lookup type is not included in the
2168 binary, attempts to configure Exim to use it cause runtime configuration
2169 errors.
2170
2171 .cindex "pkg-config" "lookups"
2172 .cindex "pkg-config" "authenticators"
2173 Many systems now use a tool called &'pkg-config'& to encapsulate information
2174 about how to compile against a library; Exim has some initial support for
2175 being able to use pkg-config for lookups and authenticators.  For any given
2176 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2177 variable with the &`_PC`& suffix in the name and assign as the value the
2178 name of the package to be queried.  The results of querying via the
2179 &'pkg-config'& command will be added to the appropriate Makefile variables
2180 with &`+=`& directives, so your version of &'make'& will need to support that
2181 syntax.  For instance:
2182 .code
2183 LOOKUP_SQLITE=yes
2184 LOOKUP_SQLITE_PC=sqlite3
2185 AUTH_GSASL=yes
2186 AUTH_GSASL_PC=libgsasl
2187 AUTH_HEIMDAL_GSSAPI=yes
2188 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2189 .endd
2190
2191 .cindex "Perl" "including support for"
2192 Exim can be linked with an embedded Perl interpreter, allowing Perl
2193 subroutines to be called during string expansion. To enable this facility,
2194 .code
2195 EXIM_PERL=perl.o
2196 .endd
2197 must be defined in &_Local/Makefile_&. Details of this facility are given in
2198 chapter &<<CHAPperl>>&.
2199
2200 .cindex "X11 libraries, location of"
2201 The location of the X11 libraries is something that varies a lot between
2202 operating systems, and there may be different versions of X11 to cope
2203 with. Exim itself makes no use of X11, but if you are compiling the Exim
2204 monitor, the X11 libraries must be available.
2205 The following three variables are set in &_OS/Makefile-Default_&:
2206 .code
2207 X11=/usr/X11R6
2208 XINCLUDE=-I$(X11)/include
2209 XLFLAGS=-L$(X11)/lib
2210 .endd
2211 These are overridden in some of the operating-system configuration files. For
2212 example, in &_OS/Makefile-SunOS5_& there is
2213 .code
2214 X11=/usr/openwin
2215 XINCLUDE=-I$(X11)/include
2216 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2217 .endd
2218 If you need to override the default setting for your operating system, place a
2219 definition of all three of these variables into your
2220 &_Local/Makefile-<ostype>_& file.
2221
2222 .cindex "EXTRALIBS"
2223 If you need to add any extra libraries to the link steps, these can be put in a
2224 variable called EXTRALIBS, which appears in all the link commands, but by
2225 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2226 command for linking the main Exim binary, and not for any associated utilities.
2227
2228 .cindex "DBM libraries" "configuration for building"
2229 There is also DBMLIB, which appears in the link commands for binaries that
2230 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2231 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2232 binary, and which can be used, for example, to include additional X11
2233 libraries.
2234
2235 .cindex "configuration file" "editing"
2236 The make file copes with rebuilding Exim correctly if any of the configuration
2237 files are edited. However, if an optional configuration file is deleted, it is
2238 necessary to touch the associated non-optional file (that is,
2239 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2240
2241
2242 .section "OS-specific header files" "SECID30"
2243 .cindex "&_os.h_&"
2244 .cindex "building Exim" "OS-specific C header files"
2245 The &_OS_& directory contains a number of files with names of the form
2246 &_os.h-<ostype>_&. These are system-specific C header files that should not
2247 normally need to be changed. There is a list of macro settings that are
2248 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2249 are porting Exim to a new operating system.
2250
2251
2252
2253 .section "Overriding build-time options for the monitor" "SECID31"
2254 .cindex "building Eximon"
2255 A similar process is used for overriding things when building the Exim monitor,
2256 where the files that are involved are
2257 .display
2258 &_OS/eximon.conf-Default_&
2259 &_OS/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf_&
2261 &_Local/eximon.conf-_&<&'ostype'&>
2262 &_Local/eximon.conf-_&<&'archtype'&>
2263 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2264 .endd
2265 .cindex "&_Local/eximon.conf_&"
2266 As with Exim itself, the final three files need not exist, and in this case the
2267 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2268 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2269 variables of the same name, preceded by EXIMON_. For example, setting
2270 EXIMON_LOG_DEPTH in the environment overrides the value of
2271 LOG_DEPTH at runtime.
2272 .ecindex IIDbuex
2273
2274
2275 .section "Installing Exim binaries and scripts" "SECID32"
2276 .cindex "installing Exim"
2277 .cindex "BIN_DIRECTORY"
2278 The command &`make install`& runs the &(exim_install)& script with no
2279 arguments. The script copies binaries and utility scripts into the directory
2280 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2281 .cindex "setuid" "installing Exim with"
2282 The install script copies files only if they are newer than the files they are
2283 going to replace. The Exim binary is required to be owned by root and have the
2284 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2285 install`& as root so that it can set up the Exim binary in this way. However, in
2286 some special situations (for example, if a host is doing no local deliveries)
2287 it may be possible to run Exim without making the binary setuid root (see
2288 chapter &<<CHAPsecurity>>& for details).
2289
2290 .cindex "CONFIGURE_FILE"
2291 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2292 in &_Local/Makefile_&. If this names a single file, and the file does not
2293 exist, the default configuration file &_src/configure.default_& is copied there
2294 by the installation script. If a runtime configuration file already exists, it
2295 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2296 alternative files, no default is installed.
2297
2298 .cindex "system aliases file"
2299 .cindex "&_/etc/aliases_&"
2300 One change is made to the default configuration file when it is installed: the
2301 default configuration contains a router that references a system aliases file.
2302 The path to this file is set to the value specified by
2303 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2304 If the system aliases file does not exist, the installation script creates it,
2305 and outputs a comment to the user.
2306
2307 The created file contains no aliases, but it does contain comments about the
2308 aliases a site should normally have. Mail aliases have traditionally been
2309 kept in &_/etc/aliases_&. However, some operating systems are now using
2310 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2311 Exim's configuration if necessary.
2312
2313 The default configuration uses the local host's name as the only local domain,
2314 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2315 running as the local user. System aliases and &_.forward_& files in users' home
2316 directories are supported, but no NIS or NIS+ support is configured. Domains
2317 other than the name of the local host are routed using the DNS, with delivery
2318 over SMTP.
2319
2320 It is possible to install Exim for special purposes (such as building a binary
2321 distribution) in a private part of the file system. You can do this by a
2322 command such as
2323 .code
2324 make DESTDIR=/some/directory/ install
2325 .endd
2326 This has the effect of pre-pending the specified directory to all the file
2327 paths, except the name of the system aliases file that appears in the default
2328 configuration. (If a default alias file is created, its name &'is'& modified.)
2329 For backwards compatibility, ROOT is used if DESTDIR is not set,
2330 but this usage is deprecated.
2331
2332 .cindex "installing Exim" "what is not installed"
2333 Running &'make install'& does not copy the Exim 4 conversion script
2334 &'convert4r4'&. You will probably run this only once if you are
2335 upgrading from Exim 3. None of the documentation files in the &_doc_&
2336 directory are copied, except for the info files when you have set
2337 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2338
2339 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2340 to their names. The Exim binary itself, however, is handled differently. It is
2341 installed under a name that includes the version number and the compile number,
2342 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2343 called &_exim_& to point to the binary. If you are updating a previous version
2344 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2345 from the directory (as seen by other processes).
2346
2347 .cindex "installing Exim" "testing the script"
2348 If you want to see what the &'make install'& will do before running it for
2349 real, you can pass the &%-n%& option to the installation script by this
2350 command:
2351 .code
2352 make INSTALL_ARG=-n install
2353 .endd
2354 The contents of the variable INSTALL_ARG are passed to the installation
2355 script. You do not need to be root to run this test. Alternatively, you can run
2356 the installation script directly, but this must be from within the build
2357 directory. For example, from the top-level Exim directory you could use this
2358 command:
2359 .code
2360 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2361 .endd
2362 .cindex "installing Exim" "install script options"
2363 There are two other options that can be supplied to the installation script.
2364
2365 .ilist
2366 &%-no_chown%& bypasses the call to change the owner of the installed binary
2367 to root, and the call to make it a setuid binary.
2368 .next
2369 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2370 installed binary.
2371 .endlist
2372
2373 INSTALL_ARG can be used to pass these options to the script. For example:
2374 .code
2375 make INSTALL_ARG=-no_symlink install
2376 .endd
2377 The installation script can also be given arguments specifying which files are
2378 to be copied. For example, to install just the Exim binary, and nothing else,
2379 without creating the symbolic link, you could use:
2380 .code
2381 make INSTALL_ARG='-no_symlink exim' install
2382 .endd
2383
2384
2385
2386 .section "Installing info documentation" "SECTinsinfdoc"
2387 .cindex "installing Exim" "&'info'& documentation"
2388 Not all systems use the GNU &'info'& system for documentation, and for this
2389 reason, the Texinfo source of Exim's documentation is not included in the main
2390 distribution. Instead it is available separately from the FTP site (see section
2391 &<<SECTavail>>&).
2392
2393 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2394 source of the documentation is found in the source tree, running &`make
2395 install`& automatically builds the info files and installs them.
2396
2397
2398
2399 .section "Setting up the spool directory" "SECID33"
2400 .cindex "spool directory" "creating"
2401 When it starts up, Exim tries to create its spool directory if it does not
2402 exist. The Exim uid and gid are used for the owner and group of the spool
2403 directory. Sub-directories are automatically created in the spool directory as
2404 necessary.
2405
2406
2407
2408
2409 .section "Testing" "SECID34"
2410 .cindex "testing" "installation"
2411 Having installed Exim, you can check that the runtime configuration file is
2412 syntactically valid by running the following command, which assumes that the
2413 Exim binary directory is within your PATH environment variable:
2414 .code
2415 exim -bV
2416 .endd
2417 If there are any errors in the configuration file, Exim outputs error messages.
2418 Otherwise it outputs the version number and build date,
2419 the DBM library that is being used, and information about which drivers and
2420 other optional code modules are included in the binary.
2421 Some simple routing tests can be done by using the address testing option. For
2422 example,
2423 .display
2424 &`exim -bt`& <&'local username'&>
2425 .endd
2426 should verify that it recognizes a local mailbox, and
2427 .display
2428 &`exim -bt`& <&'remote address'&>
2429 .endd
2430 a remote one. Then try getting it to deliver mail, both locally and remotely.
2431 This can be done by passing messages directly to Exim, without going through a
2432 user agent. For example:
2433 .code
2434 exim -v postmaster@your.domain.example
2435 From: user@your.domain.example
2436 To: postmaster@your.domain.example
2437 Subject: Testing Exim
2438
2439 This is a test message.
2440 ^D
2441 .endd
2442 The &%-v%& option causes Exim to output some verification of what it is doing.
2443 In this case you should see copies of three log lines, one for the message's
2444 arrival, one for its delivery, and one containing &"Completed"&.
2445
2446 .cindex "delivery" "problems with"
2447 If you encounter problems, look at Exim's log files (&'mainlog'& and
2448 &'paniclog'&) to see if there is any relevant information there. Another source
2449 of information is running Exim with debugging turned on, by specifying the
2450 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2451 with debugging turned on by a command of the form
2452 .display
2453 &`exim -d -M`& <&'exim-message-id'&>
2454 .endd
2455 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2456 produces rather a lot of output, but you can cut this down to specific areas.
2457 For example, if you use &%-d-all+route%& only the debugging information
2458 relevant to routing is included. (See the &%-d%& option in chapter
2459 &<<CHAPcommandline>>& for more details.)
2460
2461 .cindex '&"sticky"& bit'
2462 .cindex "lock files"
2463 One specific problem that has shown up on some sites is the inability to do
2464 local deliveries into a shared mailbox directory, because it does not have the
2465 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2466 writing to a mailbox file, and if it cannot create the lock file, the delivery
2467 is deferred. You can get round this either by setting the &"sticky bit"& on the
2468 directory, or by setting a specific group for local deliveries and allowing
2469 that group to create files in the directory (see the comments above the
2470 &(local_delivery)& transport in the default configuration file). Another
2471 approach is to configure Exim not to use lock files, but just to rely on
2472 &[fcntl()]& locking instead. However, you should do this only if all user
2473 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2474 see chapter &<<CHAPappendfile>>&.
2475
2476 One thing that cannot be tested on a system that is already running an MTA is
2477 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2478 &%-oX%& option can be used to run an Exim daemon that listens on some other
2479 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2480 &'exim_checkaccess'& utility can be used to check out policy controls on
2481 incoming SMTP mail.
2482
2483 Testing a new version on a system that is already running Exim can most easily
2484 be done by building a binary with a different CONFIGURE_FILE setting. From
2485 within the runtime configuration, all other file and directory names
2486 that Exim uses can be altered, in order to keep it entirely clear of the
2487 production version.
2488
2489
2490 .section "Replacing another MTA with Exim" "SECID35"
2491 .cindex "replacing another MTA"
2492 Building and installing Exim for the first time does not of itself put it in
2493 general use. The name by which the system's MTA is called by mail user agents
2494 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2495 operating system), and it is necessary to make this name point to the &'exim'&
2496 binary in order to get the user agents to pass messages to Exim. This is
2497 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2498 or &_/usr/lib/sendmail_&
2499 .cindex "symbolic link" "to &'exim'& binary"
2500 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2501 privilege and executable status from the old MTA. It is then necessary to stop
2502 and restart the mailer daemon, if one is running.
2503
2504 .cindex "FreeBSD, MTA indirection"
2505 .cindex "&_/etc/mail/mailer.conf_&"
2506 Some operating systems have introduced alternative ways of switching MTAs. For
2507 example, if you are running FreeBSD, you need to edit the file
2508 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2509 described. A typical example of the contents of this file for running Exim is
2510 as follows:
2511 .code
2512 sendmail            /usr/exim/bin/exim
2513 send-mail           /usr/exim/bin/exim
2514 mailq               /usr/exim/bin/exim -bp
2515 newaliases          /usr/bin/true
2516 .endd
2517 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2518 your Exim installation is &"live"&. Check it by sending a message from your
2519 favourite user agent.
2520
2521 You should consider what to tell your users about the change of MTA. Exim may
2522 have different capabilities to what was previously running, and there are
2523 various operational differences such as the text of messages produced by
2524 command line options and in bounce messages. If you allow your users to make
2525 use of Exim's filtering capabilities, you should make the document entitled
2526 &'Exim's interface to mail filtering'& available to them.
2527
2528
2529
2530 .section "Upgrading Exim" "SECID36"
2531 .cindex "upgrading Exim"
2532 If you are already running Exim on your host, building and installing a new
2533 version automatically makes it available to MUAs, or any other programs that
2534 call the MTA directly. However, if you are running an Exim daemon, you do need
2535 .cindex restart "on HUP signal"
2536 .cindex signal "HUP, to restart"
2537 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2538 new binary. You do not need to stop processing mail in order to install a new
2539 version of Exim. The install script does not modify an existing runtime
2540 configuration file.
2541
2542
2543
2544
2545 .section "Stopping the Exim daemon on Solaris" "SECID37"
2546 .cindex "Solaris" "stopping Exim on"
2547 The standard command for stopping the mailer daemon on Solaris is
2548 .code
2549 /etc/init.d/sendmail stop
2550 .endd
2551 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2552 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2553 for the text &"sendmail"&; this is not present because the actual program name
2554 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2555 solution is to replace the line that finds the process id with something like
2556 .code
2557 pid=`cat /var/spool/exim/exim-daemon.pid`
2558 .endd
2559 to obtain the daemon's pid directly from the file that Exim saves it in.
2560
2561 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2562 still be received from local processes, and if automatic delivery is configured
2563 (the normal case), deliveries will still occur.
2564
2565
2566
2567
2568 . ////////////////////////////////////////////////////////////////////////////
2569 . ////////////////////////////////////////////////////////////////////////////
2570
2571 .chapter "The Exim command line" "CHAPcommandline"
2572 .scindex IIDclo1 "command line" "options"
2573 .scindex IIDclo2 "options" "command line"
2574 Exim's command line takes the standard Unix form of a sequence of options,
2575 each starting with a hyphen character, followed by a number of arguments. The
2576 options are compatible with the main options of Sendmail, and there are also
2577 some additional options, some of which are compatible with Smail 3. Certain
2578 combinations of options do not make sense, and provoke an error if used.
2579 The form of the arguments depends on which options are set.
2580
2581
2582 .section "Setting options by program name" "SECID38"
2583 .cindex "&'mailq'&"
2584 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2585 were present before any other options.
2586 The &%-bp%& option requests a listing of the contents of the mail queue on the
2587 standard output.
2588 This feature is for compatibility with some systems that contain a command of
2589 that name in one of the standard libraries, symbolically linked to
2590 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2591
2592 .cindex "&'rsmtp'&"
2593 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2594 were present before any other options, for compatibility with Smail. The
2595 &%-bS%& option is used for reading in a number of messages in batched SMTP
2596 format.
2597
2598 .cindex "&'rmail'&"
2599 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2600 &%-oee%& options were present before any other options, for compatibility with
2601 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2602
2603 .cindex "&'runq'&"
2604 .cindex "queue runner"
2605 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2606 were present before any other options, for compatibility with Smail. The &%-q%&
2607 option causes a single queue runner process to be started.
2608
2609 .cindex "&'newaliases'&"
2610 .cindex "alias file" "building"
2611 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2612 If Exim is called under the name &'newaliases'& it behaves as if the option
2613 &%-bi%& were present before any other options, for compatibility with Sendmail.
2614 This option is used for rebuilding Sendmail's alias file. Exim does not have
2615 the concept of a single alias file, but can be configured to run a given
2616 command if called with the &%-bi%& option.
2617
2618
2619 .section "Trusted and admin users" "SECTtrustedadmin"
2620 Some Exim options are available only to &'trusted users'& and others are
2621 available only to &'admin users'&. In the description below, the phrases &"Exim
2622 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2623 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2624 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2625
2626 .ilist
2627 .cindex "trusted users" "definition of"
2628 .cindex "user" "trusted definition of"
2629 The trusted users are root, the Exim user, any user listed in the
2630 &%trusted_users%& configuration option, and any user whose current group or any
2631 supplementary group is one of those listed in the &%trusted_groups%&
2632 configuration option. Note that the Exim group is not automatically trusted.
2633
2634 .cindex '&"From"& line'
2635 .cindex "envelope from"
2636 .cindex "envelope sender"
2637 Trusted users are always permitted to use the &%-f%& option or a leading
2638 &"From&~"& line to specify the envelope sender of a message that is passed to
2639 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2640 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2641 users to set envelope senders.
2642
2643 .cindex "&'From:'& header line"
2644 .cindex "&'Sender:'& header line"
2645 .cindex "header lines" "From:"
2646 .cindex "header lines" "Sender:"
2647 For a trusted user, there is never any check on the contents of the &'From:'&
2648 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2649 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2650
2651 Trusted users may also specify a host name, host address, interface address,
2652 protocol name, ident value, and authentication data when submitting a message
2653 locally. Thus, they are able to insert messages into Exim's queue locally that
2654 have the characteristics of messages received from a remote host. Untrusted
2655 users may in some circumstances use &%-f%&, but can never set the other values
2656 that are available to trusted users.
2657 .next
2658 .cindex "user" "admin definition of"
2659 .cindex "admin user" "definition of"
2660 The admin users are root, the Exim user, and any user that is a member of the
2661 Exim group or of any group listed in the &%admin_groups%& configuration option.
2662 The current group does not have to be one of these groups.
2663
2664 Admin users are permitted to list the queue, and to carry out certain
2665 operations on messages, for example, to force delivery failures. It is also
2666 necessary to be an admin user in order to see the full information provided by
2667 the Exim monitor, and full debugging output.
2668
2669 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2670 Exim to attempt delivery of messages on its queue is restricted to admin users.
2671 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2672 option false (that is, specifying &%no_prod_requires_admin%&).
2673
2674 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2675 is restricted to admin users unless &%queue_list_requires_admin%& is set
2676 false.
2677 .endlist
2678
2679
2680 &*Warning*&: If you configure your system so that admin users are able to
2681 edit Exim's configuration file, you are giving those users an easy way of
2682 getting root. There is further discussion of this issue at the start of chapter
2683 &<<CHAPconf>>&.
2684
2685
2686
2687
2688 .section "Command line options" "SECID39"
2689 Exim's command line options are described in alphabetical order below. If none
2690 of the options that specifies a specific action (such as starting the daemon or
2691 a queue runner, or testing an address, or receiving a message in a specific
2692 format, or listing the queue) are present, and there is at least one argument
2693 on the command line, &%-bm%& (accept a local message on the standard input,
2694 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2695 outputs a brief message about itself and exits.
2696
2697 . ////////////////////////////////////////////////////////////////////////////
2698 . Insert a stylized XML comment here, to identify the start of the command line
2699 . options. This is for the benefit of the Perl script that automatically
2700 . creates a man page for the options.
2701 . ////////////////////////////////////////////////////////////////////////////
2702
2703 .literal xml
2704 <!-- === Start of command line options === -->
2705 .literal off
2706
2707
2708 .vlist
2709 .vitem &%--%&
2710 .oindex "--"
2711 .cindex "options" "command line; terminating"
2712 This is a pseudo-option whose only purpose is to terminate the options and
2713 therefore to cause subsequent command line items to be treated as arguments
2714 rather than options, even if they begin with hyphens.
2715
2716 .vitem &%--help%&
2717 .oindex "&%--help%&"
2718 This option causes Exim to output a few sentences stating what it is.
2719 The same output is generated if the Exim binary is called with no options and
2720 no arguments.
2721
2722 .vitem &%--version%&
2723 .oindex "&%--version%&"
2724 This option is an alias for &%-bV%& and causes version information to be
2725 displayed.
2726
2727 .vitem &%-Ac%& &&&
2728        &%-Am%&
2729 .oindex "&%-Ac%&"
2730 .oindex "&%-Am%&"
2731 These options are used by Sendmail for selecting configuration files and are
2732 ignored by Exim.
2733
2734 .vitem &%-B%&<&'type'&>
2735 .oindex "&%-B%&"
2736 .cindex "8-bit characters"
2737 .cindex "Sendmail compatibility" "8-bit characters"
2738 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2739 clean; it ignores this option.
2740
2741 .vitem &%-bd%&
2742 .oindex "&%-bd%&"
2743 .cindex "daemon"
2744 .cindex "SMTP" "listener"
2745 .cindex "queue runner"
2746 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2747 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2748 that the daemon should also initiate periodic queue runs.
2749
2750 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2751 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2752 disconnect from the controlling terminal. When running this way, it can be
2753 stopped by pressing ctrl-C.
2754
2755 By default, Exim listens for incoming connections to the standard SMTP port on
2756 all the host's running interfaces. However, it is possible to listen on other
2757 ports, on multiple ports, and only on specific interfaces. Chapter
2758 &<<CHAPinterfaces>>& contains a description of the options that control this.
2759
2760 When a listening daemon
2761 .cindex "daemon" "process id (pid)"
2762 .cindex "pid (process id)" "of daemon"
2763 is started without the use of &%-oX%& (that is, without overriding the normal
2764 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2765 in Exim's spool directory. This location can be overridden by setting
2766 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2767 running as root.
2768
2769 When &%-oX%& is used on the command line to start a listening daemon, the
2770 process id is not written to the normal pid file path. However, &%-oP%& can be
2771 used to specify a path on the command line if a pid file is required.
2772
2773 The SIGHUP signal
2774 .cindex "SIGHUP"
2775 .cindex restart "on HUP signal"
2776 .cindex signal "HUP, to restart"
2777 .cindex "daemon" "restarting"
2778 .cindex signal "to reload configuration"
2779 .cindex daemon "reload configuration"
2780 .cindex reload configuration
2781 can be used to cause the daemon to re-execute itself. This should be done
2782 whenever Exim's configuration file, or any file that is incorporated into it by
2783 means of the &%.include%& facility, is changed, and also whenever a new version
2784 of Exim is installed. It is not necessary to do this when other files that are
2785 referenced from the configuration (for example, alias files) are changed,
2786 because these are reread each time they are used.
2787
2788 .vitem &%-bdf%&
2789 .oindex "&%-bdf%&"
2790 This option has the same effect as &%-bd%& except that it never disconnects
2791 from the controlling terminal, even when no debugging is specified.
2792
2793 .vitem &%-be%&
2794 .oindex "&%-be%&"
2795 .cindex "testing" "string expansion"
2796 .cindex "expansion" "testing"
2797 Run Exim in expansion testing mode. Exim discards its root privilege, to
2798 prevent ordinary users from using this mode to read otherwise inaccessible
2799 files. If no arguments are given, Exim runs interactively, prompting for lines
2800 of data. Otherwise, it processes each argument in turn.
2801
2802 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2803 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2804 used without command line arguments. If successful, it uses the &[readline()]&
2805 function, which provides extensive line-editing facilities, for reading the
2806 test data. A line history is supported.
2807
2808 Long expansion expressions can be split over several lines by using backslash
2809 continuations. As in Exim's runtime configuration, white space at the start of
2810 continuation lines is ignored. Each argument or data line is passed through the
2811 string expansion mechanism, and the result is output. Variable values from the
2812 configuration file (for example, &$qualify_domain$&) are available, but no
2813 message-specific values (such as &$message_exim_id$&) are set, because no message
2814 is being processed (but see &%-bem%& and &%-Mset%&).
2815
2816 &*Note*&: If you use this mechanism to test lookups, and you change the data
2817 files or databases you are using, you must exit and restart Exim before trying
2818 the same lookup again. Otherwise, because each Exim process caches the results
2819 of lookups, you will just get the same result as before.
2820
2821 Macro processing is done on lines before string-expansion: new macros can be
2822 defined and macros will be expanded.
2823 Because macros in the config file are often used for secrets, those are only
2824 available to admin users.
2825
2826 .vitem &%-bem%&&~<&'filename'&>
2827 .oindex "&%-bem%&"
2828 .cindex "testing" "string expansion"
2829 .cindex "expansion" "testing"
2830 This option operates like &%-be%& except that it must be followed by the name
2831 of a file. For example:
2832 .code
2833 exim -bem /tmp/testmessage
2834 .endd
2835 The file is read as a message (as if receiving a locally-submitted non-SMTP
2836 message) before any of the test expansions are done. Thus, message-specific
2837 variables such as &$message_size$& and &$header_from:$& are available. However,
2838 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2839 recipients are read from the headers in the normal way, and are shown in the
2840 &$recipients$& variable. Note that recipients cannot be given on the command
2841 line, because further arguments are taken as strings to expand (just like
2842 &%-be%&).
2843
2844 .vitem &%-bF%&&~<&'filename'&>
2845 .oindex "&%-bF%&"
2846 .cindex "system filter" "testing"
2847 .cindex "testing" "system filter"
2848 This option is the same as &%-bf%& except that it assumes that the filter being
2849 tested is a system filter. The additional commands that are available only in
2850 system filters are recognized.
2851
2852 .vitem &%-bf%&&~<&'filename'&>
2853 .oindex "&%-bf%&"
2854 .cindex "filter" "testing"
2855 .cindex "testing" "filter file"
2856 .cindex "forward file" "testing"
2857 .cindex "testing" "forward file"
2858 .cindex "Sieve filter" "testing"
2859 This option runs Exim in user filter testing mode; the file is the filter file
2860 to be tested, and a test message must be supplied on the standard input. If
2861 there are no message-dependent tests in the filter, an empty file can be
2862 supplied.
2863
2864 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2865 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2866 filter and a user filter in the same run. For example:
2867 .code
2868 exim -bF /system/filter -bf /user/filter </test/message
2869 .endd
2870 This is helpful when the system filter adds header lines or sets filter
2871 variables that are used by the user filter.
2872
2873 If the test filter file does not begin with one of the special lines
2874 .code
2875 # Exim filter
2876 # Sieve filter
2877 .endd
2878 it is taken to be a normal &_.forward_& file, and is tested for validity under
2879 that interpretation. See sections &<<SECTitenonfilred>>& to
2880 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2881 redirection lists.
2882
2883 The result of an Exim command that uses &%-bf%&, provided no errors are
2884 detected, is a list of the actions that Exim would try to take if presented
2885 with the message for real. More details of filter testing are given in the
2886 separate document entitled &'Exim's interfaces to mail filtering'&.
2887
2888 When testing a filter file,
2889 .cindex "&""From""& line"
2890 .cindex "envelope from"
2891 .cindex "envelope sender"
2892 .oindex "&%-f%&" "for filter testing"
2893 the envelope sender can be set by the &%-f%& option,
2894 or by a &"From&~"& line at the start of the test message. Various parameters
2895 that would normally be taken from the envelope recipient address of the message
2896 can be set by means of additional command line options (see the next four
2897 options).
2898
2899 .vitem &%-bfd%&&~<&'domain'&>
2900 .oindex "&%-bfd%&"
2901 .vindex "&$qualify_domain$&"
2902 This sets the domain of the recipient address when a filter file is being
2903 tested by means of the &%-bf%& option. The default is the value of
2904 &$qualify_domain$&.
2905
2906 .vitem &%-bfl%&&~<&'local&~part'&>
2907 .oindex "&%-bfl%&"
2908 This sets the local part of the recipient address when a filter file is being
2909 tested by means of the &%-bf%& option. The default is the username of the
2910 process that calls Exim. A local part should be specified with any prefix or
2911 suffix stripped, because that is how it appears to the filter when a message is
2912 actually being delivered.
2913
2914 .vitem &%-bfp%&&~<&'prefix'&>
2915 .oindex "&%-bfp%&"
2916 .cindex affix "filter testing"
2917 This sets the prefix of the local part of the recipient address when a filter
2918 file is being tested by means of the &%-bf%& option. The default is an empty
2919 prefix.
2920
2921 .vitem &%-bfs%&&~<&'suffix'&>
2922 .oindex "&%-bfs%&"
2923 .cindex affix "filter testing"
2924 This sets the suffix of the local part of the recipient address when a filter
2925 file is being tested by means of the &%-bf%& option. The default is an empty
2926 suffix.
2927
2928 .vitem &%-bh%&&~<&'IP&~address'&>
2929 .oindex "&%-bh%&"
2930 .cindex "testing" "incoming SMTP"
2931 .cindex "SMTP" "testing incoming"
2932 .cindex "testing" "relay control"
2933 .cindex "relaying" "testing configuration"
2934 .cindex "policy control" "testing"
2935 .cindex "debugging" "&%-bh%& option"
2936 This option runs a fake SMTP session as if from the given IP address, using the
2937 standard input and output. The IP address may include a port number at the end,
2938 after a full stop. For example:
2939 .code
2940 exim -bh 10.9.8.7.1234
2941 exim -bh fe80::a00:20ff:fe86:a061.5678
2942 .endd
2943 When an IPv6 address is given, it is converted into canonical form. In the case
2944 of the second example above, the value of &$sender_host_address$& after
2945 conversion to the canonical form is
2946 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2947
2948 Comments as to what is going on are written to the standard error file. These
2949 include lines beginning with &"LOG"& for anything that would have been logged.
2950 This facility is provided for testing configuration options for incoming
2951 messages, to make sure they implement the required policy. For example, you can
2952 test your relay controls using &%-bh%&.
2953
2954 &*Warning 1*&:
2955 .cindex "RFC 1413"
2956 You can test features of the configuration that rely on ident (RFC 1413)
2957 information by using the &%-oMt%& option. However, Exim cannot actually perform
2958 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2959 connection.
2960
2961 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2962 are also skipped when testing using &%-bh%&. If you want these callouts to
2963 occur, use &%-bhc%& instead.
2964
2965 Messages supplied during the testing session are discarded, and nothing is
2966 written to any of the real log files. There may be pauses when DNS (and other)
2967 lookups are taking place, and of course these may time out. The &%-oMi%& option
2968 can be used to specify a specific IP interface and port if this is important,
2969 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2970 session were authenticated.
2971
2972 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2973 output just states whether a given recipient address from a given host is
2974 acceptable or not. See section &<<SECTcheckaccess>>&.
2975
2976 Features such as authentication and encryption, where the client input is not
2977 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2978 specialized SMTP test program such as
2979 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2980
2981 .vitem &%-bhc%&&~<&'IP&~address'&>
2982 .oindex "&%-bhc%&"
2983 This option operates in the same way as &%-bh%&, except that address
2984 verification callouts are performed if required. This includes consulting and
2985 updating the callout cache database.
2986
2987 .vitem &%-bi%&
2988 .oindex "&%-bi%&"
2989 .cindex "alias file" "building"
2990 .cindex "building alias file"
2991 .cindex "Sendmail compatibility" "&%-bi%& option"
2992 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2993 Exim does not have the concept of a single alias file, and so it cannot mimic
2994 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2995 tend to appear in various scripts such as NIS make files, so the option must be
2996 recognized.
2997
2998 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2999 configuration option is run, under the uid and gid of the caller of Exim. If
3000 the &%-oA%& option is used, its value is passed to the command as an argument.
3001 The command set by &%bi_command%& may not contain arguments. The command can
3002 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3003 if this is required. If the &%bi_command%& option is not set, calling Exim with
3004 &%-bi%& is a no-op.
3005
3006 . // Keep :help first, then the rest in alphabetical order
3007 .vitem &%-bI:help%&
3008 .oindex "&%-bI:help%&"
3009 .cindex "querying exim information"
3010 We shall provide various options starting &`-bI:`& for querying Exim for
3011 information.  The output of many of these will be intended for machine
3012 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3013 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3014 options shall cause Exim to exit after producing the requested output.
3015
3016 .vitem &%-bI:dscp%&
3017 .oindex "&%-bI:dscp%&"
3018 .cindex "DSCP" "values"
3019 This option causes Exim to emit an alphabetically sorted list of all
3020 recognised DSCP names.
3021
3022 .vitem &%-bI:sieve%&
3023 .oindex "&%-bI:sieve%&"
3024 .cindex "Sieve filter" "capabilities"
3025 This option causes Exim to emit an alphabetically sorted list of all supported
3026 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3027 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3028 &`SIEVE`& capability response line.  As the precise list may depend upon
3029 compile-time build options, which this option will adapt to, this is the only
3030 way to guarantee a correct response.
3031
3032 .vitem &%-bm%&
3033 .oindex "&%-bm%&"
3034 .cindex "local message reception"
3035 This option runs an Exim receiving process that accepts an incoming,
3036 locally-generated message on the standard input. The recipients are given as the
3037 command arguments (except when &%-t%& is also present &-- see below). Each
3038 argument can be a comma-separated list of RFC 2822 addresses. This is the
3039 default option for selecting the overall action of an Exim call; it is assumed
3040 if no other conflicting option is present.
3041
3042 If any addresses in the message are unqualified (have no domain), they are
3043 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3044 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3045 suppressing this for special cases.
3046
3047 Policy checks on the contents of local messages can be enforced by means of
3048 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3049
3050 .cindex "return code" "for &%-bm%&"
3051 The return code is zero if the message is successfully accepted. Otherwise, the
3052 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3053
3054 The format
3055 .cindex "message" "format"
3056 .cindex "format" "message"
3057 .cindex "&""From""& line"
3058 .cindex "UUCP" "&""From""& line"
3059 .cindex "Sendmail compatibility" "&""From""& line"
3060 of the message must be as defined in RFC 2822, except that, for
3061 compatibility with Sendmail and Smail, a line in one of the forms
3062 .code
3063 From sender Fri Jan  5 12:55 GMT 1997
3064 From sender Fri, 5 Jan 97 12:55:01
3065 .endd
3066 (with the weekday optional, and possibly with additional text after the date)
3067 is permitted to appear at the start of the message. There appears to be no
3068 authoritative specification of the format of this line. Exim recognizes it by
3069 matching against the regular expression defined by the &%uucp_from_pattern%&
3070 option, which can be changed if necessary.
3071
3072 .oindex "&%-f%&" "overriding &""From""& line"
3073 The specified sender is treated as if it were given as the argument to the
3074 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3075 preference to the address taken from the message. The caller of Exim must be a
3076 trusted user for the sender of a message to be set in this way.
3077
3078 .vitem &%-bmalware%&&~<&'filename'&>
3079 .oindex "&%-bmalware%&"
3080 .cindex "testing", "malware"
3081 .cindex "malware scan test"
3082 This debugging option causes Exim to scan the given file or directory
3083 (depending on the used scanner interface),
3084 using the malware scanning framework.  The option of &%av_scanner%& influences
3085 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3086 the expansion should have defaults which apply to this invocation.  ACLs are
3087 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3088 will never be populated and &%-bmalware%& will fail.
3089
3090 Exim will have changed working directory before resolving the filename, so
3091 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3092 user when it tries to open the file, rather than as the invoking user.
3093 This option requires admin privileges.
3094
3095 The &%-bmalware%& option will not be extended to be more generally useful,
3096 there are better tools for file-scanning.  This option exists to help
3097 administrators verify their Exim and AV scanner configuration.
3098
3099 .vitem &%-bnq%&
3100 .oindex "&%-bnq%&"
3101 .cindex "address qualification, suppressing"
3102 By default, Exim automatically qualifies unqualified addresses (those
3103 without domains) that appear in messages that are submitted locally (that
3104 is, not over TCP/IP). This qualification applies both to addresses in
3105 envelopes, and addresses in header lines. Sender addresses are qualified using
3106 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3107 defaults to the value of &%qualify_domain%&).
3108
3109 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3110 being used to re-submit messages that originally came from remote hosts after
3111 content scanning, you probably do not want to qualify unqualified addresses in
3112 header lines. (Such lines will be present only if you have not enabled a header
3113 syntax check in the appropriate ACL.)
3114
3115 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3116 messages that originate on the local host. When this is used, unqualified
3117 addresses in the envelope provoke errors (causing message rejection) and
3118 unqualified addresses in header lines are left alone.
3119
3120
3121 .vitem &%-bP%&
3122 .oindex "&%-bP%&"
3123 .cindex "configuration options" "extracting"
3124 .cindex "options" "configuration &-- extracting"
3125 If this option is given with no arguments, it causes the values of all Exim's
3126 main configuration options to be written to the standard output. The values
3127 of one or more specific options can be requested by giving their names as
3128 arguments, for example:
3129 .code
3130 exim -bP qualify_domain hold_domains
3131 .endd
3132 .cindex "hiding configuration option values"
3133 .cindex "configuration options" "hiding value of"
3134 .cindex "options" "hiding value of"
3135 However, any option setting that is preceded by the word &"hide"& in the
3136 configuration file is not shown in full, except to an admin user. For other
3137 users, the output is as in this example:
3138 .code
3139 mysql_servers = <value not displayable>
3140 .endd
3141 If &%config%& is given as an argument, the config is
3142 output, as it was parsed, any include file resolved, any comment removed.
3143
3144 If &%config_file%& is given as an argument, the name of the runtime
3145 configuration file is output. (&%configure_file%& works too, for
3146 backward compatibility.)
3147 If a list of configuration files was supplied, the value that is output here
3148 is the name of the file that was actually used.
3149
3150 .cindex "options" "hiding name of"
3151 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3152 name will not be output.
3153
3154 .cindex "daemon" "process id (pid)"
3155 .cindex "pid (process id)" "of daemon"
3156 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3157 directories where log files and daemon pid files are written are output,
3158 respectively. If these values are unset, log files are written in a
3159 sub-directory of the spool directory called &%log%&, and the pid file is
3160 written directly into the spool directory.
3161
3162 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3163 .code
3164 exim -bP +local_domains
3165 .endd
3166 it searches for a matching named list of any type (domain, host, address, or
3167 local part) and outputs what it finds.
3168
3169 .cindex "options" "router &-- extracting"
3170 .cindex "options" "transport &-- extracting"
3171 .cindex "options" "authenticator &-- extracting"
3172 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3173 followed by the name of an appropriate driver instance, the option settings for
3174 that driver are output. For example:
3175 .code
3176 exim -bP transport local_delivery
3177 .endd
3178 The generic driver options are output first, followed by the driver's private
3179 options. A list of the names of drivers of a particular type can be obtained by
3180 using one of the words &%router_list%&, &%transport_list%&, or
3181 &%authenticator_list%&, and a complete list of all drivers with their option
3182 settings can be obtained by using &%routers%&, &%transports%&, or
3183 &%authenticators%&.
3184
3185 .cindex "environment"
3186 If &%environment%& is given as an argument, the set of environment
3187 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3188 variables.
3189
3190 .cindex "options" "macro &-- extracting"
3191 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3192 are available, similarly to the drivers.  Because macros are sometimes used
3193 for storing passwords, this option is restricted.
3194 The output format is one item per line.
3195 For the "-bP macro <name>" form, if no such macro is found
3196 the exit status will be nonzero.
3197
3198 .vitem &%-bp%&
3199 .oindex "&%-bp%&"
3200 .cindex "queue" "listing messages in"
3201 .cindex "listing" "messages in the queue"
3202 This option requests a listing of the contents of the mail queue on the
3203 standard output. If the &%-bp%& option is followed by a list of message ids,
3204 just those messages are listed. By default, this option can be used only by an
3205 admin user. However, the &%queue_list_requires_admin%& option can be set false
3206 to allow any user to see the queue.
3207
3208 Each message in the queue is displayed as in the following example:
3209 .code
3210 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3211           red.king@looking-glass.fict.example
3212           <other addresses>
3213 .endd
3214 .cindex "message" "size in queue listing"
3215 .cindex "size" "of message"
3216 The first line contains the length of time the message has been in the queue
3217 (in this case 25 minutes), the size of the message (2.9K), the unique local
3218 identifier for the message, and the message sender, as contained in the
3219 envelope. For bounce messages, the sender address is empty, and appears as
3220 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3221 the default sender address, the user's login name is shown in parentheses
3222 before the sender address.
3223
3224 .cindex "frozen messages" "in queue listing"
3225 If the message is frozen (attempts to deliver it are suspended) then the text
3226 &"*** frozen ***"& is displayed at the end of this line.
3227
3228 The recipients of the message (taken from the envelope, not the headers) are
3229 displayed on subsequent lines. Those addresses to which the message has already
3230 been delivered are marked with the letter D. If an original address gets
3231 expanded into several addresses via an alias or forward file, the original is
3232 displayed with a D only when deliveries for all of its child addresses are
3233 complete.
3234
3235
3236 .vitem &%-bpa%&
3237 .oindex "&%-bpa%&"
3238 This option operates like &%-bp%&, but in addition it shows delivered addresses
3239 that were generated from the original top level address(es) in each message by
3240 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3241 of just &"D"&.
3242
3243
3244 .vitem &%-bpc%&
3245 .oindex "&%-bpc%&"
3246 .cindex "queue" "count of messages on"
3247 This option counts the number of messages in the queue, and writes the total
3248 to the standard output. It is restricted to admin users, unless
3249 &%queue_list_requires_admin%& is set false.
3250
3251
3252 .vitem &%-bpr%&
3253 .oindex "&%-bpr%&"
3254 This option operates like &%-bp%&, but the output is not sorted into
3255 chronological order of message arrival. This can speed it up when there are
3256 lots of messages in the queue, and is particularly useful if the output is
3257 going to be post-processed in a way that doesn't need the sorting.
3258
3259 .vitem &%-bpra%&
3260 .oindex "&%-bpra%&"
3261 This option is a combination of &%-bpr%& and &%-bpa%&.
3262
3263 .vitem &%-bpru%&
3264 .oindex "&%-bpru%&"
3265 This option is a combination of &%-bpr%& and &%-bpu%&.
3266
3267
3268 .vitem &%-bpu%&
3269 .oindex "&%-bpu%&"
3270 This option operates like &%-bp%& but shows only undelivered top-level
3271 addresses for each message displayed. Addresses generated by aliasing or
3272 forwarding are not shown, unless the message was deferred after processing by a
3273 router with the &%one_time%& option set.
3274
3275
3276 .vitem &%-brt%&
3277 .oindex "&%-brt%&"
3278 .cindex "testing" "retry configuration"
3279 .cindex "retry" "configuration testing"
3280 This option is for testing retry rules, and it must be followed by up to three
3281 arguments. It causes Exim to look for a retry rule that matches the values
3282 and to write it to the standard output. For example:
3283 .code
3284 exim -brt bach.comp.mus.example
3285 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3286 .endd
3287 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3288 argument, which is required, can be a complete address in the form
3289 &'local_part@domain'&, or it can be just a domain name. If the second argument
3290 contains a dot, it is interpreted as an optional second domain name; if no
3291 retry rule is found for the first argument, the second is tried. This ties in
3292 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3293 rule is found that matches the host, one that matches the mail domain is
3294 sought. Finally, an argument that is the name of a specific delivery error, as
3295 used in setting up retry rules, can be given. For example:
3296 .code
3297 exim -brt haydn.comp.mus.example quota_3d
3298 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3299 .endd
3300
3301 .vitem &%-brw%&
3302 .oindex "&%-brw%&"
3303 .cindex "testing" "rewriting"
3304 .cindex "rewriting" "testing"
3305 This option is for testing address rewriting rules, and it must be followed by
3306 a single argument, consisting of either a local part without a domain, or a
3307 complete address with a fully qualified domain. Exim outputs how this address
3308 would be rewritten for each possible place it might appear. See chapter
3309 &<<CHAPrewrite>>& for further details.
3310
3311 .vitem &%-bS%&
3312 .oindex "&%-bS%&"
3313 .cindex "SMTP" "batched incoming"
3314 .cindex "batched SMTP input"
3315 This option is used for batched SMTP input, which is an alternative interface
3316 for non-interactive local message submission. A number of messages can be
3317 submitted in a single run. However, despite its name, this is not really SMTP
3318 input. Exim reads each message's envelope from SMTP commands on the standard
3319 input, but generates no responses. If the caller is trusted, or
3320 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3321 believed; otherwise the sender is always the caller of Exim.
3322
3323 The message itself is read from the standard input, in SMTP format (leading
3324 dots doubled), terminated by a line containing just a single dot. An error is
3325 provoked if the terminating dot is missing. A further message may then follow.
3326
3327 As for other local message submissions, the contents of incoming batch SMTP
3328 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3329 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3330 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3331
3332 Some other SMTP commands are recognized in the input. HELO and EHLO act
3333 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3334 QUIT quits, ignoring the rest of the standard input.
3335
3336 .cindex "return code" "for &%-bS%&"
3337 If any error is encountered, reports are written to the standard output and
3338 error streams, and Exim gives up immediately. The return code is 0 if no error
3339 was detected; it is 1 if one or more messages were accepted before the error
3340 was detected; otherwise it is 2.
3341
3342 More details of input using batched SMTP are given in section
3343 &<<SECTincomingbatchedSMTP>>&.
3344
3345 .vitem &%-bs%&
3346 .oindex "&%-bs%&"
3347 .cindex "SMTP" "local input"
3348 .cindex "local SMTP input"
3349 This option causes Exim to accept one or more messages by reading SMTP commands
3350 on the standard input, and producing SMTP replies on the standard output. SMTP
3351 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3352 Some user agents use this interface as a way of passing locally-generated
3353 messages to the MTA.
3354
3355 In
3356 .cindex "sender" "source of"
3357 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3358 set, the senders of messages are taken from the SMTP MAIL commands.
3359 Otherwise the content of these commands is ignored and the sender is set up as
3360 the calling user. Unqualified addresses are automatically qualified using
3361 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3362 &%-bnq%& option is used.
3363
3364 .cindex "inetd"
3365 The
3366 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3367 using a listening daemon. Exim can distinguish the two cases by checking
3368 whether the standard input is a TCP/IP socket. When Exim is called from
3369 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3370 above concerning senders and qualification do not apply. In this situation,
3371 Exim behaves in exactly the same way as it does when receiving a message via
3372 the listening daemon.
3373
3374 .vitem &%-bt%&
3375 .oindex "&%-bt%&"
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .vitem &%-bV%&
3421 .oindex "&%-bV%&"
3422 .cindex "version number of Exim"
3423 This option causes Exim to write the current version number, compilation
3424 number, and compilation date of the &'exim'& binary to the standard output.
3425 It also lists the DBM library that is being used, the optional modules (such as
3426 specific lookup types), the drivers that are included in the binary, and the
3427 name of the runtime configuration file that is in use.
3428
3429 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3430 configuration file. However, this is a static check only. It cannot check
3431 values that are to be expanded. For example, although a misspelt ACL verb is
3432 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3433 alone to discover (for example) all the typos in the configuration; some
3434 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3435 dynamic testing facilities.
3436
3437 .vitem &%-bv%&
3438 .oindex "&%-bv%&"
3439 .cindex "verifying address" "using &%-bv%&"
3440 .cindex "address" "verification"
3441 This option runs Exim in address verification mode, in which each argument is
3442 taken as a recipient address to be verified by the routers. (This does
3443 not involve any verification callouts). During normal operation, verification
3444 happens mostly as a consequence processing a &%verify%& condition in an ACL
3445 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3446 including callouts, see the &%-bh%& and &%-bhc%& options.
3447
3448 If verification fails, and the caller is not an admin user, no details of the
3449 failure are output, because these might contain sensitive information such as
3450 usernames and passwords for database lookups.
3451
3452 If no arguments are given, Exim runs in an interactive manner, prompting with a
3453 right angle bracket for addresses to be verified.
3454
3455 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3456 &[readline()]& function, because it is running as &'exim'& and there are
3457 security issues.
3458
3459 Verification differs from address testing (the &%-bt%& option) in that routers
3460 that have &%no_verify%& set are skipped, and if the address is accepted by a
3461 router that has &%fail_verify%& set, verification fails. The address is
3462 verified as a recipient if &%-bv%& is used; to test verification for a sender
3463 address, &%-bvs%& should be used.
3464
3465 If the &%-v%& option is not set, the output consists of a single line for each
3466 address, stating whether it was verified or not, and giving a reason in the
3467 latter case. Without &%-v%&, generating more than one address by redirection
3468 causes verification to end successfully, without considering the generated
3469 addresses. However, if just one address is generated, processing continues,
3470 and the generated address must verify successfully for the overall verification
3471 to succeed.
3472
3473 When &%-v%& is set, more details are given of how the address has been handled,
3474 and in the case of address redirection, all the generated addresses are also
3475 considered. Verification may succeed for some and fail for others.
3476
3477 The
3478 .cindex "return code" "for &%-bv%&"
3479 return code is 2 if any address failed outright; it is 1 if no address
3480 failed outright but at least one could not be resolved for some reason. Return
3481 code 0 is given only when all addresses succeed.
3482
3483 If any of the routers in the configuration makes any tests on the sender
3484 address of a message, you should use the &%-f%& option to set an appropriate
3485 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3486 calling user at the default qualifying domain.
3487
3488 .vitem &%-bvs%&
3489 .oindex "&%-bvs%&"
3490 This option acts like &%-bv%&, but verifies the address as a sender rather
3491 than a recipient address. This affects any rewriting and qualification that
3492 might happen.
3493
3494 .vitem &%-bw%&
3495 .oindex "&%-bw%&"
3496 .cindex "daemon"
3497 .cindex "inetd"
3498 .cindex "inetd" "wait mode"
3499 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3500 similarly to the &%-bd%& option.  All port specifications on the command-line
3501 and in the configuration file are ignored.  Queue-running may not be specified.
3502
3503 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3504 listening for connections.  This permits the system to start up and have
3505 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3506 each port only when the first connection is received.
3507
3508 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3509 which the daemon will exit, which should cause inetd to listen once more.
3510
3511 .vitem &%-C%&&~<&'filelist'&>
3512 .oindex "&%-C%&"
3513 .cindex "configuration file" "alternate"
3514 .cindex "CONFIGURE_FILE"
3515 .cindex "alternate configuration file"
3516 This option causes Exim to find the runtime configuration file from the given
3517 list instead of from the list specified by the CONFIGURE_FILE
3518 compile-time setting. Usually, the list will consist of just a single filename,
3519 but it can be a colon-separated list of names. In this case, the first
3520 file that exists is used. Failure to open an existing file stops Exim from
3521 proceeding any further along the list, and an error is generated.
3522
3523 When this option is used by a caller other than root, and the list is different
3524 from the compiled-in list, Exim gives up its root privilege immediately, and
3525 runs with the real and effective uid and gid set to those of the caller.
3526 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3527 file contains a list of full pathnames, one per line, for configuration files
3528 which are trusted. Root privilege is retained for any configuration file so
3529 listed, as long as the caller is the Exim user (or the user specified in the
3530 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3531 not writeable by inappropriate users or groups.
3532
3533 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3534 configuration using &%-C%& right through message reception and delivery,
3535 even if the caller is root. The reception works, but by that time, Exim is
3536 running as the Exim user, so when it re-executes to regain privilege for the
3537 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3538 test reception and delivery using two separate commands (one to put a message
3539 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3540
3541 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3542 prefix string with which any file named in a &%-C%& command line option
3543 must start. In addition, the filename must not contain the sequence &`/../`&.
3544 However, if the value of the &%-C%& option is identical to the value of
3545 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3546 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3547 unset, any filename can be used with &%-C%&.
3548
3549 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3550 to a directory to which only root has access. This prevents someone who has
3551 broken into the Exim account from running a privileged Exim with an arbitrary
3552 configuration file.
3553
3554 The &%-C%& facility is useful for ensuring that configuration files are
3555 syntactically correct, but cannot be used for test deliveries, unless the
3556 caller is privileged, or unless it is an exotic configuration that does not
3557 require privilege. No check is made on the owner or group of the files
3558 specified by this option.
3559
3560
3561 .vitem &%-D%&<&'macro'&>=<&'value'&>
3562 .oindex "&%-D%&"
3563 .cindex "macro" "setting on command line"
3564 This option can be used to override macro definitions in the configuration file
3565 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3566 unprivileged caller, it causes Exim to give up its root privilege.
3567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3568 completely disabled, and its use causes an immediate error exit.
3569
3570 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3571 colon-separated list of macros which are considered safe and, if &%-D%& only
3572 supplies macros from this list, and the values are acceptable, then Exim will
3573 not give up root privilege if the caller is root, the Exim run-time user, or
3574 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3575 to be removed in the future.  Acceptable values for the macros satisfy the
3576 regexp: &`^[A-Za-z0-9_/.-]*$`&
3577
3578 The entire option (including equals sign if present) must all be within one
3579 command line item. &%-D%& can be used to set the value of a macro to the empty
3580 string, in which case the equals sign is optional. These two commands are
3581 synonymous:
3582 .code
3583 exim -DABC  ...
3584 exim -DABC= ...
3585 .endd
3586 To include spaces in a macro definition item, quotes must be used. If you use
3587 quotes, spaces are permitted around the macro name and the equals sign. For
3588 example:
3589 .code
3590 exim '-D ABC = something' ...
3591 .endd
3592 &%-D%& may be repeated up to 10 times on a command line.
3593 Only macro names up to 22 letters long can be set.
3594
3595
3596 .vitem &%-d%&<&'debug&~options'&>
3597 .oindex "&%-d%&"
3598 .cindex "debugging" "list of selectors"
3599 .cindex "debugging" "&%-d%& option"
3600 This option causes debugging information to be written to the standard
3601 error stream. It is restricted to admin users because debugging output may show
3602 database queries that contain password information. Also, the details of users'
3603 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3604 writes an error message to the standard error stream and exits with a non-zero
3605 return code.
3606
3607 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3608 standard debugging data is output. This can be reduced, or increased to include
3609 some more rarely needed information, by directly following &%-d%& with a string
3610 made up of names preceded by plus or minus characters. These add or remove sets
3611 of debugging data, respectively. For example, &%-d+filter%& adds filter
3612 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3613 no spaces are allowed in the debug setting. The available debugging categories
3614 are:
3615 .display
3616 &`acl            `& ACL interpretation
3617 &`auth           `& authenticators
3618 &`deliver        `& general delivery logic
3619 &`dns            `& DNS lookups (see also resolver)
3620 &`dnsbl          `& DNS black list (aka RBL) code
3621 &`exec           `& arguments for &[execv()]& calls
3622 &`expand         `& detailed debugging for string expansions
3623 &`filter         `& filter handling
3624 &`hints_lookup   `& hints data lookups
3625 &`host_lookup    `& all types of name-to-IP address handling
3626 &`ident          `& ident lookup
3627 &`interface      `& lists of local interfaces
3628 &`lists          `& matching things in lists
3629 &`load           `& system load checks
3630 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3631                     &<<CHAPlocalscan>>&)
3632 &`lookup         `& general lookup code and all lookups
3633 &`memory         `& memory handling
3634 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3635 &`pid            `& modifier: add pid to debug output lines
3636 &`process_info   `& setting info for the process log
3637 &`queue_run      `& queue runs
3638 &`receive        `& general message reception logic
3639 &`resolver       `& turn on the DNS resolver's debugging output
3640 &`retry          `& retry handling
3641 &`rewrite        `& address rewriting
3642 &`route          `& address routing
3643 &`timestamp      `& modifier: add timestamp to debug output lines
3644 &`tls            `& TLS logic
3645 &`transport      `& transports
3646 &`uid            `& changes of uid/gid and looking up uid/gid
3647 &`verify         `& address verification logic
3648 &`all            `& almost all of the above (see below), and also &%-v%&
3649 .endd
3650 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3651 for &`-all`&. The reason for this is that &`+all`& is something that people
3652 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3653 is included, an awful lot of output that is very rarely of interest is
3654 generated, so it now has to be explicitly requested. However, &`-all`& does
3655 turn everything off.
3656
3657 .cindex "resolver, debugging output"
3658 .cindex "DNS resolver, debugging output"
3659 The &`resolver`& option produces output only if the DNS resolver was compiled
3660 with DEBUG enabled. This is not the case in some operating systems. Also,
3661 unfortunately, debugging output from the DNS resolver is written to stdout
3662 rather than stderr.
3663
3664 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3665 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3666 However, the &`pid`& selector is forced when debugging is turned on for a
3667 daemon, which then passes it on to any re-executed Exims. Exim also
3668 automatically adds the pid to debug lines when several remote deliveries are
3669 run in parallel.
3670
3671 The &`timestamp`& selector causes the current time to be inserted at the start
3672 of all debug output lines. This can be useful when trying to track down delays
3673 in processing.
3674
3675 .cindex debugging "UTF-8 in"
3676 .cindex UTF-8 "in debug output"
3677 The &`noutf8`& selector disables the use of
3678 UTF-8 line-drawing characters to group related information.
3679 When disabled. ascii-art is used instead.
3680 Using the &`+all`& option does not set this modifier,
3681
3682 If the &%debug_print%& option is set in any driver, it produces output whenever
3683 any debugging is selected, or if &%-v%& is used.
3684
3685 .vitem &%-dd%&<&'debug&~options'&>
3686 .oindex "&%-dd%&"
3687 This option behaves exactly like &%-d%& except when used on a command that
3688 starts a daemon process. In that case, debugging is turned off for the
3689 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3690 behaviour of the daemon without creating as much output as full debugging does.
3691
3692 .vitem &%-dropcr%&
3693 .oindex "&%-dropcr%&"
3694 This is an obsolete option that is now a no-op. It used to affect the way Exim
3695 handled CR and LF characters in incoming messages. What happens now is
3696 described in section &<<SECTlineendings>>&.
3697
3698 .vitem &%-E%&
3699 .oindex "&%-E%&"
3700 .cindex "bounce message" "generating"
3701 This option specifies that an incoming message is a locally-generated delivery
3702 failure report. It is used internally by Exim when handling delivery failures
3703 and is not intended for external use. Its only effect is to stop Exim
3704 generating certain messages to the postmaster, as otherwise message cascades
3705 could occur in some situations. As part of the same option, a message id may
3706 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3707 new message contains the id, following &"R="&, as a cross-reference.
3708
3709 .vitem &%-e%&&'x'&
3710 .oindex "&%-e%&&'x'&"
3711 There are a number of Sendmail options starting with &%-oe%& which seem to be
3712 called by various programs without the leading &%o%& in the option. For
3713 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3714 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3715
3716 .vitem &%-F%&&~<&'string'&>
3717 .oindex "&%-F%&"
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .vitem &%-f%&&~<&'address'&>
3727 .oindex "&%-f%&"
3728 .cindex "sender" "address"
3729 .cindex "address" "sender"
3730 .cindex "trusted users"
3731 .cindex "envelope from"
3732 .cindex "envelope sender"
3733 .cindex "user" "trusted"
3734 This option sets the address of the envelope sender of a locally-generated
3735 message (also known as the return path). The option can normally be used only
3736 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3737 users to use it.
3738
3739 Processes running as root or the Exim user are always trusted. Other
3740 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3741 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3742 of a local message is set to the caller's login name at the default qualify
3743 domain.
3744
3745 There is one exception to the restriction on the use of &%-f%&: an empty sender
3746 can be specified by any user, trusted or not, to create a message that can
3747 never provoke a bounce. An empty sender can be specified either as an empty
3748 string, or as a pair of angle brackets with nothing between them, as in these
3749 examples of shell commands:
3750 .code
3751 exim -f '<>' user@domain
3752 exim -f "" user@domain
3753 .endd
3754 In addition, the use of &%-f%& is not restricted when testing a filter file
3755 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3756 &%-bv%& options.
3757
3758 Allowing untrusted users to change the sender address does not of itself make
3759 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3760 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3761 though this can be overridden by setting &%no_local_from_check%&.
3762
3763 White
3764 .cindex "&""From""& line"
3765 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3766 given as two arguments or one combined argument). The sender of a
3767 locally-generated message can also be set (when permitted) by an initial
3768 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3769 if &%-f%& is also present, it overrides &"From&~"&.
3770
3771 .vitem &%-G%&
3772 .oindex "&%-G%&"
3773 .cindex "submission fixups, suppressing (command-line)"
3774 This option is equivalent to an ACL applying:
3775 .code
3776 control = suppress_local_fixups
3777 .endd
3778 for every message received.  Note that Sendmail will complain about such
3779 bad formatting, where Exim silently just does not fix it up.  This may change
3780 in future.
3781
3782 As this affects audit information, the caller must be a trusted user to use
3783 this option.
3784
3785 .vitem &%-h%&&~<&'number'&>
3786 .oindex "&%-h%&"
3787 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3788 This option is accepted for compatibility with Sendmail, but has no effect. (In
3789 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3790 headers.)
3791
3792 .vitem &%-i%&
3793 .oindex "&%-i%&"
3794 .cindex "Solaris" "&'mail'& command"
3795 .cindex "dot" "in incoming non-SMTP message"
3796 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3797 line by itself should not terminate an incoming, non-SMTP message. I can find
3798 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3799 command in Solaris 2.4 uses it. See also &%-ti%&.
3800
3801 .vitem &%-L%&&~<&'tag'&>
3802 .oindex "&%-L%&"
3803 .cindex "syslog" "process name; set with flag"
3804 This option is equivalent to setting &%syslog_processname%& in the config
3805 file and setting &%log_file_path%& to &`syslog`&.
3806 Its use is restricted to administrators.  The configuration file has to be
3807 read and parsed, to determine access rights, before this is set and takes
3808 effect, so early configuration file errors will not honour this flag.
3809
3810 The tag should not be longer than 32 characters.
3811
3812 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3813 .oindex "&%-M%&"
3814 .cindex "forcing delivery"
3815 .cindex "delivery" "forcing attempt"
3816 .cindex "frozen messages" "forcing delivery"
3817 This option requests Exim to run a delivery attempt on each message in turn. If
3818 any of the messages are frozen, they are automatically thawed before the
3819 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3820 and &%hold_domains%& are ignored.
3821
3822 Retry
3823 .cindex "hints database" "overriding retry hints"
3824 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3825 the normal retry time has not yet been reached. This option requires the caller
3826 to be an admin user. However, there is an option called &%prod_requires_admin%&
3827 which can be set false to relax this restriction (and also the same requirement
3828 for the &%-q%&, &%-R%&, and &%-S%& options).
3829
3830 The deliveries happen synchronously, that is, the original Exim process does
3831 not terminate until all the delivery attempts have finished. No output is
3832 produced unless there is a serious error. If you want to see what is happening,
3833 use the &%-v%& option as well, or inspect Exim's main log.
3834
3835 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3836 .oindex "&%-Mar%&"
3837 .cindex "message" "adding recipients"
3838 .cindex "recipient" "adding"
3839 This option requests Exim to add the addresses to the list of recipients of the
3840 message (&"ar"& for &"add recipients"&). The first argument must be a message
3841 id, and the remaining ones must be email addresses. However, if the message is
3842 active (in the middle of a delivery attempt), it is not altered. This option
3843 can be used only by an admin user.
3844
3845 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3846         &~<&'message&~id'&>"
3847 .oindex "&%-MC%&"
3848 .cindex "SMTP" "passed connection"
3849 .cindex "SMTP" "multiple deliveries"
3850 .cindex "multiple SMTP deliveries"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim to invoke another instance of itself to deliver a waiting message using
3853 an existing SMTP connection, which is passed as the standard input. Details are
3854 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3855 must be root or the Exim user in order to use it.
3856
3857 .vitem &%-MCA%&
3858 .oindex "&%-MCA%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that the
3861 connection to the remote host has been authenticated.
3862
3863 .vitem &%-MCD%&
3864 .oindex "&%-MCD%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that the
3867 remote host supports the ESMTP &_DSN_& extension.
3868
3869 .vitem &%-MCG%&&~<&'queue&~name'&>
3870 .oindex "&%-MCG%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that an
3873 alternate queue is used, named by the following argument.
3874
3875 .vitem &%-MCK%&
3876 .oindex "&%-MCK%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option. It signifies that a
3879 remote host supports the ESMTP &_CHUNKING_& extension.
3880
3881 .vitem &%-MCP%&
3882 .oindex "&%-MCP%&"
3883 This option is not intended for use by external callers. It is used internally
3884 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3885 which Exim is connected supports pipelining.
3886
3887 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3888 .oindex "&%-MCQ%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option when the original delivery was
3891 started by a queue runner. It passes on the process id of the queue runner,
3892 together with the file descriptor number of an open pipe. Closure of the pipe
3893 signals the final completion of the sequence of processes that are passing
3894 messages through the same SMTP connection.
3895
3896 .vitem &%-MCS%&
3897 .oindex "&%-MCS%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3900 SMTP SIZE option should be used on messages delivered down the existing
3901 connection.
3902
3903 .vitem &%-MCT%&
3904 .oindex "&%-MCT%&"
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3907 host to which Exim is connected supports TLS encryption.
3908
3909 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3910 .oindex "&%-MCt%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 connection is being proxied by a parent process for handling TLS encryption.
3914 The arguments give the local address and port being proxied, and the TLS cipher.
3915
3916 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mc%&"
3918 .cindex "hints database" "not overridden by &%-Mc%&"
3919 .cindex "delivery" "manually started &-- not forced"
3920 This option requests Exim to run a delivery attempt on each message, in turn,
3921 but unlike the &%-M%& option, it does check for retry hints, and respects any
3922 that are found. This option is not very useful to external callers. It is
3923 provided mainly for internal use by Exim when it needs to re-invoke itself in
3924 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3925 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3926 respects retry times and other options such as &%hold_domains%& that are
3927 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3928 If you want to run a specific delivery as if in a queue run, you should use
3929 &%-q%& with a message id argument. A distinction between queue run deliveries
3930 and other deliveries is made in one or two places.
3931
3932 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3933 .oindex "&%-Mes%&"
3934 .cindex "message" "changing sender"
3935 .cindex "sender" "changing"
3936 This option requests Exim to change the sender address in the message to the
3937 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3938 &"edit sender"&). There must be exactly two arguments. The first argument must
3939 be a message id, and the second one an email address. However, if the message
3940 is active (in the middle of a delivery attempt), its status is not altered.
3941 This option can be used only by an admin user.
3942
3943 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mf%&"
3945 .cindex "freezing messages"
3946 .cindex "message" "manually freezing"
3947 This option requests Exim to mark each listed message as &"frozen"&. This
3948 prevents any delivery attempts taking place until the message is &"thawed"&,
3949 either manually or as a result of the &%auto_thaw%& configuration option.
3950 However, if any of the messages are active (in the middle of a delivery
3951 attempt), their status is not altered. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mg%&"
3956 .cindex "giving up on messages"
3957 .cindex "message" "abandoning delivery attempts"
3958 .cindex "delivery" "abandoning further attempts"
3959 This option requests Exim to give up trying to deliver the listed messages,
3960 including any that are frozen. However, if any of the messages are active,
3961 their status is not altered. For non-bounce messages, a delivery error message
3962 is sent to the sender, containing the text &"cancelled by administrator"&.
3963 Bounce messages are just discarded. This option can be used only by an admin
3964 user.
3965
3966 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3967 .oindex "&%-MG%&"
3968 .cindex queue named
3969 .cindex "named queues"
3970 .cindex "queue" "moving messages"
3971 This option requests that each listed message be moved from its current
3972 queue to the given named queue.
3973 The destination queue name argument is required, but can be an empty
3974 string to define the default queue.
3975 If the messages are not currently located in the default queue,
3976 a &%-qG<name>%& option will be required to define the source queue.
3977
3978 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3979 .oindex "&%-Mmad%&"
3980 .cindex "delivery" "cancelling all"
3981 This option requests Exim to mark all the recipient addresses in the messages
3982 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3983 message is active (in the middle of a delivery attempt), its status is not
3984 altered. This option can be used only by an admin user.
3985
3986 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3987 .oindex "&%-Mmd%&"
3988 .cindex "delivery" "cancelling by address"
3989 .cindex "recipient" "removing"
3990 .cindex "removing recipients"
3991 This option requests Exim to mark the given addresses as already delivered
3992 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3993 the remaining ones must be email addresses. These are matched to recipient
3994 addresses in the message in a case-sensitive manner. If the message is active
3995 (in the middle of a delivery attempt), its status is not altered. This option
3996 can be used only by an admin user.
3997
3998 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3999 .oindex "&%-Mrm%&"
4000 .cindex "removing messages"
4001 .cindex "abandoning mail"
4002 .cindex "message" "manually discarding"
4003 This option requests Exim to remove the given messages from the queue. No
4004 bounce messages are sent; each message is simply forgotten. However, if any of
4005 the messages are active, their status is not altered. This option can be used
4006 only by an admin user or by the user who originally caused the message to be
4007 placed in the queue.
4008
4009 . .new
4010 . .vitem &%-MS%&
4011 . .oindex "&%-MS%&"
4012 . .cindex REQUIRETLS
4013 . This option is used to request REQUIRETLS processing on the message.
4014 . It is used internally by Exim in conjunction with -E when generating
4015 . a bounce message.
4016 . .wen
4017
4018 .vitem &%-Mset%&&~<&'message&~id'&>
4019 .oindex "&%-Mset%&"
4020 .cindex "testing" "string expansion"
4021 .cindex "expansion" "testing"
4022 This option is useful only in conjunction with &%-be%& (that is, when testing
4023 string expansions). Exim loads the given message from its spool before doing
4024 the test expansions, thus setting message-specific variables such as
4025 &$message_size$& and the header variables. The &$recipients$& variable is made
4026 available. This feature is provided to make it easier to test expansions that
4027 make use of these variables. However, this option can be used only by an admin
4028 user. See also &%-bem%&.
4029
4030 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4031 .oindex "&%-Mt%&"
4032 .cindex "thawing messages"
4033 .cindex "unfreezing messages"
4034 .cindex "frozen messages" "thawing"
4035 .cindex "message" "thawing frozen"
4036 This option requests Exim to &"thaw"& any of the listed messages that are
4037 &"frozen"&, so that delivery attempts can resume. However, if any of the
4038 messages are active, their status is not altered. This option can be used only
4039 by an admin user.
4040
4041 .vitem &%-Mvb%&&~<&'message&~id'&>
4042 .oindex "&%-Mvb%&"
4043 .cindex "listing" "message body"
4044 .cindex "message" "listing body of"
4045 This option causes the contents of the message body (-D) spool file to be
4046 written to the standard output. This option can be used only by an admin user.
4047
4048 .vitem &%-Mvc%&&~<&'message&~id'&>
4049 .oindex "&%-Mvc%&"
4050 .cindex "message" "listing in RFC 2822 format"
4051 .cindex "listing" "message in RFC 2822 format"
4052 This option causes a copy of the complete message (header lines plus body) to
4053 be written to the standard output in RFC 2822 format. This option can be used
4054 only by an admin user.
4055
4056 .vitem &%-Mvh%&&~<&'message&~id'&>
4057 .oindex "&%-Mvh%&"
4058 .cindex "listing" "message headers"
4059 .cindex "header lines" "listing"
4060 .cindex "message" "listing header lines"
4061 This option causes the contents of the message headers (-H) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvl%&&~<&'message&~id'&>
4065 .oindex "&%-Mvl%&"
4066 .cindex "listing" "message log"
4067 .cindex "message" "listing message log"
4068 This option causes the contents of the message log spool file to be written to
4069 the standard output. This option can be used only by an admin user.
4070
4071 .vitem &%-m%&
4072 .oindex "&%-m%&"
4073 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4074 treats it that way too.
4075
4076 .vitem &%-N%&
4077 .oindex "&%-N%&"
4078 .cindex "debugging" "&%-N%& option"
4079 .cindex "debugging" "suppressing delivery"
4080 This is a debugging option that inhibits delivery of a message at the transport
4081 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4082 it just doesn't actually transport the message, but instead behaves as if it
4083 had successfully done so. However, it does not make any updates to the retry
4084 database, and the log entries for deliveries are flagged with &"*>"& rather
4085 than &"=>"&.
4086
4087 Because &%-N%& discards any message to which it applies, only root or the Exim
4088 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4089 words, an ordinary user can use it only when supplying an incoming message to
4090 which it will apply. Although transportation never fails when &%-N%& is set, an
4091 address may be deferred because of a configuration problem on a transport, or a
4092 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4093 the message, and applies to any subsequent delivery attempts that may happen
4094 for that message.
4095
4096 .vitem &%-n%&
4097 .oindex "&%-n%&"
4098 This option is interpreted by Sendmail to mean &"no aliasing"&.
4099 For normal modes of operation, it is ignored by Exim.
4100 When combined with &%-bP%& it makes the output more terse (suppresses
4101 option names, environment values and config pretty printing).
4102
4103 .vitem &%-O%&&~<&'data'&>
4104 .oindex "&%-O%&"
4105 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4106 Exim.
4107
4108 .vitem &%-oA%&&~<&'file&~name'&>
4109 .oindex "&%-oA%&"
4110 .cindex "Sendmail compatibility" "&%-oA%& option"
4111 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4112 alternative alias filename. Exim handles &%-bi%& differently; see the
4113 description above.
4114
4115 .vitem &%-oB%&&~<&'n'&>
4116 .oindex "&%-oB%&"
4117 .cindex "SMTP" "passed connection"
4118 .cindex "SMTP" "multiple deliveries"
4119 .cindex "multiple SMTP deliveries"
4120 This is a debugging option which limits the maximum number of messages that can
4121 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4122 transport. If <&'n'&> is omitted, the limit is set to 1.
4123
4124 .vitem &%-odb%&
4125 .oindex "&%-odb%&"
4126 .cindex "background delivery"
4127 .cindex "delivery" "in the background"
4128 This option applies to all modes in which Exim accepts incoming messages,
4129 including the listening daemon. It requests &"background"& delivery of such
4130 messages, which means that the accepting process automatically starts a
4131 delivery process for each message received, but does not wait for the delivery
4132 processes to finish.
4133
4134 When all the messages have been received, the reception process exits,
4135 leaving the delivery processes to finish in their own time. The standard output
4136 and error streams are closed at the start of each delivery process.
4137 This is the default action if none of the &%-od%& options are present.
4138
4139 If one of the queueing options in the configuration file
4140 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4141 overrides it if &%queue_only_override%& is set true, which is the default
4142 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4143
4144 .vitem &%-odf%&
4145 .oindex "&%-odf%&"
4146 .cindex "foreground delivery"
4147 .cindex "delivery" "in the foreground"
4148 This option requests &"foreground"& (synchronous) delivery when Exim has
4149 accepted a locally-generated message. (For the daemon it is exactly the same as
4150 &%-odb%&.) A delivery process is automatically started to deliver the message,
4151 and Exim waits for it to complete before proceeding.
4152
4153 The original Exim reception process does not finish until the delivery
4154 process for the final message has ended. The standard error stream is left open
4155 during deliveries.
4156
4157 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4158 false and one of the queueing options in the configuration file is in effect.
4159
4160 If there is a temporary delivery error during foreground delivery, the
4161 message is left in the queue for later delivery, and the original reception
4162 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4163 restricted configuration that never queues messages.
4164
4165
4166 .vitem &%-odi%&
4167 .oindex "&%-odi%&"
4168 This option is synonymous with &%-odf%&. It is provided for compatibility with
4169 Sendmail.
4170
4171 .vitem &%-odq%&
4172 .oindex "&%-odq%&"
4173 .cindex "non-immediate delivery"
4174 .cindex "delivery" "suppressing immediate"
4175 .cindex "queueing incoming messages"
4176 This option applies to all modes in which Exim accepts incoming messages,
4177 including the listening daemon. It specifies that the accepting process should
4178 not automatically start a delivery process for each message received. Messages
4179 are placed in the queue, and remain there until a subsequent queue runner
4180 process encounters them. There are several configuration options (such as
4181 &%queue_only%&) that can be used to queue incoming messages under certain
4182 conditions. This option overrides all of them and also &%-odqs%&. It always
4183 forces queueing.
4184
4185 .vitem &%-odqs%&
4186 .oindex "&%-odqs%&"
4187 .cindex "SMTP" "delaying delivery"
4188 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4189 However, like &%-odb%& and &%-odi%&, this option has no effect if
4190 &%queue_only_override%& is false and one of the queueing options in the
4191 configuration file is in effect.
4192
4193 When &%-odqs%& does operate, a delivery process is started for each incoming
4194 message, in the background by default, but in the foreground if &%-odi%& is
4195 also present. The recipient addresses are routed, and local deliveries are done
4196 in the normal way. However, if any SMTP deliveries are required, they are not
4197 done at this time, so the message remains in the queue until a subsequent queue
4198 runner process encounters it. Because routing was done, Exim knows which
4199 messages are waiting for which hosts, and so a number of messages for the same
4200 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4201 configuration option has the same effect for specific domains. See also the
4202 &%-qq%& option.
4203
4204 .vitem &%-oee%&
4205 .oindex "&%-oee%&"
4206 .cindex "error" "reporting"
4207 If an error is detected while a non-SMTP message is being received (for
4208 example, a malformed address), the error is reported to the sender in a mail
4209 message.
4210
4211 .cindex "return code" "for &%-oee%&"
4212 Provided
4213 this error message is successfully sent, the Exim receiving process
4214 exits with a return code of zero. If not, the return code is 2 if the problem
4215 is that the original message has no recipients, or 1 for any other error.
4216 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4217
4218 .vitem &%-oem%&
4219 .oindex "&%-oem%&"
4220 .cindex "error" "reporting"
4221 .cindex "return code" "for &%-oem%&"
4222 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4223 return code, whether or not the error message was successfully sent.
4224 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4225
4226 .vitem &%-oep%&
4227 .oindex "&%-oep%&"
4228 .cindex "error" "reporting"
4229 If an error is detected while a non-SMTP message is being received, the
4230 error is reported by writing a message to the standard error file (stderr).
4231 .cindex "return code" "for &%-oep%&"
4232 The return code is 1 for all errors.
4233
4234 .vitem &%-oeq%&
4235 .oindex "&%-oeq%&"
4236 .cindex "error" "reporting"
4237 This option is supported for compatibility with Sendmail, but has the same
4238 effect as &%-oep%&.
4239
4240 .vitem &%-oew%&
4241 .oindex "&%-oew%&"
4242 .cindex "error" "reporting"
4243 This option is supported for compatibility with Sendmail, but has the same
4244 effect as &%-oem%&.
4245
4246 .vitem &%-oi%&
4247 .oindex "&%-oi%&"
4248 .cindex "dot" "in incoming non-SMTP message"
4249 This option, which has the same effect as &%-i%&, specifies that a dot on a
4250 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4251 single dot does terminate, though Exim does no special processing for other
4252 lines that start with a dot. This option is set by default if Exim is called as
4253 &'rmail'&. See also &%-ti%&.
4254
4255 .vitem &%-oitrue%&
4256 .oindex "&%-oitrue%&"
4257 This option is treated as synonymous with &%-oi%&.
4258
4259 .vitem &%-oMa%&&~<&'host&~address'&>
4260 .oindex "&%-oMa%&"
4261 .cindex "sender" "host address, specifying for local message"
4262 A number of options starting with &%-oM%& can be used to set values associated
4263 with remote hosts on locally-submitted messages (that is, messages not received
4264 over TCP/IP). These options can be used by any caller in conjunction with the
4265 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4266 other circumstances, they are ignored unless the caller is trusted.
4267
4268 The &%-oMa%& option sets the sender host address. This may include a port
4269 number at the end, after a full stop (period). For example:
4270 .code
4271 exim -bs -oMa 10.9.8.7.1234
4272 .endd
4273 An alternative syntax is to enclose the IP address in square brackets,
4274 followed by a colon and the port number:
4275 .code
4276 exim -bs -oMa [10.9.8.7]:1234
4277 .endd
4278 The IP address is placed in the &$sender_host_address$& variable, and the
4279 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4280 are present on the command line, the sender host IP address is taken from
4281 whichever one is last.
4282
4283 .vitem &%-oMaa%&&~<&'name'&>
4284 .oindex "&%-oMaa%&"
4285 .cindex "authentication" "name, specifying for local message"
4286 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4287 option sets the value of &$sender_host_authenticated$& (the authenticator
4288 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4289 This option can be used with &%-bh%& and &%-bs%& to set up an
4290 authenticated SMTP session without actually using the SMTP AUTH command.
4291
4292 .vitem &%-oMai%&&~<&'string'&>
4293 .oindex "&%-oMai%&"
4294 .cindex "authentication" "id, specifying for local message"
4295 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4296 option sets the value of &$authenticated_id$& (the id that was authenticated).
4297 This overrides the default value (the caller's login id, except with &%-bh%&,
4298 where there is no default) for messages from local sources. See chapter
4299 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4300
4301 .vitem &%-oMas%&&~<&'address'&>
4302 .oindex "&%-oMas%&"
4303 .cindex "authentication" "sender, specifying for local message"
4304 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4305 option sets the authenticated sender value in &$authenticated_sender$&. It
4306 overrides the sender address that is created from the caller's login id for
4307 messages from local sources, except when &%-bh%& is used, when there is no
4308 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4309 specified on a MAIL command overrides this value. See chapter
4310 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4311
4312 .vitem &%-oMi%&&~<&'interface&~address'&>
4313 .oindex "&%-oMi%&"
4314 .cindex "interface" "address, specifying for local message"
4315 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4316 option sets the IP interface address value. A port number may be included,
4317 using the same syntax as for &%-oMa%&. The interface address is placed in
4318 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4319
4320 .vitem &%-oMm%&&~<&'message&~reference'&>
4321 .oindex "&%-oMm%&"
4322 .cindex "message reference" "message reference, specifying for local message"
4323 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4324 option sets the message reference, e.g. message-id, and is logged during
4325 delivery. This is useful when some kind of audit trail is required to tie
4326 messages together. The format of the message reference is checked and will
4327 abort if the format is invalid. The option will only be accepted if exim is
4328 running in trusted mode, not as any regular user.
4329
4330 The best example of a message reference is when Exim sends a bounce message.
4331 The message reference is the message-id of the original message for which Exim
4332 is sending the bounce.
4333
4334 .vitem &%-oMr%&&~<&'protocol&~name'&>
4335 .oindex "&%-oMr%&"
4336 .cindex "protocol, specifying for local message"
4337 .vindex "&$received_protocol$&"
4338 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4339 option sets the received protocol value that is stored in
4340 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4341 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4342 SMTP protocol names (see the description of &$received_protocol$& in section
4343 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4344 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4345 be set by &%-oMr%&. Repeated use of this option is not supported.
4346
4347 .vitem &%-oMs%&&~<&'host&~name'&>
4348 .oindex "&%-oMs%&"
4349 .cindex "sender" "host name, specifying for local message"
4350 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4351 option sets the sender host name in &$sender_host_name$&. When this option is
4352 present, Exim does not attempt to look up a host name from an IP address; it
4353 uses the name it is given.
4354
4355 .vitem &%-oMt%&&~<&'ident&~string'&>
4356 .oindex "&%-oMt%&"
4357 .cindex "sender" "ident string, specifying for local message"
4358 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4359 option sets the sender ident value in &$sender_ident$&. The default setting for
4360 local callers is the login id of the calling process, except when &%-bh%& is
4361 used, when there is no default.
4362
4363 .vitem &%-om%&
4364 .oindex "&%-om%&"
4365 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4366 In Sendmail, this option means &"me too"&, indicating that the sender of a
4367 message should receive a copy of the message if the sender appears in an alias
4368 expansion. Exim always does this, so the option does nothing.
4369
4370 .vitem &%-oo%&
4371 .oindex "&%-oo%&"
4372 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4373 This option is ignored. In Sendmail it specifies &"old style headers"&,
4374 whatever that means.
4375
4376 .vitem &%-oP%&&~<&'path'&>
4377 .oindex "&%-oP%&"
4378 .cindex "pid (process id)" "of daemon"
4379 .cindex "daemon" "process id (pid)"
4380 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4381 value. The option specifies the file to which the process id of the daemon is
4382 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4383 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4384 because in those cases, the normal pid file is not used.
4385
4386 .new
4387 .vitem &%-oPX%&
4388 .oindex "&%-oPX%&"
4389 .cindex "pid (process id)" "of daemon"
4390 .cindex "daemon" "process id (pid)"
4391 This option is not intended for general use.
4392 The daemon uses it when terminating due to a SIGTEM, possibly in
4393 combination with &%-oP%&&~<&'path'&>.
4394 It causes the pid file to be removed.
4395 .wen
4396
4397 .vitem &%-or%&&~<&'time'&>
4398 .oindex "&%-or%&"
4399 .cindex "timeout" "for non-SMTP input"
4400 This option sets a timeout value for incoming non-SMTP messages. If it is not
4401 set, Exim will wait forever for the standard input. The value can also be set
4402 by the &%receive_timeout%& option. The format used for specifying times is
4403 described in section &<<SECTtimeformat>>&.
4404
4405 .vitem &%-os%&&~<&'time'&>
4406 .oindex "&%-os%&"
4407 .cindex "timeout" "for SMTP input"
4408 .cindex "SMTP" "input timeout"
4409 This option sets a timeout value for incoming SMTP messages. The timeout
4410 applies to each SMTP command and block of data. The value can also be set by
4411 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4412 for specifying times is described in section &<<SECTtimeformat>>&.
4413
4414 .vitem &%-ov%&
4415 .oindex "&%-ov%&"
4416 This option has exactly the same effect as &%-v%&.
4417
4418 .vitem &%-oX%&&~<&'number&~or&~string'&>
4419 .oindex "&%-oX%&"
4420 .cindex "TCP/IP" "setting listening ports"
4421 .cindex "TCP/IP" "setting listening interfaces"
4422 .cindex "port" "receiving TCP/IP"
4423 This option is relevant only when the &%-bd%& (start listening daemon) option
4424 is also given. It controls which ports and interfaces the daemon uses. Details
4425 of the syntax, and how it interacts with configuration file options, are given
4426 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4427 file is written unless &%-oP%& is also present to specify a pid filename.
4428
4429 .vitem &%-pd%&
4430 .oindex "&%-pd%&"
4431 .cindex "Perl" "starting the interpreter"
4432 This option applies when an embedded Perl interpreter is linked with Exim (see
4433 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4434 option, forcing the starting of the interpreter to be delayed until it is
4435 needed.
4436
4437 .vitem &%-ps%&
4438 .oindex "&%-ps%&"
4439 .cindex "Perl" "starting the interpreter"
4440 This option applies when an embedded Perl interpreter is linked with Exim (see
4441 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4442 option, forcing the starting of the interpreter to occur as soon as Exim is
4443 started.
4444
4445 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4446 .oindex "&%-p%&"
4447 For compatibility with Sendmail, this option is equivalent to
4448 .display
4449 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4450 .endd
4451 It sets the incoming protocol and host name (for trusted callers). The
4452 host name and its colon can be omitted when only the protocol is to be set.
4453 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4454 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4455 or &`s`& using this option (but that does not seem a real limitation).
4456 Repeated use of this option is not supported.
4457
4458 .vitem &%-q%&
4459 .oindex "&%-q%&"
4460 .cindex "queue runner" "starting manually"
4461 This option is normally restricted to admin users. However, there is a
4462 configuration option called &%prod_requires_admin%& which can be set false to
4463 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4464 and &%-S%& options).
4465
4466 .cindex "queue runner" "description of operation"
4467 If other commandline options do not specify an action,
4468 the &%-q%& option starts one queue runner process. This scans the queue of
4469 waiting messages, and runs a delivery process for each one in turn. It waits
4470 for each delivery process to finish before starting the next one. A delivery
4471 process may not actually do any deliveries if the retry times for the addresses
4472 have not been reached. Use &%-qf%& (see below) if you want to override this.
4473
4474 If
4475 .cindex "SMTP" "passed connection"
4476 .cindex "SMTP" "multiple deliveries"
4477 .cindex "multiple SMTP deliveries"
4478 the delivery process spawns other processes to deliver other messages down
4479 passed SMTP connections, the queue runner waits for these to finish before
4480 proceeding.
4481
4482 When all the queued messages have been considered, the original queue runner
4483 process terminates. In other words, a single pass is made over the waiting
4484 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4485 this to be repeated periodically.
4486
4487 Exim processes the waiting messages in an unpredictable order. It isn't very
4488 random, but it is likely to be different each time, which is all that matters.
4489 If one particular message screws up a remote MTA, other messages to the same
4490 MTA have a chance of getting through if they get tried first.
4491
4492 It is possible to cause the messages to be processed in lexical message id
4493 order, which is essentially the order in which they arrived, by setting the
4494 &%queue_run_in_order%& option, but this is not recommended for normal use.
4495
4496 .vitem &%-q%&<&'qflags'&>
4497 The &%-q%& option may be followed by one or more flag letters that change its
4498 behaviour. They are all optional, but if more than one is present, they must
4499 appear in the correct order. Each flag is described in a separate item below.
4500
4501 .vitem &%-qq...%&
4502 .oindex "&%-qq%&"
4503 .cindex "queue" "double scanning"
4504 .cindex "queue" "routing"
4505 .cindex "routing" "whole queue before delivery"
4506 An option starting with &%-qq%& requests a two-stage queue run. In the first
4507 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4508 every domain. Addresses are routed, local deliveries happen, but no remote
4509 transports are run.
4510
4511 .cindex "hints database" "remembering routing"
4512 The hints database that remembers which messages are waiting for specific hosts
4513 is updated, as if delivery to those hosts had been deferred. After this is
4514 complete, a second, normal queue scan happens, with routing and delivery taking
4515 place as normal. Messages that are routed to the same host should mostly be
4516 delivered down a single SMTP
4517 .cindex "SMTP" "passed connection"
4518 .cindex "SMTP" "multiple deliveries"
4519 .cindex "multiple SMTP deliveries"
4520 connection because of the hints that were set up during the first queue scan.
4521 This option may be useful for hosts that are connected to the Internet
4522 intermittently.
4523
4524 .vitem &%-q[q]i...%&
4525 .oindex "&%-qi%&"
4526 .cindex "queue" "initial delivery"
4527 If the &'i'& flag is present, the queue runner runs delivery processes only for
4528 those messages that haven't previously been tried. (&'i'& stands for &"initial
4529 delivery"&.) This can be helpful if you are putting messages in the queue using
4530 &%-odq%& and want a queue runner just to process the new messages.
4531
4532 .vitem &%-q[q][i]f...%&
4533 .oindex "&%-qf%&"
4534 .cindex "queue" "forcing delivery"
4535 .cindex "delivery" "forcing in queue run"
4536 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4537 message, whereas without &'f'& only those non-frozen addresses that have passed
4538 their retry times are tried.
4539
4540 .vitem &%-q[q][i]ff...%&
4541 .oindex "&%-qff%&"
4542 .cindex "frozen messages" "forcing delivery"
4543 If &'ff'& is present, a delivery attempt is forced for every message, whether
4544 frozen or not.
4545
4546 .vitem &%-q[q][i][f[f]]l%&
4547 .oindex "&%-ql%&"
4548 .cindex "queue" "local deliveries only"
4549 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4550 be done. If a message requires any remote deliveries, it remains in the queue
4551 for later delivery.
4552
4553 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4554 .oindex "&%-qG%&"
4555 .cindex queue named
4556 .cindex "named queues"
4557 .cindex "queue" "delivering specific messages"
4558 If the &'G'& flag and a name is present, the queue runner operates on the
4559 queue with the given name rather than the default queue.
4560 The name should not contain a &'/'& character.
4561 For a periodic queue run (see below)
4562 append to the name a slash and a time value.
4563
4564 If other commandline options specify an action, a &'-qG<name>'& option
4565 will specify a queue to operate on.
4566 For example:
4567 .code
4568 exim -bp -qGquarantine
4569 mailq -qGquarantine
4570 exim -qGoffpeak -Rf @special.domain.example
4571 .endd
4572
4573 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4574 When scanning the queue, Exim can be made to skip over messages whose ids are
4575 lexically less than a given value by following the &%-q%& option with a
4576 starting message id. For example:
4577 .code
4578 exim -q 0t5C6f-0000c8-00
4579 .endd
4580 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4581 second message id is given, messages whose ids are lexically greater than it
4582 are also skipped. If the same id is given twice, for example,
4583 .code
4584 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4585 .endd
4586 just one delivery process is started, for that message. This differs from
4587 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4588 that it counts as a delivery from a queue run. Note that the selection
4589 mechanism does not affect the order in which the messages are scanned. There
4590 are also other ways of selecting specific sets of messages for delivery in a
4591 queue run &-- see &%-R%& and &%-S%&.
4592
4593 .vitem &%-q%&<&'qflags'&><&'time'&>
4594 .cindex "queue runner" "starting periodically"
4595 .cindex "periodic queue running"
4596 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4597 starting a queue runner process at intervals specified by the given time value
4598 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4599 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4600 single daemon process handles both functions. A common way of starting up a
4601 combined daemon at system boot time is to use a command such as
4602 .code
4603 /usr/exim/bin/exim -bd -q30m
4604 .endd
4605 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4606 process every 30 minutes.
4607
4608 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4609 pid file is written unless one is explicitly requested by the &%-oP%& option.
4610
4611 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4612 .oindex "&%-qR%&"
4613 This option is synonymous with &%-R%&. It is provided for Sendmail
4614 compatibility.
4615
4616 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4617 .oindex "&%-qS%&"
4618 This option is synonymous with &%-S%&.
4619
4620 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4621 .oindex "&%-R%&"
4622 .cindex "queue runner" "for specific recipients"
4623 .cindex "delivery" "to given domain"
4624 .cindex "domain" "delivery to"
4625 The <&'rsflags'&> may be empty, in which case the white space before the string
4626 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4627 which are the possible values for <&'rsflags'&>. White space is required if
4628 <&'rsflags'&> is not empty.
4629
4630 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4631 perform a single queue run, except that, when scanning the messages on the
4632 queue, Exim processes only those that have at least one undelivered recipient
4633 address containing the given string, which is checked in a case-independent
4634 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4635 regular expression; otherwise it is a literal string.
4636
4637 If you want to do periodic queue runs for messages with specific recipients,
4638 you can combine &%-R%& with &%-q%& and a time value. For example:
4639 .code
4640 exim -q25m -R @special.domain.example
4641 .endd
4642 This example does a queue run for messages with recipients in the given domain
4643 every 25 minutes. Any additional flags that are specified with &%-q%& are
4644 applied to each queue run.
4645
4646 Once a message is selected for delivery by this mechanism, all its addresses
4647 are processed. For the first selected message, Exim overrides any retry
4648 information and forces a delivery attempt for each undelivered address. This
4649 means that if delivery of any address in the first message is successful, any
4650 existing retry information is deleted, and so delivery attempts for that
4651 address in subsequently selected messages (which are processed without forcing)
4652 will run. However, if delivery of any address does not succeed, the retry
4653 information is updated, and in subsequently selected messages, the failing
4654 address will be skipped.
4655
4656 .cindex "frozen messages" "forcing delivery"
4657 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4658 all selected messages, not just the first; frozen messages are included when
4659 &'ff'& is present.
4660
4661 The &%-R%& option makes it straightforward to initiate delivery of all messages
4662 to a given domain after a host has been down for some time. When the SMTP
4663 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4664 effect is to run Exim with the &%-R%& option, but it can be configured to run
4665 an arbitrary command instead.
4666
4667 .vitem &%-r%&
4668 .oindex "&%-r%&"
4669 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4670
4671 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4672 .oindex "&%-S%&"
4673 .cindex "delivery" "from given sender"
4674 .cindex "queue runner" "for specific senders"
4675 This option acts like &%-R%& except that it checks the string against each
4676 message's sender instead of against the recipients. If &%-R%& is also set, both
4677 conditions must be met for a message to be selected. If either of the options
4678 has &'f'& or &'ff'& in its flags, the associated action is taken.
4679
4680 .vitem &%-Tqt%&&~<&'times'&>
4681 .oindex "&%-Tqt%&"
4682 This is an option that is exclusively for use by the Exim testing suite. It is not
4683 recognized when Exim is run normally. It allows for the setting up of explicit
4684 &"queue times"& so that various warning/retry features can be tested.
4685
4686 .vitem &%-t%&
4687 .oindex "&%-t%&"
4688 .cindex "recipient" "extracting from header lines"
4689 .cindex "&'Bcc:'& header line"
4690 .cindex "&'Cc:'& header line"
4691 .cindex "&'To:'& header line"
4692 When Exim is receiving a locally-generated, non-SMTP message on its standard
4693 input, the &%-t%& option causes the recipients of the message to be obtained
4694 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4695 from the command arguments. The addresses are extracted before any rewriting
4696 takes place and the &'Bcc:'& header line, if present, is then removed.
4697
4698 .cindex "Sendmail compatibility" "&%-t%& option"
4699 If the command has any arguments, they specify addresses to which the message
4700 is &'not'& to be delivered. That is, the argument addresses are removed from
4701 the recipients list obtained from the headers. This is compatible with Smail 3
4702 and in accordance with the documented behaviour of several versions of
4703 Sendmail, as described in man pages on a number of operating systems (e.g.
4704 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4705 argument addresses to those obtained from the headers, and the O'Reilly
4706 Sendmail book documents it that way. Exim can be made to add argument addresses
4707 instead of subtracting them by setting the option
4708 &%extract_addresses_remove_arguments%& false.
4709
4710 .cindex "&%Resent-%& header lines" "with &%-t%&"
4711 If there are any &%Resent-%& header lines in the message, Exim extracts
4712 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4713 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4714 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4715 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4716
4717 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4718 message is resent several times). The RFC also specifies that they should be
4719 added at the front of the message, and separated by &'Received:'& lines. It is
4720 not at all clear how &%-t%& should operate in the present of multiple sets,
4721 nor indeed exactly what constitutes a &"set"&.
4722 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4723 are often added at the end of the header, and if a message is resent more than
4724 once, it is common for the original set of &%Resent-%& headers to be renamed as
4725 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4726
4727 .vitem &%-ti%&
4728 .oindex "&%-ti%&"
4729 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4730 compatibility with Sendmail.
4731
4732 .vitem &%-tls-on-connect%&
4733 .oindex "&%-tls-on-connect%&"
4734 .cindex "TLS" "use without STARTTLS"
4735 .cindex "TLS" "automatic start"
4736 This option is available when Exim is compiled with TLS support. It forces all
4737 incoming SMTP connections to behave as if the incoming port is listed in the
4738 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4739 &<<CHAPTLS>>& for further details.
4740
4741
4742 .vitem &%-U%&
4743 .oindex "&%-U%&"
4744 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4745 Sendmail uses this option for &"initial message submission"&, and its
4746 documentation states that in future releases, it may complain about
4747 syntactically invalid messages rather than fixing them when this flag is not
4748 set. Exim ignores this option.
4749
4750 .vitem &%-v%&
4751 .oindex "&%-v%&"
4752 This option causes Exim to write information to the standard error stream,
4753 describing what it is doing. In particular, it shows the log lines for
4754 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4755 dialogue is shown. Some of the log lines shown may not actually be written to
4756 the log if the setting of &%log_selector%& discards them. Any relevant
4757 selectors are shown with each log line. If none are shown, the logging is
4758 unconditional.
4759
4760 .vitem &%-x%&
4761 .oindex "&%-x%&"
4762 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4763 National Language Support extended characters in the body of the mail item"&).
4764 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4765 this option.
4766
4767 .vitem &%-X%&&~<&'logfile'&>
4768 .oindex "&%-X%&"
4769 This option is interpreted by Sendmail to cause debug information to be sent
4770 to the named file.  It is ignored by Exim.
4771
4772 .vitem &%-z%&&~<&'log-line'&>
4773 .oindex "&%-z%&"
4774 This option writes its argument to Exim's logfile.
4775 Use is restricted to administrators; the intent is for operational notes.
4776 Quotes should be used to maintain a multi-word item as a single argument,
4777 under most shells.
4778 .endlist
4779
4780 .ecindex IIDclo1
4781 .ecindex IIDclo2
4782
4783
4784 . ////////////////////////////////////////////////////////////////////////////
4785 . Insert a stylized DocBook comment here, to identify the end of the command
4786 . line options. This is for the benefit of the Perl script that automatically
4787 . creates a man page for the options.
4788 . ////////////////////////////////////////////////////////////////////////////
4789
4790 .literal xml
4791 <!-- === End of command line options === -->
4792 .literal off
4793
4794
4795
4796
4797
4798 . ////////////////////////////////////////////////////////////////////////////
4799 . ////////////////////////////////////////////////////////////////////////////
4800
4801
4802 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4803          "The runtime configuration file"
4804
4805 .cindex "runtime configuration"
4806 .cindex "configuration file" "general description"
4807 .cindex "CONFIGURE_FILE"
4808 .cindex "configuration file" "errors in"
4809 .cindex "error" "in configuration file"
4810 .cindex "return code" "for bad configuration"
4811 Exim uses a single runtime configuration file that is read whenever an Exim
4812 binary is executed. Note that in normal operation, this happens frequently,
4813 because Exim is designed to operate in a distributed manner, without central
4814 control.
4815
4816 If a syntax error is detected while reading the configuration file, Exim
4817 writes a message on the standard error, and exits with a non-zero return code.
4818 The message is also written to the panic log. &*Note*&: Only simple syntax
4819 errors can be detected at this time. The values of any expanded options are
4820 not checked until the expansion happens, even when the expansion does not
4821 actually alter the string.
4822
4823 The name of the configuration file is compiled into the binary for security
4824 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4825 most configurations, this specifies a single file. However, it is permitted to
4826 give a colon-separated list of filenames, in which case Exim uses the first
4827 existing file in the list.
4828
4829 .cindex "EXIM_USER"
4830 .cindex "EXIM_GROUP"
4831 .cindex "CONFIGURE_OWNER"
4832 .cindex "CONFIGURE_GROUP"
4833 .cindex "configuration file" "ownership"
4834 .cindex "ownership" "configuration file"
4835 The runtime configuration file must be owned by root or by the user that is
4836 specified at compile time by the CONFIGURE_OWNER option (if set). The
4837 configuration file must not be world-writeable, or group-writeable unless its
4838 group is the root group or the one specified at compile time by the
4839 CONFIGURE_GROUP option.
4840
4841 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4842 to root, anybody who is able to edit the runtime configuration file has an
4843 easy way to run commands as root. If you specify a user or group in the
4844 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4845 who are members of that group will trivially be able to obtain root privileges.
4846
4847 Up to Exim version 4.72, the runtime configuration file was also permitted to
4848 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4849 since it offered a simple privilege escalation for any attacker who managed to
4850 compromise the Exim user account.
4851
4852 A default configuration file, which will work correctly in simple situations,
4853 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4854 defines just one filename, the installation process copies the default
4855 configuration to a new file of that name if it did not previously exist. If
4856 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4857 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4858 configuration.
4859
4860
4861
4862 .section "Using a different configuration file" "SECID40"
4863 .cindex "configuration file" "alternate"
4864 A one-off alternate configuration can be specified by the &%-C%& command line
4865 option, which may specify a single file or a list of files. However, when
4866 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4867 unless the argument for &%-C%& is identical to the built-in value from
4868 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4869 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4870 is useful mainly for checking the syntax of configuration files before
4871 installing them. No owner or group checks are done on a configuration file
4872 specified by &%-C%&, if root privilege has been dropped.
4873
4874 Even the Exim user is not trusted to specify an arbitrary configuration file
4875 with the &%-C%& option to be used with root privileges, unless that file is
4876 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4877 testing a configuration using &%-C%& right through message reception and
4878 delivery, even if the caller is root. The reception works, but by that time,
4879 Exim is running as the Exim user, so when it re-execs to regain privilege for
4880 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4881 can test reception and delivery using two separate commands (one to put a
4882 message in the queue, using &%-odq%&, and another to do the delivery, using
4883 &%-M%&).
4884
4885 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4886 prefix string with which any file named in a &%-C%& command line option must
4887 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4888 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4889 filename can be used with &%-C%&.
4890
4891 One-off changes to a configuration can be specified by the &%-D%& command line
4892 option, which defines and overrides values for macros used inside the
4893 configuration file. However, like &%-C%&, the use of this option by a
4894 non-privileged user causes Exim to discard its root privilege.
4895 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4896 completely disabled, and its use causes an immediate error exit.
4897
4898 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4899 to declare certain macro names trusted, such that root privilege will not
4900 necessarily be discarded.
4901 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4902 considered safe and, if &%-D%& only supplies macros from this list, and the
4903 values are acceptable, then Exim will not give up root privilege if the caller
4904 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4905 transition mechanism and is expected to be removed in the future.  Acceptable
4906 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4907
4908 Some sites may wish to use the same Exim binary on different machines that
4909 share a file system, but to use different configuration files on each machine.
4910 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4911 looks for a file whose name is the configuration filename followed by a dot
4912 and the machine's node name, as obtained from the &[uname()]& function. If this
4913 file does not exist, the standard name is tried. This processing occurs for
4914 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4915
4916 In some esoteric situations different versions of Exim may be run under
4917 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4918 help with this. See the comments in &_src/EDITME_& for details.
4919
4920
4921
4922 .section "Configuration file format" "SECTconffilfor"
4923 .cindex "configuration file" "format of"
4924 .cindex "format" "configuration file"
4925 Exim's configuration file is divided into a number of different parts. General
4926 option settings must always appear at the start of the file. The other parts
4927 are all optional, and may appear in any order. Each part other than the first
4928 is introduced by the word &"begin"& followed by at least one literal
4929 space, and the name of the part. The optional parts are:
4930
4931 .ilist
4932 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4933 &<<CHAPACL>>&).
4934 .next
4935 .cindex "AUTH" "configuration"
4936 &'authenticators'&: Configuration settings for the authenticator drivers. These
4937 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4938 .next
4939 &'routers'&: Configuration settings for the router drivers. Routers process
4940 addresses and determine how the message is to be delivered (see chapters
4941 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4942 .next
4943 &'transports'&: Configuration settings for the transport drivers. Transports
4944 define mechanisms for copying messages to destinations (see chapters
4945 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4946 .next
4947 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4948 If there is no retry section, or if it is empty (that is, no retry rules are
4949 defined), Exim will not retry deliveries. In this situation, temporary errors
4950 are treated the same as permanent errors. Retry rules are discussed in chapter
4951 &<<CHAPretry>>&.
4952 .next
4953 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4954 when new addresses are generated during delivery. Rewriting is discussed in
4955 chapter &<<CHAPrewrite>>&.
4956 .next
4957 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4958 want to use this feature, you must set
4959 .code
4960 LOCAL_SCAN_HAS_OPTIONS=yes
4961 .endd
4962 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4963 facility are given in chapter &<<CHAPlocalscan>>&.
4964 .endlist
4965
4966 .cindex "configuration file" "leading white space in"
4967 .cindex "configuration file" "trailing white space in"
4968 .cindex "white space" "in configuration file"
4969 Leading and trailing white space in configuration lines is always ignored.
4970
4971 Blank lines in the file, and lines starting with a # character (ignoring
4972 leading white space) are treated as comments and are ignored. &*Note*&: A
4973 # character other than at the beginning of a line is not treated specially,
4974 and does not introduce a comment.
4975
4976 Any non-comment line can be continued by ending it with a backslash. Note that
4977 the general rule for white space means that trailing white space after the
4978 backslash and leading white space at the start of continuation
4979 lines is ignored. Comment lines beginning with # (but not empty lines) may
4980 appear in the middle of a sequence of continuation lines.
4981
4982 A convenient way to create a configuration file is to start from the
4983 default, which is supplied in &_src/configure.default_&, and add, delete, or
4984 change settings as required.
4985
4986 The ACLs, retry rules, and rewriting rules have their own syntax which is
4987 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4988 respectively. The other parts of the configuration file have some syntactic
4989 items in common, and these are described below, from section &<<SECTcos>>&
4990 onwards. Before that, the inclusion, macro, and conditional facilities are
4991 described.
4992
4993
4994
4995 .section "File inclusions in the configuration file" "SECID41"
4996 .cindex "inclusions in configuration file"
4997 .cindex "configuration file" "including other files"
4998 .cindex "&`.include`& in configuration file"
4999 .cindex "&`.include_if_exists`& in configuration file"
5000 You can include other files inside Exim's runtime configuration file by
5001 using this syntax:
5002 .display
5003 &`.include`& <&'filename'&>
5004 &`.include_if_exists`& <&'filename'&>
5005 .endd
5006 on a line by itself. Double quotes round the filename are optional. If you use
5007 the first form, a configuration error occurs if the file does not exist; the
5008 second form does nothing for non-existent files.
5009 The first form allows a relative name. It is resolved relative to
5010 the directory of the including file. For the second form an absolute filename
5011 is required.
5012
5013 Includes may be nested to any depth, but remember that Exim reads its
5014 configuration file often, so it is a good idea to keep them to a minimum.
5015 If you change the contents of an included file, you must HUP the daemon,
5016 because an included file is read only when the configuration itself is read.
5017
5018 The processing of inclusions happens early, at a physical line level, so, like
5019 comment lines, an inclusion can be used in the middle of an option setting,
5020 for example:
5021 .code
5022 hosts_lookup = a.b.c \
5023                .include /some/file
5024 .endd
5025 Include processing happens after macro processing (see below). Its effect is to
5026 process the lines of the included file as if they occurred inline where the
5027 inclusion appears.
5028
5029
5030
5031 .section "Macros in the configuration file" "SECTmacrodefs"
5032 .cindex "macro" "description of"
5033 .cindex "configuration file" "macros"
5034 If a line in the main part of the configuration (that is, before the first
5035 &"begin"& line) begins with an upper case letter, it is taken as a macro
5036 definition, and must be of the form
5037 .display
5038 <&'name'&> = <&'rest of line'&>
5039 .endd
5040 The name must consist of letters, digits, and underscores, and need not all be
5041 in upper case, though that is recommended. The rest of the line, including any
5042 continuations, is the replacement text, and has leading and trailing white
5043 space removed. Quotes are not removed. The replacement text can never end with
5044 a backslash character, but this doesn't seem to be a serious limitation.
5045
5046 Macros may also be defined between router, transport, authenticator, or ACL
5047 definitions. They may not, however, be defined within an individual driver or
5048 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5049
5050 .section "Macro substitution" "SECID42"
5051 Once a macro is defined, all subsequent lines in the file (and any included
5052 files) are scanned for the macro name; if there are several macros, the line is
5053 scanned for each, in turn, in the order in which the macros are defined. The
5054 replacement text is not re-scanned for the current macro, though it is scanned
5055 for subsequently defined macros. For this reason, a macro name may not contain
5056 the name of a previously defined macro as a substring. You could, for example,
5057 define
5058 .display
5059 &`ABCD_XYZ = `&<&'something'&>
5060 &`ABCD = `&<&'something else'&>
5061 .endd
5062 but putting the definitions in the opposite order would provoke a configuration
5063 error. Macro expansion is applied to individual physical lines from the file,
5064 before checking for line continuation or file inclusion (see above). If a line
5065 consists solely of a macro name, and the expansion of the macro is empty, the
5066 line is ignored. A macro at the start of a line may turn the line into a
5067 comment line or a &`.include`& line.
5068
5069
5070 .section "Redefining macros" "SECID43"
5071 Once defined, the value of a macro can be redefined later in the configuration
5072 (or in an included file). Redefinition is specified by using &'=='& instead of
5073 &'='&. For example:
5074 .code
5075 MAC =  initial value
5076 ...
5077 MAC == updated value
5078 .endd
5079 Redefinition does not alter the order in which the macros are applied to the
5080 subsequent lines of the configuration file. It is still the same order in which
5081 the macros were originally defined. All that changes is the macro's value.
5082 Redefinition makes it possible to accumulate values. For example:
5083 .code
5084 MAC =  initial value
5085 ...
5086 MAC == MAC and something added
5087 .endd
5088 This can be helpful in situations where the configuration file is built
5089 from a number of other files.
5090
5091 .section "Overriding macro values" "SECID44"
5092 The values set for macros in the configuration file can be overridden by the
5093 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5094 used, unless called by root or the Exim user. A definition on the command line
5095 using the &%-D%& option causes all definitions and redefinitions within the
5096 file to be ignored.
5097
5098
5099
5100 .section "Example of macro usage" "SECID45"
5101 As an example of macro usage, consider a configuration where aliases are looked
5102 up in a MySQL database. It helps to keep the file less cluttered if long
5103 strings such as SQL statements are defined separately as macros, for example:
5104 .code
5105 ALIAS_QUERY = select mailbox from user where \
5106               login='${quote_mysql:$local_part}';
5107 .endd
5108 This can then be used in a &(redirect)& router setting like this:
5109 .code
5110 data = ${lookup mysql{ALIAS_QUERY}}
5111 .endd
5112 In earlier versions of Exim macros were sometimes used for domain, host, or
5113 address lists. In Exim 4 these are handled better by named lists &-- see
5114 section &<<SECTnamedlists>>&.
5115
5116
5117 .section "Builtin macros" "SECTbuiltinmacros"
5118 Exim defines some macros depending on facilities available, which may
5119 differ due to build-time definitions and from one release to another.
5120 All of these macros start with an underscore.
5121 They can be used to conditionally include parts of a configuration
5122 (see below).
5123
5124 The following classes of macros are defined:
5125 .display
5126 &` _HAVE_*                    `&  build-time defines
5127 &` _DRIVER_ROUTER_*           `&  router drivers
5128 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5129 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5130 &` _LOG_*                     `&  log_selector values
5131 &` _OPT_MAIN_*                `&  main config options
5132 &` _OPT_ROUTERS_*             `&  generic router options
5133 &` _OPT_TRANSPORTS_*          `&  generic transport options
5134 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5135 &` _OPT_ROUTER_*_*            `&  private router options
5136 &` _OPT_TRANSPORT_*_*         `&  private transport options
5137 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5138 .endd
5139
5140 Use an &"exim -bP macros"& command to get the list of macros.
5141
5142
5143 .section "Conditional skips in the configuration file" "SECID46"
5144 .cindex "configuration file" "conditional skips"
5145 .cindex "&`.ifdef`&"
5146 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5147 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5148 portions of the configuration file. The processing happens whenever the file is
5149 read (that is, when an Exim binary starts to run).
5150
5151 The implementation is very simple. Instances of the first four directives must
5152 be followed by text that includes the names of one or macros. The condition
5153 that is tested is whether or not any macro substitution has taken place in the
5154 line. Thus:
5155 .code
5156 .ifdef AAA
5157 message_size_limit = 50M
5158 .else
5159 message_size_limit = 100M
5160 .endif
5161 .endd
5162 sets a message size limit of 50M if the macro &`AAA`& is defined
5163 (or &`A`& or &`AA`&), and 100M
5164 otherwise. If there is more than one macro named on the line, the condition
5165 is true if any of them are defined. That is, it is an &"or"& condition. To
5166 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5167
5168 Although you can use a macro expansion to generate one of these directives,
5169 it is not very useful, because the condition &"there was a macro substitution
5170 in this line"& will always be true.
5171
5172 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5173 to clarify complicated nestings.
5174
5175
5176
5177 .section "Common option syntax" "SECTcos"
5178 .cindex "common option syntax"
5179 .cindex "syntax of common options"
5180 .cindex "configuration file" "common option syntax"
5181 For the main set of options, driver options, and &[local_scan()]& options,
5182 each setting is on a line by itself, and starts with a name consisting of
5183 lower-case letters and underscores. Many options require a data value, and in
5184 these cases the name must be followed by an equals sign (with optional white
5185 space) and then the value. For example:
5186 .code
5187 qualify_domain = mydomain.example.com
5188 .endd
5189 .cindex "hiding configuration option values"
5190 .cindex "configuration options" "hiding value of"
5191 .cindex "options" "hiding value of"
5192 Some option settings may contain sensitive data, for example, passwords for
5193 accessing databases. To stop non-admin users from using the &%-bP%& command
5194 line option to read these values, you can precede the option settings with the
5195 word &"hide"&. For example:
5196 .code
5197 hide mysql_servers = localhost/users/admin/secret-password
5198 .endd
5199 For non-admin users, such options are displayed like this:
5200 .code
5201 mysql_servers = <value not displayable>
5202 .endd
5203 If &"hide"& is used on a driver option, it hides the value of that option on
5204 all instances of the same driver.
5205
5206 The following sections describe the syntax used for the different data types
5207 that are found in option settings.
5208
5209
5210 .section "Boolean options" "SECID47"
5211 .cindex "format" "boolean"
5212 .cindex "boolean configuration values"
5213 .oindex "&%no_%&&'xxx'&"
5214 .oindex "&%not_%&&'xxx'&"
5215 Options whose type is given as boolean are on/off switches. There are two
5216 different ways of specifying such options: with and without a data value. If
5217 the option name is specified on its own without data, the switch is turned on;
5218 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5219 boolean options may be followed by an equals sign and one of the words
5220 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5221 the following two settings have exactly the same effect:
5222 .code
5223 queue_only
5224 queue_only = true
5225 .endd
5226 The following two lines also have the same (opposite) effect:
5227 .code
5228 no_queue_only
5229 queue_only = false
5230 .endd
5231 You can use whichever syntax you prefer.
5232
5233
5234
5235
5236 .section "Integer values" "SECID48"
5237 .cindex "integer configuration values"
5238 .cindex "format" "integer"
5239 If an option's type is given as &"integer"&, the value can be given in decimal,
5240 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5241 number is assumed. Otherwise, it is treated as an octal number unless it starts
5242 with the characters &"0x"&, in which case the remainder is interpreted as a
5243 hexadecimal number.
5244
5245 If an integer value is followed by the letter K, it is multiplied by 1024; if
5246 it is followed by the letter M, it is multiplied by 1024x1024;
5247 if by the letter G, 1024x1024x1024.
5248 When the values
5249 of integer option settings are output, values which are an exact multiple of
5250 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5251 and M. The printing style is independent of the actual input format that was
5252 used.
5253
5254
5255 .section "Octal integer values" "SECID49"
5256 .cindex "integer format"
5257 .cindex "format" "octal integer"
5258 If an option's type is given as &"octal integer"&, its value is always
5259 interpreted as an octal number, whether or not it starts with the digit zero.
5260 Such options are always output in octal.
5261
5262
5263 .section "Fixed point numbers" "SECID50"
5264 .cindex "fixed point configuration values"
5265 .cindex "format" "fixed point"
5266 If an option's type is given as &"fixed-point"&, its value must be a decimal
5267 integer, optionally followed by a decimal point and up to three further digits.
5268
5269
5270
5271 .section "Time intervals" "SECTtimeformat"
5272 .cindex "time interval" "specifying in configuration"
5273 .cindex "format" "time interval"
5274 A time interval is specified as a sequence of numbers, each followed by one of
5275 the following letters, with no intervening white space:
5276
5277 .table2 30pt
5278 .irow &%s%& seconds
5279 .irow &%m%& minutes
5280 .irow &%h%& hours
5281 .irow &%d%& days
5282 .irow &%w%& weeks
5283 .endtable
5284
5285 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5286 intervals are output in the same format. Exim does not restrict the values; it
5287 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5288
5289
5290
5291 .section "String values" "SECTstrings"
5292 .cindex "string" "format of configuration values"
5293 .cindex "format" "string"
5294 If an option's type is specified as &"string"&, the value can be specified with
5295 or without double-quotes. If it does not start with a double-quote, the value
5296 consists of the remainder of the line plus any continuation lines, starting at
5297 the first character after any leading white space, with trailing white space
5298 removed, and with no interpretation of the characters in the string. Because
5299 Exim removes comment lines (those beginning with #) at an early stage, they can
5300 appear in the middle of a multi-line string. The following two settings are
5301 therefore equivalent:
5302 .code
5303 trusted_users = uucp:mail
5304 trusted_users = uucp:\
5305                 # This comment line is ignored
5306                 mail
5307 .endd
5308 .cindex "string" "quoted"
5309 .cindex "escape characters in quoted strings"
5310 If a string does start with a double-quote, it must end with a closing
5311 double-quote, and any backslash characters other than those used for line
5312 continuation are interpreted as escape characters, as follows:
5313
5314 .table2 100pt
5315 .irow &`\\`&                     "single backslash"
5316 .irow &`\n`&                     "newline"
5317 .irow &`\r`&                     "carriage return"
5318 .irow &`\t`&                     "tab"
5319 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5320 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5321                                    character"
5322 .endtable
5323
5324 If a backslash is followed by some other character, including a double-quote
5325 character, that character replaces the pair.
5326
5327 Quoting is necessary only if you want to make use of the backslash escapes to
5328 insert special characters, or if you need to specify a value with leading or
5329 trailing spaces. These cases are rare, so quoting is almost never needed in
5330 current versions of Exim. In versions of Exim before 3.14, quoting was required
5331 in order to continue lines, so you may come across older configuration files
5332 and examples that apparently quote unnecessarily.
5333
5334
5335 .section "Expanded strings" "SECID51"
5336 .cindex "expansion" "definition of"
5337 Some strings in the configuration file are subjected to &'string expansion'&,
5338 by which means various parts of the string may be changed according to the
5339 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5340 is as just described; in particular, the handling of backslashes in quoted
5341 strings is done as part of the input process, before expansion takes place.
5342 However, backslash is also an escape character for the expander, so any
5343 backslashes that are required for that reason must be doubled if they are
5344 within a quoted configuration string.
5345
5346
5347 .section "User and group names" "SECID52"
5348 .cindex "user name" "format of"
5349 .cindex "format" "user name"
5350 .cindex "groups" "name format"
5351 .cindex "format" "group name"
5352 User and group names are specified as strings, using the syntax described
5353 above, but the strings are interpreted specially. A user or group name must
5354 either consist entirely of digits, or be a name that can be looked up using the
5355 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5356
5357
5358 .section "List construction" "SECTlistconstruct"
5359 .cindex "list" "syntax of in configuration"
5360 .cindex "format" "list item in configuration"
5361 .cindex "string" "list, definition of"
5362 The data for some configuration options is a list of items, with colon as the
5363 default separator. Many of these options are shown with type &"string list"& in
5364 the descriptions later in this document. Others are listed as &"domain list"&,
5365 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5366 are all the same; however, those other than &"string list"& are subject to
5367 particular kinds of interpretation, as described in chapter
5368 &<<CHAPdomhosaddlists>>&.
5369
5370 In all these cases, the entire list is treated as a single string as far as the
5371 input syntax is concerned. The &%trusted_users%& setting in section
5372 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5373 in a list, it must be entered as two colons. Leading and trailing white space
5374 on each item in a list is ignored. This makes it possible to include items that
5375 start with a colon, and in particular, certain forms of IPv6 address. For
5376 example, the list
5377 .code
5378 local_interfaces = 127.0.0.1 : ::::1
5379 .endd
5380 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5381
5382 &*Note*&: Although leading and trailing white space is ignored in individual
5383 list items, it is not ignored when parsing the list. The space after the first
5384 colon in the example above is necessary. If it were not there, the list would
5385 be interpreted as the two items 127.0.0.1:: and 1.
5386
5387 .section "Changing list separators" "SECTlistsepchange"
5388 .cindex "list separator" "changing"
5389 .cindex "IPv6" "addresses in lists"
5390 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5391 introduced to allow the separator character to be changed. If a list begins
5392 with a left angle bracket, followed by any punctuation character, that
5393 character is used instead of colon as the list separator. For example, the list
5394 above can be rewritten to use a semicolon separator like this:
5395 .code
5396 local_interfaces = <; 127.0.0.1 ; ::1
5397 .endd
5398 This facility applies to all lists, with the exception of the list in
5399 &%log_file_path%&. It is recommended that the use of non-colon separators be
5400 confined to circumstances where they really are needed.
5401
5402 .cindex "list separator" "newline as"
5403 .cindex "newline" "as list separator"
5404 It is also possible to use newline and other control characters (those with
5405 code values less than 32, plus DEL) as separators in lists. Such separators
5406 must be provided literally at the time the list is processed. For options that
5407 are string-expanded, you can write the separator using a normal escape
5408 sequence. This will be processed by the expander before the string is
5409 interpreted as a list. For example, if a newline-separated list of domains is
5410 generated by a lookup, you can process it directly by a line such as this:
5411 .code
5412 domains = <\n ${lookup mysql{.....}}
5413 .endd
5414 This avoids having to change the list separator in such data. You are unlikely
5415 to want to use a control character as a separator in an option that is not
5416 expanded, because the value is literal text. However, it can be done by giving
5417 the value in quotes. For example:
5418 .code
5419 local_interfaces = "<\n 127.0.0.1 \n ::1"
5420 .endd
5421 Unlike printing character separators, which can be included in list items by
5422 doubling, it is not possible to include a control character as data when it is
5423 set as the separator. Two such characters in succession are interpreted as
5424 enclosing an empty list item.
5425
5426
5427
5428 .section "Empty items in lists" "SECTempitelis"
5429 .cindex "list" "empty item in"
5430 An empty item at the end of a list is always ignored. In other words, trailing
5431 separator characters are ignored. Thus, the list in
5432 .code
5433 senders = user@domain :
5434 .endd
5435 contains only a single item. If you want to include an empty string as one item
5436 in a list, it must not be the last item. For example, this list contains three
5437 items, the second of which is empty:
5438 .code
5439 senders = user1@domain : : user2@domain
5440 .endd
5441 &*Note*&: There must be white space between the two colons, as otherwise they
5442 are interpreted as representing a single colon data character (and the list
5443 would then contain just one item). If you want to specify a list that contains
5444 just one, empty item, you can do it as in this example:
5445 .code
5446 senders = :
5447 .endd
5448 In this case, the first item is empty, and the second is discarded because it
5449 is at the end of the list.
5450
5451
5452
5453
5454 .section "Format of driver configurations" "SECTfordricon"
5455 .cindex "drivers" "configuration format"
5456 There are separate parts in the configuration for defining routers, transports,
5457 and authenticators. In each part, you are defining a number of driver
5458 instances, each with its own set of options. Each driver instance is defined by
5459 a sequence of lines like this:
5460 .display
5461 <&'instance name'&>:
5462   <&'option'&>
5463   ...
5464   <&'option'&>
5465 .endd
5466 In the following example, the instance name is &(localuser)&, and it is
5467 followed by three options settings:
5468 .code
5469 localuser:
5470   driver = accept
5471   check_local_user
5472   transport = local_delivery
5473 .endd
5474 For each driver instance, you specify which Exim code module it uses &-- by the
5475 setting of the &%driver%& option &-- and (optionally) some configuration
5476 settings. For example, in the case of transports, if you want a transport to
5477 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5478 a local file you would use the &(appendfile)& driver. Each of the drivers is
5479 described in detail in its own separate chapter later in this manual.
5480
5481 You can have several routers, transports, or authenticators that are based on
5482 the same underlying driver (each must have a different instance name).
5483
5484 The order in which routers are defined is important, because addresses are
5485 passed to individual routers one by one, in order. The order in which
5486 transports are defined does not matter at all. The order in which
5487 authenticators are defined is used only when Exim, as a client, is searching
5488 them to find one that matches an authentication mechanism offered by the
5489 server.
5490
5491 .cindex "generic options"
5492 .cindex "options" "generic &-- definition of"
5493 Within a driver instance definition, there are two kinds of option: &'generic'&
5494 and &'private'&. The generic options are those that apply to all drivers of the
5495 same type (that is, all routers, all transports or all authenticators). The
5496 &%driver%& option is a generic option that must appear in every definition.
5497 .cindex "private options"
5498 The private options are special for each driver, and none need appear, because
5499 they all have default values.
5500
5501 The options may appear in any order, except that the &%driver%& option must
5502 precede any private options, since these depend on the particular driver. For
5503 this reason, it is recommended that &%driver%& always be the first option.
5504
5505 Driver instance names, which are used for reference in log entries and
5506 elsewhere, can be any sequence of letters, digits, and underscores (starting
5507 with a letter) and must be unique among drivers of the same type. A router and
5508 a transport (for example) can each have the same name, but no two router
5509 instances can have the same name. The name of a driver instance should not be
5510 confused with the name of the underlying driver module. For example, the
5511 configuration lines:
5512 .code
5513 remote_smtp:
5514   driver = smtp
5515 .endd
5516 create an instance of the &(smtp)& transport driver whose name is
5517 &(remote_smtp)&. The same driver code can be used more than once, with
5518 different instance names and different option settings each time. A second
5519 instance of the &(smtp)& transport, with different options, might be defined
5520 thus:
5521 .code
5522 special_smtp:
5523   driver = smtp
5524   port = 1234
5525   command_timeout = 10s
5526 .endd
5527 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5528 these transport instances from routers, and these names would appear in log
5529 lines.
5530
5531 Comment lines may be present in the middle of driver specifications. The full
5532 list of option settings for any particular driver instance, including all the
5533 defaulted values, can be extracted by making use of the &%-bP%& command line
5534 option.
5535
5536
5537
5538
5539
5540
5541 . ////////////////////////////////////////////////////////////////////////////
5542 . ////////////////////////////////////////////////////////////////////////////
5543
5544 .chapter "The default configuration file" "CHAPdefconfil"
5545 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5546 .cindex "default" "configuration file &""walk through""&"
5547 The default configuration file supplied with Exim as &_src/configure.default_&
5548 is sufficient for a host with simple mail requirements. As an introduction to
5549 the way Exim is configured, this chapter &"walks through"& the default
5550 configuration, giving brief explanations of the settings. Detailed descriptions
5551 of the options are given in subsequent chapters. The default configuration file
5552 itself contains extensive comments about ways you might want to modify the
5553 initial settings. However, note that there are many options that are not
5554 mentioned at all in the default configuration.
5555
5556
5557
5558 .section "Macros" "SECTdefconfmacros"
5559 All macros should be defined before any options.
5560
5561 One macro is specified, but commented out, in the default configuration:
5562 .code
5563 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5564 .endd
5565 If all off-site mail is expected to be delivered to a "smarthost", then set the
5566 hostname here and uncomment the macro.  This will affect which router is used
5567 later on.  If this is left commented out, then Exim will perform direct-to-MX
5568 deliveries using a &(dnslookup)& router.
5569
5570 In addition to macros defined here, Exim includes a number of built-in macros
5571 to enable configuration to be guarded by a binary built with support for a
5572 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5573
5574
5575 .section "Main configuration settings" "SECTdefconfmain"
5576 The main (global) configuration option settings section must always come first
5577 in the file, after the macros.
5578 The first thing you'll see in the file, after some initial comments, is the line
5579 .code
5580 # primary_hostname =
5581 .endd
5582 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5583 to know the official, fully qualified name of your host, and this is where you
5584 can specify it. However, in most cases you do not need to set this option. When
5585 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5586
5587 The first three non-comment configuration lines are as follows:
5588 .code
5589 domainlist local_domains    = @
5590 domainlist relay_to_domains =
5591 hostlist   relay_from_hosts = 127.0.0.1
5592 .endd
5593 These are not, in fact, option settings. They are definitions of two named
5594 domain lists and one named host list. Exim allows you to give names to lists of
5595 domains, hosts, and email addresses, in order to make it easier to manage the
5596 configuration file (see section &<<SECTnamedlists>>&).
5597
5598 The first line defines a domain list called &'local_domains'&; this is used
5599 later in the configuration to identify domains that are to be delivered
5600 on the local host.
5601
5602 .cindex "@ in a domain list"
5603 There is just one item in this list, the string &"@"&. This is a special form
5604 of entry which means &"the name of the local host"&. Thus, if the local host is
5605 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5606 be delivered locally. Because the local host's name is referenced indirectly,
5607 the same configuration file can be used on different hosts.
5608
5609 The second line defines a domain list called &'relay_to_domains'&, but the
5610 list itself is empty. Later in the configuration we will come to the part that
5611 controls mail relaying through the local host; it allows relaying to any
5612 domains in this list. By default, therefore, no relaying on the basis of a mail
5613 domain is permitted.
5614
5615 The third line defines a host list called &'relay_from_hosts'&. This list is
5616 used later in the configuration to permit relaying from any host or IP address
5617 that matches the list. The default contains just the IP address of the IPv4
5618 loopback interface, which means that processes on the local host are able to
5619 submit mail for relaying by sending it over TCP/IP to that interface. No other
5620 hosts are permitted to submit messages for relaying.
5621
5622 Just to be sure there's no misunderstanding: at this point in the configuration
5623 we aren't actually setting up any controls. We are just defining some domains
5624 and hosts that will be used in the controls that are specified later.
5625
5626 The next two configuration lines are genuine option settings:
5627 .code
5628 acl_smtp_rcpt = acl_check_rcpt
5629 acl_smtp_data = acl_check_data
5630 .endd
5631 These options specify &'Access Control Lists'& (ACLs) that are to be used
5632 during an incoming SMTP session for every recipient of a message (every RCPT
5633 command), and after the contents of the message have been received,
5634 respectively. The names of the lists are &'acl_check_rcpt'& and
5635 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5636 section of the configuration. The RCPT ACL controls which recipients are
5637 accepted for an incoming message &-- if a configuration does not provide an ACL
5638 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5639 contents of a message to be checked.
5640
5641 Two commented-out option settings are next:
5642 .code
5643 # av_scanner = clamd:/tmp/clamd
5644 # spamd_address = 127.0.0.1 783
5645 .endd
5646 These are example settings that can be used when Exim is compiled with the
5647 content-scanning extension. The first specifies the interface to the virus
5648 scanner, and the second specifies the interface to SpamAssassin. Further
5649 details are given in chapter &<<CHAPexiscan>>&.
5650
5651 Three more commented-out option settings follow:
5652 .code
5653 # tls_advertise_hosts = *
5654 # tls_certificate = /etc/ssl/exim.crt
5655 # tls_privatekey = /etc/ssl/exim.pem
5656 .endd
5657 These are example settings that can be used when Exim is compiled with
5658 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5659 first one specifies the list of clients that are allowed to use TLS when
5660 connecting to this server; in this case, the wildcard means all clients. The
5661 other options specify where Exim should find its TLS certificate and private
5662 key, which together prove the server's identity to any clients that connect.
5663 More details are given in chapter &<<CHAPTLS>>&.
5664
5665 Another two commented-out option settings follow:
5666 .code
5667 # daemon_smtp_ports = 25 : 465 : 587
5668 # tls_on_connect_ports = 465
5669 .endd
5670 .cindex "port" "465 and 587"
5671 .cindex "port" "for message submission"
5672 .cindex "message" "submission, ports for"
5673 .cindex "submissions protocol"
5674 .cindex "smtps protocol"
5675 .cindex "ssmtp protocol"
5676 .cindex "SMTP" "submissions protocol"
5677 .cindex "SMTP" "ssmtp protocol"
5678 .cindex "SMTP" "smtps protocol"
5679 These options provide better support for roaming users who wish to use this
5680 server for message submission. They are not much use unless you have turned on
5681 TLS (as described in the previous paragraph) and authentication (about which
5682 more in section &<<SECTdefconfauth>>&).
5683 Mail submission from mail clients (MUAs) should be separate from inbound mail
5684 to your domain (MX delivery) for various good reasons (eg, ability to impose
5685 much saner TLS protocol and ciphersuite requirements without unintended
5686 consequences).
5687 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5688 which uses STARTTLS, so this is the &"submission"& port.
5689 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5690 which should be used in preference to 587.
5691 You should also consider deploying SRV records to help clients find
5692 these ports.
5693 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5694
5695 Two more commented-out options settings follow:
5696 .code
5697 # qualify_domain =
5698 # qualify_recipient =
5699 .endd
5700 The first of these specifies a domain that Exim uses when it constructs a
5701 complete email address from a local login name. This is often needed when Exim
5702 receives a message from a local process. If you do not set &%qualify_domain%&,
5703 the value of &%primary_hostname%& is used. If you set both of these options,
5704 you can have different qualification domains for sender and recipient
5705 addresses. If you set only the first one, its value is used in both cases.
5706
5707 .cindex "domain literal" "recognizing format"
5708 The following line must be uncommented if you want Exim to recognize
5709 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5710 (an IP address within square brackets) instead of a named domain.
5711 .code
5712 # allow_domain_literals
5713 .endd
5714 The RFCs still require this form, but many people think that in the modern
5715 Internet it makes little sense to permit mail to be sent to specific hosts by
5716 quoting their IP addresses. This ancient format has been used by people who
5717 try to abuse hosts by using them for unwanted relaying. However, some
5718 people believe there are circumstances (for example, messages addressed to
5719 &'postmaster'&) where domain literals are still useful.
5720
5721 The next configuration line is a kind of trigger guard:
5722 .code
5723 never_users = root
5724 .endd
5725 It specifies that no delivery must ever be run as the root user. The normal
5726 convention is to set up &'root'& as an alias for the system administrator. This
5727 setting is a guard against slips in the configuration.
5728 The list of users specified by &%never_users%& is not, however, the complete
5729 list; the build-time configuration in &_Local/Makefile_& has an option called
5730 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5731 contents of &%never_users%& are added to this list. By default
5732 FIXED_NEVER_USERS also specifies root.
5733
5734 When a remote host connects to Exim in order to send mail, the only information
5735 Exim has about the host's identity is its IP address. The next configuration
5736 line,
5737 .code
5738 host_lookup = *
5739 .endd
5740 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5741 in order to get a host name. This improves the quality of the logging
5742 information, but if you feel it is too expensive, you can remove it entirely,
5743 or restrict the lookup to hosts on &"nearby"& networks.
5744 Note that it is not always possible to find a host name from an IP address,
5745 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5746 unreachable.
5747
5748 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5749 1413 (hence their names):
5750 .code
5751 rfc1413_hosts = *
5752 rfc1413_query_timeout = 0s
5753 .endd
5754 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5755 Few hosts offer RFC1413 service these days; calls have to be
5756 terminated by a timeout and this needlessly delays the startup
5757 of an incoming SMTP connection.
5758 If you have hosts for which you trust RFC1413 and need this
5759 information, you can change this.
5760
5761 This line enables an efficiency SMTP option.  It is negotiated by clients
5762 and not expected to cause problems but can be disabled if needed.
5763 .code
5764 prdr_enable = true
5765 .endd
5766
5767 When Exim receives messages over SMTP connections, it expects all addresses to
5768 be fully qualified with a domain, as required by the SMTP definition. However,
5769 if you are running a server to which simple clients submit messages, you may
5770 find that they send unqualified addresses. The two commented-out options:
5771 .code
5772 # sender_unqualified_hosts =
5773 # recipient_unqualified_hosts =
5774 .endd
5775 show how you can specify hosts that are permitted to send unqualified sender
5776 and recipient addresses, respectively.
5777
5778 The &%log_selector%& option is used to increase the detail of logging
5779 over the default:
5780 .code
5781 log_selector = +smtp_protocol_error +smtp_syntax_error \
5782                +tls_certificate_verified
5783 .endd
5784
5785 The &%percent_hack_domains%& option is also commented out:
5786 .code
5787 # percent_hack_domains =
5788 .endd
5789 It provides a list of domains for which the &"percent hack"& is to operate.
5790 This is an almost obsolete form of explicit email routing. If you do not know
5791 anything about it, you can safely ignore this topic.
5792
5793 The next two settings in the main part of the default configuration are
5794 concerned with messages that have been &"frozen"& on Exim's queue. When a
5795 message is frozen, Exim no longer continues to try to deliver it. Freezing
5796 occurs when a bounce message encounters a permanent failure because the sender
5797 address of the original message that caused the bounce is invalid, so the
5798 bounce cannot be delivered. This is probably the most common case, but there
5799 are also other conditions that cause freezing, and frozen messages are not
5800 always bounce messages.
5801 .code
5802 ignore_bounce_errors_after = 2d
5803 timeout_frozen_after = 7d
5804 .endd
5805 The first of these options specifies that failing bounce messages are to be
5806 discarded after 2 days in the queue. The second specifies that any frozen
5807 message (whether a bounce message or not) is to be timed out (and discarded)
5808 after a week. In this configuration, the first setting ensures that no failing
5809 bounce message ever lasts a week.
5810
5811 Exim queues it's messages in a spool directory. If you expect to have
5812 large queues, you may consider using this option. It splits the spool
5813 directory into subdirectories to avoid file system degradation from
5814 many files in a single directory, resulting in better performance.
5815 Manual manipulation of queued messages becomes more complex (though fortunately
5816 not often needed).
5817 .code
5818 # split_spool_directory = true
5819 .endd
5820
5821 In an ideal world everybody follows the standards. For non-ASCII
5822 messages RFC 2047 is a standard, allowing a maximum line length of 76
5823 characters. Exim adheres that standard and won't process messages which
5824 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5825 In particular, the Exim maintainers have had multiple reports of
5826 problems from Russian administrators of issues until they disable this
5827 check, because of some popular, yet buggy, mail composition software.
5828 .code
5829 # check_rfc2047_length = false
5830 .endd
5831
5832 If you need to be strictly RFC compliant you may wish to disable the
5833 8BITMIME advertisement. Use this, if you exchange mails with systems
5834 that are not 8-bit clean.
5835 .code
5836 # accept_8bitmime = false
5837 .endd
5838
5839 Libraries you use may depend on specific environment settings.  This
5840 imposes a security risk (e.g. PATH). There are two lists:
5841 &%keep_environment%& for the variables to import as they are, and
5842 &%add_environment%& for variables we want to set to a fixed value.
5843 Note that TZ is handled separately, by the $%timezone%$ runtime
5844 option and by the TIMEZONE_DEFAULT buildtime option.
5845 .code
5846 # keep_environment = ^LDAP
5847 # add_environment = PATH=/usr/bin::/bin
5848 .endd
5849
5850
5851 .section "ACL configuration" "SECID54"
5852 .cindex "default" "ACLs"
5853 .cindex "&ACL;" "default configuration"
5854 In the default configuration, the ACL section follows the main configuration.
5855 It starts with the line
5856 .code
5857 begin acl
5858 .endd
5859 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5860 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5861 and &%acl_smtp_data%& above.
5862
5863 .cindex "RCPT" "ACL for"
5864 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5865 RCPT command specifies one of the message's recipients. The ACL statements
5866 are considered in order, until the recipient address is either accepted or
5867 rejected. The RCPT command is then accepted or rejected, according to the
5868 result of the ACL processing.
5869 .code
5870 acl_check_rcpt:
5871 .endd
5872 This line, consisting of a name terminated by a colon, marks the start of the
5873 ACL, and names it.
5874 .code
5875 accept  hosts = :
5876 .endd
5877 This ACL statement accepts the recipient if the sending host matches the list.
5878 But what does that strange list mean? It doesn't actually contain any host
5879 names or IP addresses. The presence of the colon puts an empty item in the
5880 list; Exim matches this only if the incoming message did not come from a remote
5881 host, because in that case, the remote hostname is empty. The colon is
5882 important. Without it, the list itself is empty, and can never match anything.
5883
5884 What this statement is doing is to accept unconditionally all recipients in
5885 messages that are submitted by SMTP from local processes using the standard
5886 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5887 manner.
5888 .code
5889 deny    message       = Restricted characters in address
5890         domains       = +local_domains
5891         local_parts   = ^[.] : ^.*[@%!/|]
5892
5893 deny    message       = Restricted characters in address
5894         domains       = !+local_domains
5895         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5896 .endd
5897 These statements are concerned with local parts that contain any of the
5898 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5899 Although these characters are entirely legal in local parts (in the case of
5900 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5901 in Internet mail addresses.
5902
5903 The first three have in the past been associated with explicitly routed
5904 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5905 option). Addresses containing these characters are regularly tried by spammers
5906 in an attempt to bypass relaying restrictions, and also by open relay testing
5907 programs. Unless you really need them it is safest to reject these characters
5908 at this early stage. This configuration is heavy-handed in rejecting these
5909 characters for all messages it accepts from remote hosts. This is a deliberate
5910 policy of being as safe as possible.
5911
5912 The first rule above is stricter, and is applied to messages that are addressed
5913 to one of the local domains handled by this host. This is implemented by the
5914 first condition, which restricts it to domains that are listed in the
5915 &'local_domains'& domain list. The &"+"& character is used to indicate a
5916 reference to a named list. In this configuration, there is just one domain in
5917 &'local_domains'&, but in general there may be many.
5918
5919 The second condition on the first statement uses two regular expressions to
5920 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5921 or &"|"&. If you have local accounts that include these characters, you will
5922 have to modify this rule.
5923
5924 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5925 allows them because they have been encountered in practice. (Consider the
5926 common convention of local parts constructed as
5927 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5928 the author of Exim, who has no second initial.) However, a local part starting
5929 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5930 filename (for example, for a mailing list). This is also true for local parts
5931 that contain slashes. A pipe symbol can also be troublesome if the local part
5932 is incorporated unthinkingly into a shell command line.
5933
5934 The second rule above applies to all other domains, and is less strict. This
5935 allows your own users to send outgoing messages to sites that use slashes
5936 and vertical bars in their local parts. It blocks local parts that begin
5937 with a dot, slash, or vertical bar, but allows these characters within the
5938 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5939 and &"!"& is blocked, as before. The motivation here is to prevent your users
5940 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5941 .code
5942 accept  local_parts   = postmaster
5943         domains       = +local_domains
5944 .endd
5945 This statement, which has two conditions, accepts an incoming address if the
5946 local part is &'postmaster'& and the domain is one of those listed in the
5947 &'local_domains'& domain list. The &"+"& character is used to indicate a
5948 reference to a named list. In this configuration, there is just one domain in
5949 &'local_domains'&, but in general there may be many.
5950
5951 The presence of this statement means that mail to postmaster is never blocked
5952 by any of the subsequent tests. This can be helpful while sorting out problems
5953 in cases where the subsequent tests are incorrectly denying access.
5954 .code
5955 require verify        = sender
5956 .endd
5957 This statement requires the sender address to be verified before any subsequent
5958 ACL statement can be used. If verification fails, the incoming recipient
5959 address is refused. Verification consists of trying to route the address, to
5960 see if a bounce message could be delivered to it. In the case of remote
5961 addresses, basic verification checks only the domain, but &'callouts'& can be
5962 used for more verification if required. Section &<<SECTaddressverification>>&
5963 discusses the details of address verification.
5964 .code
5965 accept  hosts         = +relay_from_hosts
5966         control       = submission
5967 .endd
5968 This statement accepts the address if the message is coming from one of the
5969 hosts that are defined as being allowed to relay through this host. Recipient
5970 verification is omitted here, because in many cases the clients are dumb MUAs
5971 that do not cope well with SMTP error responses. For the same reason, the
5972 second line specifies &"submission mode"& for messages that are accepted. This
5973 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5974 messages that are deficient in some way, for example, because they lack a
5975 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5976 probably add recipient verification here, and disable submission mode.
5977 .code
5978 accept  authenticated = *
5979         control       = submission
5980 .endd
5981 This statement accepts the address if the client host has authenticated itself.
5982 Submission mode is again specified, on the grounds that such messages are most
5983 likely to come from MUAs. The default configuration does not define any
5984 authenticators, though it does include some nearly complete commented-out
5985 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5986 fact authenticate until you complete the authenticator definitions.
5987 .code
5988 require message = relay not permitted
5989         domains = +local_domains : +relay_to_domains
5990 .endd
5991 This statement rejects the address if its domain is neither a local domain nor
5992 one of the domains for which this host is a relay.
5993 .code
5994 require verify = recipient
5995 .endd
5996 This statement requires the recipient address to be verified; if verification
5997 fails, the address is rejected.
5998 .code
5999 # deny    message     = rejected because $sender_host_address \
6000 #                       is in a black list at $dnslist_domain\n\
6001 #                       $dnslist_text
6002 #         dnslists    = black.list.example
6003 #
6004 # warn    dnslists    = black.list.example
6005 #         add_header  = X-Warning: $sender_host_address is in \
6006 #                       a black list at $dnslist_domain
6007 #         log_message = found in $dnslist_domain
6008 .endd
6009 These commented-out lines are examples of how you could configure Exim to check
6010 sending hosts against a DNS black list. The first statement rejects messages
6011 from blacklisted hosts, whereas the second just inserts a warning header
6012 line.
6013 .code
6014 # require verify = csa
6015 .endd
6016 This commented-out line is an example of how you could turn on client SMTP
6017 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6018 records.
6019 .code
6020 accept
6021 .endd
6022 The final statement in the first ACL unconditionally accepts any recipient
6023 address that has successfully passed all the previous tests.
6024 .code
6025 acl_check_data:
6026 .endd
6027 This line marks the start of the second ACL, and names it. Most of the contents
6028 of this ACL are commented out:
6029 .code
6030 # deny    malware   = *
6031 #         message   = This message contains a virus \
6032 #                     ($malware_name).
6033 .endd
6034 These lines are examples of how to arrange for messages to be scanned for
6035 viruses when Exim has been compiled with the content-scanning extension, and a
6036 suitable virus scanner is installed. If the message is found to contain a
6037 virus, it is rejected with the given custom error message.
6038 .code
6039 # warn    spam      = nobody
6040 #         message   = X-Spam_score: $spam_score\n\
6041 #                     X-Spam_score_int: $spam_score_int\n\
6042 #                     X-Spam_bar: $spam_bar\n\
6043 #                     X-Spam_report: $spam_report
6044 .endd
6045 These lines are an example of how to arrange for messages to be scanned by
6046 SpamAssassin when Exim has been compiled with the content-scanning extension,
6047 and SpamAssassin has been installed. The SpamAssassin check is run with
6048 &`nobody`& as its user parameter, and the results are added to the message as a
6049 series of extra header line. In this case, the message is not rejected,
6050 whatever the spam score.
6051 .code
6052 accept
6053 .endd
6054 This final line in the DATA ACL accepts the message unconditionally.
6055
6056
6057 .section "Router configuration" "SECID55"
6058 .cindex "default" "routers"
6059 .cindex "routers" "default"
6060 The router configuration comes next in the default configuration, introduced
6061 by the line
6062 .code
6063 begin routers
6064 .endd
6065 Routers are the modules in Exim that make decisions about where to send
6066 messages. An address is passed to each router, in turn, until it is either
6067 accepted, or failed. This means that the order in which you define the routers
6068 matters. Each router is fully described in its own chapter later in this
6069 manual. Here we give only brief overviews.
6070 .code
6071 # domain_literal:
6072 #   driver = ipliteral
6073 #   domains = !+local_domains
6074 #   transport = remote_smtp
6075 .endd
6076 .cindex "domain literal" "default router"
6077 This router is commented out because the majority of sites do not want to
6078 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6079 you uncomment this router, you also need to uncomment the setting of
6080 &%allow_domain_literals%& in the main part of the configuration.
6081
6082 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6083 macro has been defined, per
6084 .code
6085 .ifdef ROUTER_SMARTHOST
6086 smarthost:
6087 #...
6088 .else
6089 dnslookup:
6090 #...
6091 .endif
6092 .endd
6093
6094 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6095 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6096 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6097 skip these routers because of the &%domains%& option.
6098
6099 .code
6100 smarthost:
6101   driver = manualroute
6102   domains = ! +local_domains
6103   transport = smarthost_smtp
6104   route_data = ROUTER_SMARTHOST
6105   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6106   no_more
6107 .endd
6108 This router only handles mail which is not to any local domains; this is
6109 specified by the line
6110 .code
6111 domains = ! +local_domains
6112 .endd
6113 The &%domains%& option lists the domains to which this router applies, but the
6114 exclamation mark is a negation sign, so the router is used only for domains
6115 that are not in the domain list called &'local_domains'& (which was defined at
6116 the start of the configuration). The plus sign before &'local_domains'&
6117 indicates that it is referring to a named list. Addresses in other domains are
6118 passed on to the following routers.
6119
6120 The name of the router driver is &(manualroute)& because we are manually
6121 specifying how mail should be routed onwards, instead of using DNS MX.
6122 While the name of this router instance is arbitrary, the &%driver%& option must
6123 be one of the driver modules that is in the Exim binary.
6124
6125 With no pre-conditions other than &%domains%&, all mail for non-local domains
6126 will be handled by this router, and the &%no_more%& setting will ensure that no
6127 other routers will be used for messages matching the pre-conditions.  See
6128 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6129 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6130 and the macro supplies the value; the address is then queued for the
6131 &(smarthost_smtp)& transport.
6132
6133 .code
6134 dnslookup:
6135   driver = dnslookup
6136   domains = ! +local_domains
6137   transport = remote_smtp
6138   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6139   no_more
6140 .endd
6141 The &%domains%& option behaves as per smarthost, above.
6142
6143 The name of the router driver is &(dnslookup)&,
6144 and is specified by the &%driver%& option. Do not be confused by the fact that
6145 the name of this router instance is the same as the name of the driver. The
6146 instance name is arbitrary, but the name set in the &%driver%& option must be
6147 one of the driver modules that is in the Exim binary.
6148
6149 The &(dnslookup)& router routes addresses by looking up their domains in the
6150 DNS in order to obtain a list of hosts to which the address is routed. If the
6151 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6152 specified by the &%transport%& option. If the router does not find the domain
6153 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6154 the address fails and is bounced.
6155
6156 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6157 be entirely ignored. This option is present because a number of cases have been
6158 encountered where MX records in the DNS point to host names
6159 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6160 Completely ignoring these IP addresses causes Exim to fail to route the
6161 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6162 continue to try to deliver the message periodically until the address timed
6163 out.
6164 .code
6165 system_aliases:
6166   driver = redirect
6167   allow_fail
6168   allow_defer
6169   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6170 # user = exim
6171   file_transport = address_file
6172   pipe_transport = address_pipe
6173 .endd
6174 Control reaches this and subsequent routers only for addresses in the local
6175 domains. This router checks to see whether the local part is defined as an
6176 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6177 data that it looks up from that file. If no data is found for the local part,
6178 the value of the &%data%& option is empty, causing the address to be passed to
6179 the next router.
6180
6181 &_/etc/aliases_& is a conventional name for the system aliases file that is
6182 often used. That is why it is referenced by from the default configuration
6183 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6184 &_Local/Makefile_& before building Exim.
6185 .code
6186 userforward:
6187   driver = redirect
6188   check_local_user
6189 # local_part_suffix = +* : -*
6190 # local_part_suffix_optional
6191   file = $home/.forward
6192 # allow_filter
6193   no_verify
6194   no_expn
6195   check_ancestor
6196   file_transport = address_file
6197   pipe_transport = address_pipe
6198   reply_transport = address_reply
6199 .endd
6200 This is the most complicated router in the default configuration. It is another
6201 redirection router, but this time it is looking for forwarding data set up by
6202 individual users. The &%check_local_user%& setting specifies a check that the
6203 local part of the address is the login name of a local user. If it is not, the
6204 router is skipped. The two commented options that follow &%check_local_user%&,
6205 namely:
6206 .code
6207 # local_part_suffix = +* : -*
6208 # local_part_suffix_optional
6209 .endd
6210 .vindex "&$local_part_suffix$&"
6211 show how you can specify the recognition of local part suffixes. If the first
6212 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6213 by any sequence of characters, is removed from the local part and placed in the
6214 variable &$local_part_suffix$&. The second suffix option specifies that the
6215 presence of a suffix in the local part is optional. When a suffix is present,
6216 the check for a local login uses the local part with the suffix removed.
6217
6218 When a local user account is found, the file called &_.forward_& in the user's
6219 home directory is consulted. If it does not exist, or is empty, the router
6220 declines. Otherwise, the contents of &_.forward_& are interpreted as
6221 redirection data (see chapter &<<CHAPredirect>>& for more details).
6222
6223 .cindex "Sieve filter" "enabling in default router"
6224 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6225 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6226 is commented out by default), the contents of the file are interpreted as a set
6227 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6228 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6229 separate document entitled &'Exim's interfaces to mail filtering'&.
6230
6231 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6232 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6233 There are two reasons for doing this:
6234
6235 .olist
6236 Whether or not a local user has a &_.forward_& file is not really relevant when
6237 checking an address for validity; it makes sense not to waste resources doing
6238 unnecessary work.
6239 .next
6240 More importantly, when Exim is verifying addresses or handling an EXPN
6241 command during an SMTP session, it is running as the Exim user, not as root.
6242 The group is the Exim group, and no additional groups are set up.
6243 It may therefore not be possible for Exim to read users' &_.forward_& files at
6244 this time.
6245 .endlist
6246
6247 The setting of &%check_ancestor%& prevents the router from generating a new
6248 address that is the same as any previous address that was redirected. (This
6249 works round a problem concerning a bad interaction between aliasing and
6250 forwarding &-- see section &<<SECTredlocmai>>&).
6251
6252 The final three option settings specify the transports that are to be used when
6253 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6254 auto-reply, respectively. For example, if a &_.forward_& file contains
6255 .code
6256 a.nother@elsewhere.example, /home/spqr/archive
6257 .endd
6258 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6259 transport.
6260 .code
6261 localuser:
6262   driver = accept
6263   check_local_user
6264 # local_part_suffix = +* : -*
6265 # local_part_suffix_optional
6266   transport = local_delivery
6267 .endd
6268 The final router sets up delivery into local mailboxes, provided that the local
6269 part is the name of a local login, by accepting the address and assigning it to
6270 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6271 routers, so the address is bounced. The commented suffix settings fulfil the
6272 same purpose as they do for the &(userforward)& router.
6273
6274
6275 .section "Transport configuration" "SECID56"
6276 .cindex "default" "transports"
6277 .cindex "transports" "default"
6278 Transports define mechanisms for actually delivering messages. They operate
6279 only when referenced from routers, so the order in which they are defined does
6280 not matter. The transports section of the configuration starts with
6281 .code
6282 begin transports
6283 .endd
6284 Two remote transports and four local transports are defined.
6285 .code
6286 remote_smtp:
6287   driver = smtp
6288   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6289 .ifdef _HAVE_PRDR
6290   hosts_try_prdr = *
6291 .endif
6292 .endd
6293 This transport is used for delivering messages over SMTP connections.
6294 The list of remote hosts comes from the router.
6295 The &%message_size_limit%& usage is a hack to avoid sending on messages
6296 with over-long lines.
6297
6298 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6299 negotiated between client and server and not expected to cause problems
6300 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6301 use of the &%hosts_try_prdr%& configuration option.
6302
6303 The other remote transport is used when delivering to a specific smarthost
6304 with whom there must be some kind of existing relationship, instead of the
6305 usual federated system.
6306
6307 .code
6308 smarthost_smtp:
6309   driver = smtp
6310   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6311   multi_domain
6312   #
6313 .ifdef _HAVE_TLS
6314   # Comment out any of these which you have to, then file a Support
6315   # request with your smarthost provider to get things fixed:
6316   hosts_require_tls = *
6317   tls_verify_hosts = *
6318   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6319   # have to comment it out then this will at least log whether you succeed
6320   # or not:
6321   tls_try_verify_hosts = *
6322   #
6323   # The SNI name should match the name which we'll expect to verify;
6324   # many mail systems don't use SNI and this doesn't matter, but if it does,
6325   # we need to send a name which the remote site will recognize.
6326   # This _should_ be the name which the smarthost operators specified as
6327   # the hostname for sending your mail to.
6328   tls_sni = ROUTER_SMARTHOST
6329   #
6330 .ifdef _HAVE_OPENSSL
6331   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6332 .endif
6333 .ifdef _HAVE_GNUTLS
6334   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6335 .endif
6336 .endif
6337 .ifdef _HAVE_PRDR
6338   hosts_try_prdr = *
6339 .endif
6340 .endd
6341 After the same &%message_size_limit%& hack, we then specify that this Transport
6342 can handle messages to multiple domains in one run.  The assumption here is
6343 that you're routing all non-local mail to the same place and that place is
6344 happy to take all messages from you as quickly as possible.
6345 All other options depend upon built-in macros; if Exim was built without TLS support
6346 then no other options are defined.
6347 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6348 and versions using the &%tls_require_ciphers%& option, where the value to be
6349 used depends upon the library providing TLS.
6350 Beyond that, the options adopt the stance that you should have TLS support available
6351 from your smarthost on today's Internet, so we turn on requiring TLS for the
6352 mail to be delivered, and requiring that the certificate be valid, and match
6353 the expected hostname.  The &%tls_sni%& option can be used by service providers
6354 to select an appropriate certificate to present to you and here we re-use the
6355 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6356 You want to specify the hostname which you'll expect to validate for, and that
6357 should not be subject to insecure tampering via DNS results.
6358
6359 For the &%hosts_try_prdr%& option see the previous transport.
6360
6361 All other options are defaulted.
6362 .code
6363 local_delivery:
6364   driver = appendfile
6365   file = /var/mail/$local_part_verified
6366   delivery_date_add
6367   envelope_to_add
6368   return_path_add
6369 # group = mail
6370 # mode = 0660
6371 .endd
6372 This &(appendfile)& transport is used for local delivery to user mailboxes in
6373 traditional BSD mailbox format.
6374
6375 .new
6376 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6377 as it is provided by a potential bad actor.
6378 Instead we use &$local_part_verified$&,
6379 the result of looking up &$local_part$& in the user database
6380 (done by using &%check_local_user%& in the the router).
6381 .wen
6382
6383 By default &(appendfile)& runs under the uid and gid of the
6384 local user, which requires the sticky bit to be set on the &_/var/mail_&
6385 directory. Some systems use the alternative approach of running mail deliveries
6386 under a particular group instead of using the sticky bit. The commented options
6387 show how this can be done.
6388
6389 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6390 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6391 similarly-named options above.
6392 .code
6393 address_pipe:
6394   driver = pipe
6395   return_output
6396 .endd
6397 This transport is used for handling deliveries to pipes that are generated by
6398 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6399 option specifies that any output on stdout or stderr generated by the pipe is to
6400 be returned to the sender.
6401 .code
6402 address_file:
6403   driver = appendfile
6404   delivery_date_add
6405   envelope_to_add
6406   return_path_add
6407 .endd
6408 This transport is used for handling deliveries to files that are generated by
6409 redirection. The name of the file is not specified in this instance of
6410 &(appendfile)&, because it comes from the &(redirect)& router.
6411 .code
6412 address_reply:
6413   driver = autoreply
6414 .endd
6415 This transport is used for handling automatic replies generated by users'
6416 filter files.
6417
6418
6419
6420 .section "Default retry rule" "SECID57"
6421 .cindex "retry" "default rule"
6422 .cindex "default" "retry rule"
6423 The retry section of the configuration file contains rules which affect the way
6424 Exim retries deliveries that cannot be completed at the first attempt. It is
6425 introduced by the line
6426 .code
6427 begin retry
6428 .endd
6429 In the default configuration, there is just one rule, which applies to all
6430 errors:
6431 .code
6432 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6433 .endd
6434 This causes any temporarily failing address to be retried every 15 minutes for
6435 2 hours, then at intervals starting at one hour and increasing by a factor of
6436 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6437 is not delivered after 4 days of temporary failure, it is bounced. The time is
6438 measured from first failure, not from the time the message was received.
6439
6440 If the retry section is removed from the configuration, or is empty (that is,
6441 if no retry rules are defined), Exim will not retry deliveries. This turns
6442 temporary errors into permanent errors.
6443
6444
6445 .section "Rewriting configuration" "SECID58"
6446 The rewriting section of the configuration, introduced by
6447 .code
6448 begin rewrite
6449 .endd
6450 contains rules for rewriting addresses in messages as they arrive. There are no
6451 rewriting rules in the default configuration file.
6452
6453
6454
6455 .section "Authenticators configuration" "SECTdefconfauth"
6456 .cindex "AUTH" "configuration"
6457 The authenticators section of the configuration, introduced by
6458 .code
6459 begin authenticators
6460 .endd
6461 defines mechanisms for the use of the SMTP AUTH command. The default
6462 configuration file contains two commented-out example authenticators
6463 which support plaintext username/password authentication using the
6464 standard PLAIN mechanism and the traditional but non-standard LOGIN
6465 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6466 to support most MUA software.
6467
6468 The example PLAIN authenticator looks like this:
6469 .code
6470 #PLAIN:
6471 #  driver                  = plaintext
6472 #  server_set_id           = $auth2
6473 #  server_prompts          = :
6474 #  server_condition        = Authentication is not yet configured
6475 #  server_advertise_condition = ${if def:tls_in_cipher }
6476 .endd
6477 And the example LOGIN authenticator looks like this:
6478 .code
6479 #LOGIN:
6480 #  driver                  = plaintext
6481 #  server_set_id           = $auth1
6482 #  server_prompts          = <| Username: | Password:
6483 #  server_condition        = Authentication is not yet configured
6484 #  server_advertise_condition = ${if def:tls_in_cipher }
6485 .endd
6486
6487 The &%server_set_id%& option makes Exim remember the authenticated username
6488 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6489 &%server_prompts%& option configures the &(plaintext)& authenticator so
6490 that it implements the details of the specific authentication mechanism,
6491 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6492 when Exim offers authentication to clients; in the examples, this is only
6493 when TLS or SSL has been started, so to enable the authenticators you also
6494 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6495
6496 The &%server_condition%& setting defines how to verify that the username and
6497 password are correct. In the examples it just produces an error message.
6498 To make the authenticators work, you can use a string expansion
6499 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6500
6501 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6502 usercode and password are in different positions.
6503 Chapter &<<CHAPplaintext>>& covers both.
6504
6505 .ecindex IIDconfiwal
6506
6507
6508
6509 . ////////////////////////////////////////////////////////////////////////////
6510 . ////////////////////////////////////////////////////////////////////////////
6511
6512 .chapter "Regular expressions" "CHAPregexp"
6513
6514 .cindex "regular expressions" "library"
6515 .cindex "PCRE"
6516 Exim supports the use of regular expressions in many of its options. It
6517 uses the PCRE regular expression library; this provides regular expression
6518 matching that is compatible with Perl 5. The syntax and semantics of
6519 regular expressions is discussed in
6520 online Perl manpages, in
6521 many Perl reference books, and also in
6522 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6523 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6524 . --- the http: URL here redirects to another page with the ISBN in the URL
6525 . --- where trying to use https: just redirects back to http:, so sticking
6526 . --- to the old URL for now.  2018-09-07.
6527
6528 The documentation for the syntax and semantics of the regular expressions that
6529 are supported by PCRE is included in the PCRE distribution, and no further
6530 description is included here. The PCRE functions are called from Exim using
6531 the default option settings (that is, with no PCRE options set), except that
6532 the PCRE_CASELESS option is set when the matching is required to be
6533 case-insensitive.
6534
6535 In most cases, when a regular expression is required in an Exim configuration,
6536 it has to start with a circumflex, in order to distinguish it from plain text
6537 or an &"ends with"& wildcard. In this example of a configuration setting, the
6538 second item in the colon-separated list is a regular expression.
6539 .code
6540 domains = a.b.c : ^\\d{3} : *.y.z : ...
6541 .endd
6542 The doubling of the backslash is required because of string expansion that
6543 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6544 of this issue, and a way of avoiding the need for doubling backslashes. The
6545 regular expression that is eventually used in this example contains just one
6546 backslash. The circumflex is included in the regular expression, and has the
6547 normal effect of &"anchoring"& it to the start of the string that is being
6548 matched.
6549
6550 There are, however, two cases where a circumflex is not required for the
6551 recognition of a regular expression: these are the &%match%& condition in a
6552 string expansion, and the &%matches%& condition in an Exim filter file. In
6553 these cases, the relevant string is always treated as a regular expression; if
6554 it does not start with a circumflex, the expression is not anchored, and can
6555 match anywhere in the subject string.
6556
6557 In all cases, if you want a regular expression to match at the end of a string,
6558 you must code the $ metacharacter to indicate this. For example:
6559 .code
6560 domains = ^\\d{3}\\.example
6561 .endd
6562 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6563 You need to use:
6564 .code
6565 domains = ^\\d{3}\\.example\$
6566 .endd
6567 if you want &'example'& to be the top-level domain. The backslash before the
6568 $ is needed because string expansion also interprets dollar characters.
6569
6570
6571
6572 . ////////////////////////////////////////////////////////////////////////////
6573 . ////////////////////////////////////////////////////////////////////////////
6574
6575 .chapter "File and database lookups" "CHAPfdlookup"
6576 .scindex IIDfidalo1 "file" "lookups"
6577 .scindex IIDfidalo2 "database" "lookups"
6578 .cindex "lookup" "description of"
6579 Exim can be configured to look up data in files or databases as it processes
6580 messages. Two different kinds of syntax are used:
6581
6582 .olist
6583 A string that is to be expanded may contain explicit lookup requests. These
6584 cause parts of the string to be replaced by data that is obtained from the
6585 lookup. Lookups of this type are conditional expansion items. Different results
6586 can be defined for the cases of lookup success and failure. See chapter
6587 &<<CHAPexpand>>&, where string expansions are described in detail.
6588 The key for the lookup is specified as part of the string expansion.
6589 .next
6590 Lists of domains, hosts, and email addresses can contain lookup requests as a
6591 way of avoiding excessively long linear lists. In this case, the data that is
6592 returned by the lookup is often (but not always) discarded; whether the lookup
6593 succeeds or fails is what really counts. These kinds of list are described in
6594 chapter &<<CHAPdomhosaddlists>>&.
6595 The key for the lookup is given by the context in which the list is expanded.
6596 .endlist
6597
6598 String expansions, lists, and lookups interact with each other in such a way
6599 that there is no order in which to describe any one of them that does not
6600 involve references to the others. Each of these three chapters makes more sense
6601 if you have read the other two first. If you are reading this for the first
6602 time, be aware that some of it will make a lot more sense after you have read
6603 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6604
6605 .section "Examples of different lookup syntax" "SECID60"
6606 It is easy to confuse the two different kinds of lookup, especially as the
6607 lists that may contain the second kind are always expanded before being
6608 processed as lists. Therefore, they may also contain lookups of the first kind.
6609 Be careful to distinguish between the following two examples:
6610 .code
6611 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6612 domains = lsearch;/some/file
6613 .endd
6614 The first uses a string expansion, the result of which must be a domain list.
6615 No strings have been specified for a successful or a failing lookup; the
6616 defaults in this case are the looked-up data and an empty string, respectively.
6617 The expansion takes place before the string is processed as a list, and the
6618 file that is searched could contain lines like this:
6619 .code
6620 192.168.3.4: domain1:domain2:...
6621 192.168.1.9: domain3:domain4:...
6622 .endd
6623 When the lookup succeeds, the result of the expansion is a list of domains (and
6624 possibly other types of item that are allowed in domain lists).
6625
6626 In the second example, the lookup is a single item in a domain list. It causes
6627 Exim to use a lookup to see if the domain that is being processed can be found
6628 in the file. The file could contains lines like this:
6629 .code
6630 domain1:
6631 domain2:
6632 .endd
6633 Any data that follows the keys is not relevant when checking that the domain
6634 matches the list item.
6635
6636 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6637 Consider a file containing lines like this:
6638 .code
6639 192.168.5.6: lsearch;/another/file
6640 .endd
6641 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6642 first &%domains%& setting above generates the second setting, which therefore
6643 causes a second lookup to occur.
6644
6645 The rest of this chapter describes the different lookup types that are
6646 available. Any of them can be used in any part of the configuration where a
6647 lookup is permitted.
6648
6649
6650 .section "Lookup types" "SECID61"
6651 .cindex "lookup" "types of"
6652 .cindex "single-key lookup" "definition of"
6653 Two different types of data lookup are implemented:
6654
6655 .ilist
6656 The &'single-key'& type requires the specification of a file in which to look,
6657 and a single key to search for. The key must be a non-empty string for the
6658 lookup to succeed. The lookup type determines how the file is searched.
6659 .next
6660 .cindex "query-style lookup" "definition of"
6661 The &'query-style'& type accepts a generalized database query. No particular
6662 key value is assumed by Exim for query-style lookups. You can use whichever
6663 Exim variables you need to construct the database query.
6664 .endlist
6665
6666 The code for each lookup type is in a separate source file that is included in
6667 the binary of Exim only if the corresponding compile-time option is set. The
6668 default settings in &_src/EDITME_& are:
6669 .code
6670 LOOKUP_DBM=yes
6671 LOOKUP_LSEARCH=yes
6672 .endd
6673 which means that only linear searching and DBM lookups are included by default.
6674 For some types of lookup (e.g. SQL databases), you need to install appropriate
6675 libraries and header files before building Exim.
6676
6677
6678
6679
6680 .section "Single-key lookup types" "SECTsinglekeylookups"
6681 .cindex "lookup" "single-key types"
6682 .cindex "single-key lookup" "list of types"
6683 The following single-key lookup types are implemented:
6684
6685 .ilist
6686 .cindex "cdb" "description of"
6687 .cindex "lookup" "cdb"
6688 .cindex "binary zero" "in lookup key"
6689 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6690 string without a terminating binary zero. The cdb format is designed for
6691 indexed files that are read frequently and never updated, except by total
6692 re-creation. As such, it is particularly suitable for large files containing
6693 aliases or other indexed data referenced by an MTA. Information about cdb and
6694 tools for building the files can be found in several places:
6695 .display
6696 &url(https://cr.yp.to/cdb.html)
6697 &url(https://www.corpit.ru/mjt/tinycdb.html)
6698 &url(https://packages.debian.org/stable/utils/freecdb)
6699 &url(https://github.com/philpennock/cdbtools) (in Go)
6700 .endd
6701 A cdb distribution is not needed in order to build Exim with cdb support,
6702 because the code for reading cdb files is included directly in Exim itself.
6703 However, no means of building or testing cdb files is provided with Exim, so
6704 you need to obtain a cdb distribution in order to do this.
6705 .next
6706 .cindex "DBM" "lookup type"
6707 .cindex "lookup" "dbm"
6708 .cindex "binary zero" "in lookup key"
6709 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6710 DBM file by looking up the record with the given key. A terminating binary
6711 zero is included in the key that is passed to the DBM library. See section
6712 &<<SECTdb>>& for a discussion of DBM libraries.
6713
6714 .cindex "Berkeley DB library" "file format"
6715 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6716 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6717 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6718 the DB_UNKNOWN option. This enables it to handle any of the types of database
6719 that the library supports, and can be useful for accessing DBM files created by
6720 other applications. (For earlier DB versions, DB_HASH is always used.)
6721 .next
6722 .cindex "lookup" "dbmjz"
6723 .cindex "lookup" "dbm &-- embedded NULs"
6724 .cindex "sasldb2"
6725 .cindex "dbmjz lookup type"
6726 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6727 interpreted as an Exim list; the elements of the list are joined together with
6728 ASCII NUL characters to form the lookup key.  An example usage would be to
6729 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6730 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6731 &(cram_md5)& authenticator.
6732 .next
6733 .cindex "lookup" "dbmnz"
6734 .cindex "lookup" "dbm &-- terminating zero"
6735 .cindex "binary zero" "in lookup key"
6736 .cindex "Courier"
6737 .cindex "&_/etc/userdbshadow.dat_&"
6738 .cindex "dbmnz lookup type"
6739 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6740 is not included in the key that is passed to the DBM library. You may need this
6741 if you want to look up data in files that are created by or shared with some
6742 other application that does not use terminating zeros. For example, you need to
6743 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6744 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6745 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6746 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6747 .next
6748 .cindex "lookup" "dsearch"
6749 .cindex "dsearch lookup type"
6750 &(dsearch)&: The given file must be a directory; this is searched for an entry
6751 whose name is the key by calling the &[lstat()]& function. The key may not
6752 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6753 the lookup is the name of the entry, which may be a file, directory,
6754 symbolic link, or any other kind of directory entry. An example of how this
6755 lookup can be used to support virtual domains is given in section
6756 &<<SECTvirtualdomains>>&.
6757 .next
6758 .cindex "lookup" "iplsearch"
6759 .cindex "iplsearch lookup type"
6760 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6761 terminated by a colon or white space or the end of the line. The keys in the
6762 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6763 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6764 being interpreted as a key terminator. For example:
6765 .code
6766 1.2.3.4:           data for 1.2.3.4
6767 192.168.0.0/16:    data for 192.168.0.0/16
6768 "abcd::cdab":      data for abcd::cdab
6769 "abcd:abcd::/32"   data for abcd:abcd::/32
6770 .endd
6771 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6772 file is searched linearly, using the CIDR masks where present, until a matching
6773 key is found. The first key that matches is used; there is no attempt to find a
6774 &"best"& match. Apart from the way the keys are matched, the processing for
6775 &(iplsearch)& is the same as for &(lsearch)&.
6776
6777 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6778 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6779 lookup types support only literal keys.
6780
6781 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6782 the implicit key is the host's IP address rather than its name (see section
6783 &<<SECThoslispatsikey>>&).
6784
6785 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6786 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6787 notation before executing the lookup.)
6788 .next
6789 .cindex lookup json
6790 .cindex json "lookup type"
6791 .cindex JSON expansions
6792 &(json)&: The given file is a text file with a JSON structure.
6793 An element of the structure is extracted, defined by the search key.
6794 The key is a list of subelement selectors
6795 (colon-separated by default but changeable in the usual way)
6796 which are applied in turn to select smaller and smaller portions
6797 of the JSON structure.
6798 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6799 nunbered array element is selected.
6800 Otherwise it must apply to a JSON object; the named element is selected.
6801 The final resulting element can be a simple JSON type or a JSON object
6802 or array; for the latter two a string-representation os the JSON
6803 is returned.
6804 For elements of type string, the returned value is de-quoted.
6805 .next
6806 .cindex "linear search"
6807 .cindex "lookup" "lsearch"
6808 .cindex "lsearch lookup type"
6809 .cindex "case sensitivity" "in lsearch lookup"
6810 &(lsearch)&: The given file is a text file that is searched linearly for a
6811 line beginning with the search key, terminated by a colon or white space or the
6812 end of the line. The search is case-insensitive; that is, upper and lower case
6813 letters are treated as the same. The first occurrence of the key that is found
6814 in the file is used.
6815
6816 White space between the key and the colon is permitted. The remainder of the
6817 line, with leading and trailing white space removed, is the data. This can be
6818 continued onto subsequent lines by starting them with any amount of white
6819 space, but only a single space character is included in the data at such a
6820 junction. If the data begins with a colon, the key must be terminated by a
6821 colon, for example:
6822 .code
6823 baduser:  :fail:
6824 .endd
6825 Empty lines and lines beginning with # are ignored, even if they occur in the
6826 middle of an item. This is the traditional textual format of alias files. Note
6827 that the keys in an &(lsearch)& file are literal strings. There is no
6828 wildcarding of any kind.
6829
6830 .cindex "lookup" "lsearch &-- colons in keys"
6831 .cindex "white space" "in lsearch key"
6832 In most &(lsearch)& files, keys are not required to contain colons or #
6833 characters, or white space. However, if you need this feature, it is available.
6834 If a key begins with a doublequote character, it is terminated only by a
6835 matching quote (or end of line), and the normal escaping rules apply to its
6836 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6837 quoted keys (exactly as for unquoted keys). There is no special handling of
6838 quotes for the data part of an &(lsearch)& line.
6839
6840 .next
6841 .cindex "NIS lookup type"
6842 .cindex "lookup" "NIS"
6843 .cindex "binary zero" "in lookup key"
6844 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6845 the given key, without a terminating binary zero. There is a variant called
6846 &(nis0)& which does include the terminating binary zero in the key. This is
6847 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6848 aliases; the full map names must be used.
6849
6850 .next
6851 .cindex "wildlsearch lookup type"
6852 .cindex "lookup" "wildlsearch"
6853 .cindex "nwildlsearch lookup type"
6854 .cindex "lookup" "nwildlsearch"
6855 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6856 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6857 the file may be wildcarded. The difference between these two lookup types is
6858 that for &(wildlsearch)&, each key in the file is string-expanded before being
6859 used, whereas for &(nwildlsearch)&, no expansion takes place.
6860
6861 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6862 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6863 file that are regular expressions can be made case-sensitive by the use of
6864 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6865
6866 . ==== As this is a nested list, any displays it contains must be indented
6867 . ==== as otherwise they are too far to the left.
6868
6869 .olist
6870 The string may begin with an asterisk to mean &"ends with"&. For example:
6871 .code
6872     *.a.b.c       data for anything.a.b.c
6873     *fish         data for anythingfish
6874 .endd
6875 .next
6876 The string may begin with a circumflex to indicate a regular expression. For
6877 example, for &(wildlsearch)&:
6878 .code
6879     ^\N\d+\.a\.b\N    data for <digits>.a.b
6880 .endd
6881 Note the use of &`\N`& to disable expansion of the contents of the regular
6882 expression. If you are using &(nwildlsearch)&, where the keys are not
6883 string-expanded, the equivalent entry is:
6884 .code
6885     ^\d+\.a\.b        data for <digits>.a.b
6886 .endd
6887 The case-insensitive flag is set at the start of compiling the regular
6888 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6889 For example, to make the entire pattern case-sensitive:
6890 .code
6891     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6892 .endd
6893
6894 If the regular expression contains white space or colon characters, you must
6895 either quote it (see &(lsearch)& above), or represent these characters in other
6896 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6897 colon. This may be easier than quoting, because if you quote, you have to
6898 escape all the backslashes inside the quotes.
6899
6900 &*Note*&: It is not possible to capture substrings in a regular expression
6901 match for later use, because the results of all lookups are cached. If a lookup
6902 is repeated, the result is taken from the cache, and no actual pattern matching
6903 takes place. The values of all the numeric variables are unset after a
6904 &((n)wildlsearch)& match.
6905
6906 .next
6907 Although I cannot see it being of much use, the general matching function that
6908 is used to implement &((n)wildlsearch)& means that the string may begin with a
6909 lookup name terminated by a semicolon, and followed by lookup data. For
6910 example:
6911 .code
6912     cdb;/some/file  data for keys that match the file
6913 .endd
6914 The data that is obtained from the nested lookup is discarded.
6915 .endlist olist
6916
6917 Keys that do not match any of these patterns are interpreted literally. The
6918 continuation rules for the data are the same as for &(lsearch)&, and keys may
6919 be followed by optional colons.
6920
6921 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6922 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6923 lookup types support only literal keys.
6924
6925 .next
6926 .cindex "lookup" "spf"
6927 If Exim is built with SPF support, manual lookups can be done
6928 (as opposed to the standard ACL condition method.
6929 For details see section &<<SECSPF>>&.
6930 .endlist ilist
6931
6932
6933 .section "Query-style lookup types" "SECTquerystylelookups"
6934 .cindex "lookup" "query-style types"
6935 .cindex "query-style lookup" "list of types"
6936 The supported query-style lookup types are listed below. Further details about
6937 many of them are given in later sections.
6938
6939 .ilist
6940 .cindex "DNS" "as a lookup type"
6941 .cindex "lookup" "DNS"
6942 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6943 are given in the supplied query. The resulting data is the contents of the
6944 records. See section &<<SECTdnsdb>>&.
6945 .next
6946 .cindex "InterBase lookup type"
6947 .cindex "lookup" "InterBase"
6948 &(ibase)&: This does a lookup in an InterBase database.
6949 .next
6950 .cindex "LDAP" "lookup type"
6951 .cindex "lookup" "LDAP"
6952 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6953 returns attributes from a single entry. There is a variant called &(ldapm)&
6954 that permits values from multiple entries to be returned. A third variant
6955 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6956 any attribute values. See section &<<SECTldap>>&.
6957 .next
6958 .cindex "MySQL" "lookup type"
6959 .cindex "lookup" "MySQL"
6960 &(mysql)&: The format of the query is an SQL statement that is passed to a
6961 MySQL database. See section &<<SECTsql>>&.
6962 .next
6963 .cindex "NIS+ lookup type"
6964 .cindex "lookup" "NIS+"
6965 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6966 the field to be returned. See section &<<SECTnisplus>>&.
6967 .next
6968 .cindex "Oracle" "lookup type"
6969 .cindex "lookup" "Oracle"
6970 &(oracle)&: The format of the query is an SQL statement that is passed to an
6971 Oracle database. See section &<<SECTsql>>&.
6972 .next
6973 .cindex "lookup" "passwd"
6974 .cindex "passwd lookup type"
6975 .cindex "&_/etc/passwd_&"
6976 &(passwd)& is a query-style lookup with queries that are just user names. The
6977 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6978 success, the result string is the same as you would get from an &(lsearch)&
6979 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6980 password value. For example:
6981 .code
6982 *:42:42:King Rat:/home/kr:/bin/bash
6983 .endd
6984 .next
6985 .cindex "PostgreSQL lookup type"
6986 .cindex "lookup" "PostgreSQL"
6987 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6988 PostgreSQL database. See section &<<SECTsql>>&.
6989
6990 .next
6991 .cindex "Redis lookup type"
6992 .cindex lookup Redis
6993 &(redis)&: The format of the query is either a simple get or simple set,
6994 passed to a Redis database. See section &<<SECTsql>>&.
6995
6996 .next
6997 .cindex "sqlite lookup type"
6998 .cindex "lookup" "sqlite"
6999 &(sqlite)&: The format of the query is a filename followed by an SQL statement
7000 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7001
7002 .next
7003 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7004 not likely to be useful in normal operation.
7005 .next
7006 .cindex "whoson lookup type"
7007 .cindex "lookup" "whoson"
7008 . --- still http:-only, 2018-09-07
7009 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7010 allows a server to check whether a particular (dynamically allocated) IP
7011 address is currently allocated to a known (trusted) user and, optionally, to
7012 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7013 at one time for &"POP before SMTP"& authentication, but that approach has been
7014 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7015 &"POP before SMTP"& checking using ACL statements such as
7016 .code
7017 require condition = \
7018   ${lookup whoson {$sender_host_address}{yes}{no}}
7019 .endd
7020 The query consists of a single IP address. The value returned is the name of
7021 the authenticated user, which is stored in the variable &$value$&. However, in
7022 this example, the data in &$value$& is not used; the result of the lookup is
7023 one of the fixed strings &"yes"& or &"no"&.
7024 .endlist
7025
7026
7027
7028 .section "Temporary errors in lookups" "SECID63"
7029 .cindex "lookup" "temporary error in"
7030 Lookup functions can return temporary error codes if the lookup cannot be
7031 completed. For example, an SQL or LDAP database might be unavailable. For this
7032 reason, it is not advisable to use a lookup that might do this for critical
7033 options such as a list of local domains.
7034
7035 When a lookup cannot be completed in a router or transport, delivery
7036 of the message (to the relevant address) is deferred, as for any other
7037 temporary error. In other circumstances Exim may assume the lookup has failed,
7038 or may give up altogether.
7039
7040
7041
7042 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7043 .cindex "wildcard lookups"
7044 .cindex "lookup" "default values"
7045 .cindex "lookup" "wildcard"
7046 .cindex "lookup" "* added to type"
7047 .cindex "default" "in single-key lookups"
7048 In this context, a &"default value"& is a value specified by the administrator
7049 that is to be used if a lookup fails.
7050
7051 &*Note:*& This section applies only to single-key lookups. For query-style
7052 lookups, the facilities of the query language must be used. An attempt to
7053 specify a default for a query-style lookup provokes an error.
7054
7055 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7056 and the initial lookup fails, the key &"*"& is looked up in the file to
7057 provide a default value. See also the section on partial matching below.
7058
7059 .cindex "*@ with single-key lookup"
7060 .cindex "lookup" "*@ added to type"
7061 .cindex "alias file" "per-domain default"
7062 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7063 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7064 character, a second lookup is done with everything before the last @ replaced
7065 by *. This makes it possible to provide per-domain defaults in alias files
7066 that include the domains in the keys. If the second lookup fails (or doesn't
7067 take place because there is no @ in the key), &"*"& is looked up.
7068 For example, a &(redirect)& router might contain:
7069 .code
7070 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7071 .endd
7072 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7073 looks up these keys, in this order:
7074 .code
7075 jane@eyre.example
7076 *@eyre.example
7077 *
7078 .endd
7079 The data is taken from whichever key it finds first. &*Note*&: In an
7080 &(lsearch)& file, this does not mean the first of these keys in the file. A
7081 complete scan is done for each key, and only if it is not found at all does
7082 Exim move on to try the next key.
7083
7084
7085
7086 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7087 .cindex "partial matching"
7088 .cindex "wildcard lookups"
7089 .cindex "lookup" "partial matching"
7090 .cindex "lookup" "wildcard"
7091 .cindex "asterisk" "in search type"
7092 The normal operation of a single-key lookup is to search the file for an exact
7093 match with the given key. However, in a number of situations where domains are
7094 being looked up, it is useful to be able to do partial matching. In this case,
7095 information in the file that has a key starting with &"*."& is matched by any
7096 domain that ends with the components that follow the full stop. For example, if
7097 a key in a DBM file is
7098 .code
7099 *.dates.fict.example
7100 .endd
7101 then when partial matching is enabled this is matched by (amongst others)
7102 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7103 by &'dates.fict.example'&, if that does not appear as a separate key in the
7104 file.
7105
7106 &*Note*&: Partial matching is not available for query-style lookups. It is
7107 also not available for any lookup items in address lists (see section
7108 &<<SECTaddresslist>>&).
7109
7110 Partial matching is implemented by doing a series of separate lookups using
7111 keys constructed by modifying the original subject key. This means that it can
7112 be used with any of the single-key lookup types, provided that
7113 partial matching keys
7114 beginning with a special prefix (default &"*."&) are included in the data file.
7115 Keys in the file that do not begin with the prefix are matched only by
7116 unmodified subject keys when partial matching is in use.
7117
7118 Partial matching is requested by adding the string &"partial-"& to the front of
7119 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7120 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7121 is added at the start of the subject key, and it is looked up again. If that
7122 fails, further lookups are tried with dot-separated components removed from the
7123 start of the subject key, one-by-one, and &"*."& added on the front of what
7124 remains.
7125
7126 A minimum number of two non-* components are required. This can be adjusted
7127 by including a number before the hyphen in the search type. For example,
7128 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7129 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7130 subject key is &'2250.dates.fict.example'& then the following keys are looked
7131 up when the minimum number of non-* components is two:
7132 .code
7133 2250.dates.fict.example
7134 *.2250.dates.fict.example
7135 *.dates.fict.example
7136 *.fict.example
7137 .endd
7138 As soon as one key in the sequence is successfully looked up, the lookup
7139 finishes.
7140
7141 .cindex "lookup" "partial matching &-- changing prefix"
7142 .cindex "prefix" "for partial matching"
7143 The use of &"*."& as the partial matching prefix is a default that can be
7144 changed. The motivation for this feature is to allow Exim to operate with file
7145 formats that are used by other MTAs. A different prefix can be supplied in
7146 parentheses instead of the hyphen after &"partial"&. For example:
7147 .code
7148 domains = partial(.)lsearch;/some/file
7149 .endd
7150 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7151 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7152 components is unchanged). The prefix may consist of any punctuation characters
7153 other than a closing parenthesis. It may be empty, for example:
7154 .code
7155 domains = partial1()cdb;/some/file
7156 .endd
7157 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7158 &`a.b.c`&, &`b.c`&, and &`c`&.
7159
7160 If &"partial0"& is specified, what happens at the end (when the lookup with
7161 just one non-wild component has failed, and the original key is shortened right
7162 down to the null string) depends on the prefix:
7163
7164 .ilist
7165 If the prefix has zero length, the whole lookup fails.
7166 .next
7167 If the prefix has length 1, a lookup for just the prefix is done. For
7168 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7169 .next
7170 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7171 remainder is looked up. With the default prefix, therefore, the final lookup is
7172 for &"*"& on its own.
7173 .next
7174 Otherwise, the whole prefix is looked up.
7175 .endlist
7176
7177
7178 If the search type ends in &"*"& or &"*@"& (see section
7179 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7180 this implies happens after all partial lookups have failed. If &"partial0"& is
7181 specified, adding &"*"& to the search type has no effect with the default
7182 prefix, because the &"*"& key is already included in the sequence of partial
7183 lookups. However, there might be a use for lookup types such as
7184 &"partial0(.)lsearch*"&.
7185
7186 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7187 in domain lists and the like. Partial matching works only in terms of
7188 dot-separated components; a key such as &`*fict.example`&
7189 in a database file is useless, because the asterisk in a partial matching
7190 subject key is always followed by a dot.
7191
7192
7193
7194
7195 .section "Lookup caching" "SECID64"
7196 .cindex "lookup" "caching"
7197 .cindex "caching" "lookup data"
7198 Exim caches all lookup results in order to avoid needless repetition of
7199 lookups. However, because (apart from the daemon) Exim operates as a collection
7200 of independent, short-lived processes, this caching applies only within a
7201 single Exim process. There is no inter-process lookup caching facility.
7202
7203 For single-key lookups, Exim keeps the relevant files open in case there is
7204 another lookup that needs them. In some types of configuration this can lead to
7205 many files being kept open for messages with many recipients. To avoid hitting
7206 the operating system limit on the number of simultaneously open files, Exim
7207 closes the least recently used file when it needs to open more files than its
7208 own internal limit, which can be changed via the &%lookup_open_max%& option.
7209
7210 The single-key lookup files are closed and the lookup caches are flushed at
7211 strategic points during delivery &-- for example, after all routing is
7212 complete.
7213
7214
7215
7216
7217 .section "Quoting lookup data" "SECID65"
7218 .cindex "lookup" "quoting"
7219 .cindex "quoting" "in lookups"
7220 When data from an incoming message is included in a query-style lookup, there
7221 is the possibility of special characters in the data messing up the syntax of
7222 the query. For example, a NIS+ query that contains
7223 .code
7224 [name=$local_part]
7225 .endd
7226 will be broken if the local part happens to contain a closing square bracket.
7227 For NIS+, data can be enclosed in double quotes like this:
7228 .code
7229 [name="$local_part"]
7230 .endd
7231 but this still leaves the problem of a double quote in the data. The rule for
7232 NIS+ is that double quotes must be doubled. Other lookup types have different
7233 rules, and to cope with the differing requirements, an expansion operator
7234 of the following form is provided:
7235 .code
7236 ${quote_<lookup-type>:<string>}
7237 .endd
7238 For example, the safest way to write the NIS+ query is
7239 .code
7240 [name="${quote_nisplus:$local_part}"]
7241 .endd
7242 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7243 operator can be used for all lookup types, but has no effect for single-key
7244 lookups, since no quoting is ever needed in their key strings.
7245
7246
7247
7248
7249 .section "More about dnsdb" "SECTdnsdb"
7250 .cindex "dnsdb lookup"
7251 .cindex "lookup" "dnsdb"
7252 .cindex "DNS" "as a lookup type"
7253 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7254 of a record type and a domain name, separated by an equals sign. For example,
7255 an expansion string could contain:
7256 .code
7257 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7258 .endd
7259 If the lookup succeeds, the result is placed in &$value$&, which in this case
7260 is used on its own as the result. If the lookup does not succeed, the
7261 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7262 &<<SECTforexpfai>>& for an explanation of what this means.
7263
7264 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7265 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7266 If no type is given, TXT is assumed.
7267
7268 For any record type, if multiple records are found, the data is returned as a
7269 concatenation, with newline as the default separator. The order, of course,
7270 depends on the DNS resolver. You can specify a different separator character
7271 between multiple records by putting a right angle-bracket followed immediately
7272 by the new separator at the start of the query. For example:
7273 .code
7274 ${lookup dnsdb{>: a=host1.example}}
7275 .endd
7276 It is permitted to specify a space as the separator character. Further
7277 white space is ignored.
7278 For lookup types that return multiple fields per record,
7279 an alternate field separator can be specified using a comma after the main
7280 separator character, followed immediately by the field separator.
7281
7282 .cindex "PTR record" "in &(dnsdb)& lookup"
7283 When the type is PTR,
7284 the data can be an IP address, written as normal; inversion and the addition of
7285 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7286 .code
7287 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7288 .endd
7289 If the data for a PTR record is not a syntactically valid IP address, it is not
7290 altered and nothing is added.
7291
7292 .cindex "MX record" "in &(dnsdb)& lookup"
7293 .cindex "SRV record" "in &(dnsdb)& lookup"
7294 For an MX lookup, both the preference value and the host name are returned for
7295 each record, separated by a space. For an SRV lookup, the priority, weight,
7296 port, and host name are returned for each record, separated by spaces.
7297 The field separator can be modified as above.
7298
7299 .cindex "TXT record" "in &(dnsdb)& lookup"
7300 .cindex "SPF record" "in &(dnsdb)& lookup"
7301 For TXT records with multiple items of data, only the first item is returned,
7302 unless a field separator is specified.
7303 To concatenate items without a separator, use a semicolon instead.
7304 For SPF records the
7305 default behaviour is to concatenate multiple items without using a separator.
7306 .code
7307 ${lookup dnsdb{>\n,: txt=a.b.example}}
7308 ${lookup dnsdb{>\n; txt=a.b.example}}
7309 ${lookup dnsdb{spf=example.org}}
7310 .endd
7311 It is permitted to specify a space as the separator character. Further
7312 white space is ignored.
7313
7314 .cindex "SOA record" "in &(dnsdb)& lookup"
7315 For an SOA lookup, while no result is obtained the lookup is redone with
7316 successively more leading components dropped from the given domain.
7317 Only the primary-nameserver field is returned unless a field separator is
7318 specified.
7319 .code
7320 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7321 .endd
7322
7323 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7324 .cindex "dnsdb modifiers"
7325 .cindex "modifiers" "dnsdb"
7326 .cindex "options" "dnsdb"
7327 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7328 each followed by a comma,
7329 that may appear before the record type.
7330
7331 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7332 temporary DNS error for any of them, the behaviour is controlled by
7333 a defer-option modifier.
7334 The possible keywords are
7335 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7336 With &"strict"& behaviour, any temporary DNS error causes the
7337 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7338 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7339 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7340 error causes the whole lookup to defer only if none of the other lookups
7341 succeed. The default is &"lax"&, so the following lookups are equivalent:
7342 .code
7343 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7344 ${lookup dnsdb{a=one.host.com:two.host.com}}
7345 .endd
7346 Thus, in the default case, as long as at least one of the DNS lookups
7347 yields some data, the lookup succeeds.
7348
7349 .cindex "DNSSEC" "dns lookup"
7350 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7351 The possible keywords are
7352 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7353 With &"strict"& or &"lax"& DNSSEC information is requested
7354 with the lookup.
7355 With &"strict"& a response from the DNS resolver that
7356 is not labelled as authenticated data
7357 is treated as equivalent to a temporary DNS error.
7358 The default is &"lax"&.
7359
7360 See also the &$lookup_dnssec_authenticated$& variable.
7361
7362 .cindex timeout "dns lookup"
7363 .cindex "DNS" timeout
7364 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7365 The form is &"retrans_VAL"& where VAL is an Exim time specification
7366 (e.g. &"5s"&).
7367 The default value is set by the main configuration option &%dns_retrans%&.
7368
7369 Retries for the dnsdb lookup can be controlled by a retry modifier.
7370 The form if &"retry_VAL"& where VAL is an integer.
7371 The default count is set by the main configuration option &%dns_retry%&.
7372
7373 .cindex caching "of dns lookup"
7374 .cindex TTL "of dns lookup"
7375 .cindex DNS TTL
7376 Dnsdb lookup results are cached within a single process (and its children).
7377 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7378 value of the set of returned DNS records.
7379
7380
7381 .section "Pseudo dnsdb record types" "SECID66"
7382 .cindex "MX record" "in &(dnsdb)& lookup"
7383 By default, both the preference value and the host name are returned for
7384 each MX record, separated by a space. If you want only host names, you can use
7385 the pseudo-type MXH:
7386 .code
7387 ${lookup dnsdb{mxh=a.b.example}}
7388 .endd
7389 In this case, the preference values are omitted, and just the host names are
7390 returned.
7391
7392 .cindex "name server for enclosing domain"
7393 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7394 records on the given domain, but if none are found, it removes the first
7395 component of the domain name, and tries again. This process continues until NS
7396 records are found or there are no more components left (or there is a DNS
7397 error). In other words, it may return the name servers for a top-level domain,
7398 but it never returns the root name servers. If there are no NS records for the
7399 top-level domain, the lookup fails. Consider these examples:
7400 .code
7401 ${lookup dnsdb{zns=xxx.quercite.com}}
7402 ${lookup dnsdb{zns=xxx.edu}}
7403 .endd
7404 Assuming that in each case there are no NS records for the full domain name,
7405 the first returns the name servers for &%quercite.com%&, and the second returns
7406 the name servers for &%edu%&.
7407
7408 You should be careful about how you use this lookup because, unless the
7409 top-level domain does not exist, the lookup always returns some host names. The
7410 sort of use to which this might be put is for seeing if the name servers for a
7411 given domain are on a blacklist. You can probably assume that the name servers
7412 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7413 such a list.
7414
7415 .cindex "CSA" "in &(dnsdb)& lookup"
7416 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7417 records according to the CSA rules, which are described in section
7418 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7419 not sufficient because of the extra parent domain search behaviour of CSA. The
7420 result of a successful lookup such as:
7421 .code
7422 ${lookup dnsdb {csa=$sender_helo_name}}
7423 .endd
7424 has two space-separated fields: an authorization code and a target host name.
7425 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7426 authorization required but absent, or &"?"& for unknown.
7427
7428 .cindex "A+" "in &(dnsdb)& lookup"
7429 The pseudo-type A+ performs an AAAA
7430 and then an A lookup.  All results are returned; defer processing
7431 (see below) is handled separately for each lookup.  Example:
7432 .code
7433 ${lookup dnsdb {>; a+=$sender_helo_name}}
7434 .endd
7435
7436
7437 .section "Multiple dnsdb lookups" "SECID67"
7438 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7439 However, you can specify a list of domains or IP addresses in a single
7440 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7441 the default separator, but with the ability to change this. For example:
7442 .code
7443 ${lookup dnsdb{one.domain.com:two.domain.com}}
7444 ${lookup dnsdb{a=one.host.com:two.host.com}}
7445 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7446 .endd
7447 In order to retain backwards compatibility, there is one special case: if
7448 the lookup type is PTR and no change of separator is specified, Exim looks
7449 to see if the rest of the string is precisely one IPv6 address. In this
7450 case, it does not treat it as a list.
7451
7452 The data from each lookup is concatenated, with newline separators by default,
7453 in the same way that multiple DNS records for a single item are handled. A
7454 different separator can be specified, as described above.
7455
7456
7457
7458
7459 .section "More about LDAP" "SECTldap"
7460 .cindex "LDAP" "lookup, more about"
7461 .cindex "lookup" "LDAP"
7462 .cindex "Solaris" "LDAP"
7463 The original LDAP implementation came from the University of Michigan; this has
7464 become &"Open LDAP"&, and there are now two different releases. Another
7465 implementation comes from Netscape, and Solaris 7 and subsequent releases
7466 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7467 the lookup function level, their error handling is different. For this reason
7468 it is necessary to set a compile-time variable when building Exim with LDAP, to
7469 indicate which LDAP library is in use. One of the following should appear in
7470 your &_Local/Makefile_&:
7471 .code
7472 LDAP_LIB_TYPE=UMICHIGAN
7473 LDAP_LIB_TYPE=OPENLDAP1
7474 LDAP_LIB_TYPE=OPENLDAP2
7475 LDAP_LIB_TYPE=NETSCAPE
7476 LDAP_LIB_TYPE=SOLARIS
7477 .endd
7478 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7479 same interface as the University of Michigan version.
7480
7481 There are three LDAP lookup types in Exim. These behave slightly differently in
7482 the way they handle the results of a query:
7483
7484 .ilist
7485 &(ldap)& requires the result to contain just one entry; if there are more, it
7486 gives an error.
7487 .next
7488 &(ldapdn)& also requires the result to contain just one entry, but it is the
7489 Distinguished Name that is returned rather than any attribute values.
7490 .next
7491 &(ldapm)& permits the result to contain more than one entry; the attributes
7492 from all of them are returned.
7493 .endlist
7494
7495
7496 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7497 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7498 the data returned by a successful lookup is described in the next section.
7499 First we explain how LDAP queries are coded.
7500
7501
7502 .section "Format of LDAP queries" "SECTforldaque"
7503 .cindex "LDAP" "query format"
7504 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7505 the configuration of a &(redirect)& router one might have this setting:
7506 .code
7507 data = ${lookup ldap \
7508   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7509   c=UK?mailbox?base?}}
7510 .endd
7511 .cindex "LDAP" "with TLS"
7512 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7513 secure (encrypted) LDAP connections. The second of these ensures that an
7514 encrypted TLS connection is used.
7515
7516 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7517 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7518 See the &%ldap_start_tls%& option.
7519
7520 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7521 controlled. Every part of the TLS configuration can be configured by settings in
7522 &_exim.conf_&. Depending on the version of the client libraries installed on
7523 your system, some of the initialization may have required setting options in
7524 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7525 certificates. This revealed a nuance where the current UID that exim was
7526 running as could affect which config files it read. With Exim 4.83, these
7527 methods become optional, only taking effect if not specifically set in
7528 &_exim.conf_&.
7529
7530
7531 .section "LDAP quoting" "SECID68"
7532 .cindex "LDAP" "quoting"
7533 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7534 and the second because the LDAP query is represented as a URL. Furthermore,
7535 within an LDAP query, two different kinds of quoting are required. For this
7536 reason, there are two different LDAP-specific quoting operators.
7537
7538 The &%quote_ldap%& operator is designed for use on strings that are part of
7539 filter specifications. Conceptually, it first does the following conversions on
7540 the string:
7541 .code
7542 *   =>   \2A
7543 (   =>   \28
7544 )   =>   \29
7545 \   =>   \5C
7546 .endd
7547 in accordance with RFC 2254. The resulting string is then quoted according
7548 to the rules for URLs, that is, all non-alphanumeric characters except
7549 .code
7550 ! $ ' - . _ ( ) * +
7551 .endd
7552 are converted to their hex values, preceded by a percent sign. For example:
7553 .code
7554 ${quote_ldap: a(bc)*, a<yz>; }
7555 .endd
7556 yields
7557 .code
7558 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7559 .endd
7560 Removing the URL quoting, this is (with a leading and a trailing space):
7561 .code
7562 a\28bc\29\2A, a<yz>;
7563 .endd
7564 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7565 base DN specifications in queries. Conceptually, it first converts the string
7566 by inserting a backslash in front of any of the following characters:
7567 .code
7568 , + " \ < > ;
7569 .endd
7570 It also inserts a backslash before any leading spaces or # characters, and
7571 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7572 is then quoted according to the rules for URLs. For example:
7573 .code
7574 ${quote_ldap_dn: a(bc)*, a<yz>; }
7575 .endd
7576 yields
7577 .code
7578 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7579 .endd
7580 Removing the URL quoting, this is (with a trailing space):
7581 .code
7582 \ a(bc)*\, a\<yz\>\;\
7583 .endd
7584 There are some further comments about quoting in the section on LDAP
7585 authentication below.
7586
7587
7588 .section "LDAP connections" "SECID69"
7589 .cindex "LDAP" "connections"
7590 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7591 is in use, via a Unix domain socket. The example given above does not specify
7592 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7593 by starting it with
7594 .code
7595 ldap://<hostname>:<port>/...
7596 .endd
7597 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7598 used. When no server is specified in a query, a list of default servers is
7599 taken from the &%ldap_default_servers%& configuration option. This supplies a
7600 colon-separated list of servers which are tried in turn until one successfully
7601 handles a query, or there is a serious error. Successful handling either
7602 returns the requested data, or indicates that it does not exist. Serious errors
7603 are syntactical, or multiple values when only a single value is expected.
7604 Errors which cause the next server to be tried are connection failures, bind
7605 failures, and timeouts.
7606
7607 For each server name in the list, a port number can be given. The standard way
7608 of specifying a host and port is to use a colon separator (RFC 1738). Because
7609 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7610 doubled. For example
7611 .code
7612 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7613 .endd
7614 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7615 to the LDAP library with no server name, and the library's default (normally
7616 the local host) is used.
7617
7618 If you are using the OpenLDAP library, you can connect to an LDAP server using
7619 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7620 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7621 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7622 not available.
7623
7624 For this type of connection, instead of a host name for the server, a pathname
7625 for the socket is required, and the port number is not relevant. The pathname
7626 can be specified either as an item in &%ldap_default_servers%&, or inline in
7627 the query. In the former case, you can have settings such as
7628 .code
7629 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7630 .endd
7631 When the pathname is given in the query, you have to escape the slashes as
7632 &`%2F`& to fit in with the LDAP URL syntax. For example:
7633 .code
7634 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7635 .endd
7636 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7637 a pathname, it uses the Unix domain socket code, even if the query actually
7638 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7639 socket connection. This behaviour means that you can use a setting of
7640 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7641 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7642 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7643 backup host.
7644
7645 If an explicit &`ldapi`& type is given in a query when a host name is
7646 specified, an error is diagnosed. However, if there are more items in
7647 &%ldap_default_servers%&, they are tried. In other words:
7648
7649 .ilist
7650 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7651 interface.
7652 .next
7653 Using &`ldapi`& with a host name causes an error.
7654 .endlist
7655
7656
7657 Using &`ldapi`& with no host or path in the query, and no setting of
7658 &%ldap_default_servers%&, does whatever the library does by default.
7659
7660
7661
7662 .section "LDAP authentication and control information" "SECID70"
7663 .cindex "LDAP" "authentication"
7664 The LDAP URL syntax provides no way of passing authentication and other control
7665 information to the server. To make this possible, the URL in an LDAP query may
7666 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7667 spaces. If a value contains spaces it must be enclosed in double quotes, and
7668 when double quotes are used, backslash is interpreted in the usual way inside
7669 them. The following names are recognized:
7670 .display
7671 &`DEREFERENCE`&  set the dereferencing parameter
7672 &`NETTIME    `&  set a timeout for a network operation
7673 &`USER       `&  set the DN, for authenticating the LDAP bind
7674 &`PASS       `&  set the password, likewise
7675 &`REFERRALS  `&  set the referrals parameter
7676 &`SERVERS    `&  set alternate server list for this query only
7677 &`SIZE       `&  set the limit for the number of entries returned
7678 &`TIME       `&  set the maximum waiting time for a query
7679 .endd
7680 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7681 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7682 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7683 library from trying to follow referrals issued by the LDAP server.
7684
7685 .cindex LDAP timeout
7686 .cindex timeout "LDAP lookup"
7687 The name CONNECT is an obsolete name for NETTIME, retained for
7688 backwards compatibility. This timeout (specified as a number of seconds) is
7689 enforced from the client end for operations that can be carried out over a
7690 network. Specifically, it applies to network connections and calls to the
7691 &'ldap_result()'& function. If the value is greater than zero, it is used if
7692 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7693 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7694 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7695 Netscape SDK; for OpenLDAP no action is taken.
7696
7697 The TIME parameter (also a number of seconds) is passed to the server to
7698 set a server-side limit on the time taken to complete a search.
7699
7700 The SERVERS parameter allows you to specify an alternate list of ldap servers
7701 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7702 default list of ldap servers, and a single lookup can specify a single ldap
7703 server to use.  But when you need to do a lookup with a list of servers that is
7704 different than the default list (maybe different order, maybe a completely
7705 different set of servers), the SERVERS parameter allows you to specify this
7706 alternate list (colon-separated).
7707
7708 Here is an example of an LDAP query in an Exim lookup that uses some of these
7709 values. This is a single line, folded to fit on the page:
7710 .code
7711 ${lookup ldap
7712   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7713   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7714   {$value}fail}
7715 .endd
7716 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7717 any of the auxiliary data. Exim configuration settings that include lookups
7718 which contain password information should be preceded by &"hide"& to prevent
7719 non-admin users from using the &%-bP%& option to see their values.
7720
7721 The auxiliary data items may be given in any order. The default is no
7722 connection timeout (the system timeout is used), no user or password, no limit
7723 on the number of entries returned, and no time limit on queries.
7724
7725 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7726 removes any URL quoting that it may contain before passing it LDAP. Apparently
7727 some libraries do this for themselves, but some do not. Removing the URL
7728 quoting has two advantages:
7729
7730 .ilist
7731 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7732 DNs as with DNs inside actual queries.
7733 .next
7734 It permits spaces inside USER= DNs.
7735 .endlist
7736
7737 For example, a setting such as
7738 .code
7739 USER=cn=${quote_ldap_dn:$1}
7740 .endd
7741 should work even if &$1$& contains spaces.
7742
7743 Expanded data for the PASS= value should be quoted using the &%quote%&
7744 expansion operator, rather than the LDAP quote operators. The only reason this
7745 field needs quoting is to ensure that it conforms to the Exim syntax, which
7746 does not allow unquoted spaces. For example:
7747 .code
7748 PASS=${quote:$3}
7749 .endd
7750 The LDAP authentication mechanism can be used to check passwords as part of
7751 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7752 &<<CHAPexpand>>&.
7753
7754
7755
7756 .section "Format of data returned by LDAP" "SECID71"
7757 .cindex "LDAP" "returned data formats"
7758 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7759 as a sequence of values, for example
7760 .code
7761 cn=manager,o=University of Cambridge,c=UK
7762 .endd
7763 The &(ldap)& lookup type generates an error if more than one entry matches the
7764 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7765 the result between the data from different entries. It is possible for multiple
7766 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7767 you know that whatever values are returned all came from a single entry in the
7768 directory.
7769
7770 In the common case where you specify a single attribute in your LDAP query, the
7771 result is not quoted, and does not contain the attribute name. If the attribute
7772 has multiple values, they are separated by commas. Any comma that is
7773 part of an attribute's value is doubled.
7774
7775 If you specify multiple attributes, the result contains space-separated, quoted
7776 strings, each preceded by the attribute name and an equals sign. Within the
7777 quotes, the quote character, backslash, and newline are escaped with
7778 backslashes, and commas are used to separate multiple values for the attribute.
7779 Any commas in attribute values are doubled
7780 (permitting treatment of the values as a comma-separated list).
7781 Apart from the escaping, the string within quotes takes the same form as the
7782 output when a single attribute is requested. Specifying no attributes is the
7783 same as specifying all of an entry's attributes.
7784
7785 Here are some examples of the output format. The first line of each pair is an
7786 LDAP query, and the second is the data that is returned. The attribute called
7787 &%attr1%& has two values, one of them with an embedded comma, whereas
7788 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7789 (they have SUP &%attr%& in their schema definitions).
7790
7791 .code
7792 ldap:///o=base?attr1?sub?(uid=fred)
7793 value1.1,value1,,2
7794
7795 ldap:///o=base?attr2?sub?(uid=fred)
7796 value two
7797
7798 ldap:///o=base?attr?sub?(uid=fred)
7799 value1.1,value1,,2,value two
7800
7801 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7802 attr1="value1.1,value1,,2" attr2="value two"
7803
7804 ldap:///o=base??sub?(uid=fred)
7805 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7806 .endd
7807 You can
7808 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7809 results of LDAP lookups.
7810 The &%extract%& operator in string expansions can be used to pick out
7811 individual fields from data that consists of &'key'&=&'value'& pairs.
7812 The &%listextract%& operator should be used to pick out individual values
7813 of attributes, even when only a single value is expected.
7814 The doubling of embedded commas allows you to use the returned data as a
7815 comma separated list (using the "<," syntax for changing the input list separator).
7816
7817
7818
7819
7820 .section "More about NIS+" "SECTnisplus"
7821 .cindex "NIS+ lookup type"
7822 .cindex "lookup" "NIS+"
7823 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7824 and field name. If this is given, the result of a successful query is the
7825 contents of the named field; otherwise the result consists of a concatenation
7826 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7827 values containing spaces are quoted. For example, the query
7828 .code
7829 [name=mg1456],passwd.org_dir
7830 .endd
7831 might return the string
7832 .code
7833 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7834 home=/home/mg1456 shell=/bin/bash shadow=""
7835 .endd
7836 (split over two lines here to fit on the page), whereas
7837 .code
7838 [name=mg1456],passwd.org_dir:gcos
7839 .endd
7840 would just return
7841 .code
7842 Martin Guerre
7843 .endd
7844 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7845 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7846 operator is to double any quote characters within the text.
7847
7848
7849
7850 .section "SQL lookups" "SECTsql"
7851 .cindex "SQL lookup types"
7852 .cindex "MySQL" "lookup type"
7853 .cindex "PostgreSQL lookup type"
7854 .cindex "lookup" "MySQL"
7855 .cindex "lookup" "PostgreSQL"
7856 .cindex "Oracle" "lookup type"
7857 .cindex "lookup" "Oracle"
7858 .cindex "InterBase lookup type"
7859 .cindex "lookup" "InterBase"
7860 .cindex "Redis lookup type"
7861 .cindex lookup Redis
7862 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7863 and SQLite
7864 databases. Queries for these databases contain SQL statements, so an example
7865 might be
7866 .code
7867 ${lookup mysql{select mailbox from users where id='userx'}\
7868   {$value}fail}
7869 .endd
7870 If the result of the query contains more than one field, the data for each
7871 field in the row is returned, preceded by its name, so the result of
7872 .code
7873 ${lookup pgsql{select home,name from users where id='userx'}\
7874   {$value}}
7875 .endd
7876 might be
7877 .code
7878 home=/home/userx name="Mister X"
7879 .endd
7880 Empty values and values containing spaces are double quoted, with embedded
7881 quotes escaped by a backslash. If the result of the query contains just one
7882 field, the value is passed back verbatim, without a field name, for example:
7883 .code
7884 Mister X
7885 .endd
7886 If the result of the query yields more than one row, it is all concatenated,
7887 with a newline between the data for each row.
7888
7889
7890 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7891 .cindex "MySQL" "lookup type"
7892 .cindex "PostgreSQL lookup type"
7893 .cindex "lookup" "MySQL"
7894 .cindex "lookup" "PostgreSQL"
7895 .cindex "Oracle" "lookup type"
7896 .cindex "lookup" "Oracle"
7897 .cindex "InterBase lookup type"
7898 .cindex "lookup" "InterBase"
7899 .cindex "Redis lookup type"
7900 .cindex lookup Redis
7901 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7902 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7903 or &%redis_servers%&
7904 option (as appropriate) must be set to a colon-separated list of server
7905 information.
7906 (For MySQL and PostgreSQL, the global option need not be set if all
7907 queries contain their own server information &-- see section
7908 &<<SECTspeserque>>&.)
7909 For all but Redis
7910 each item in the list is a slash-separated list of four
7911 items: host name, database name, user name, and password. In the case of
7912 Oracle, the host name field is used for the &"service name"&, and the database
7913 name field is not used and should be empty. For example:
7914 .code
7915 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7916 .endd
7917 Because password data is sensitive, you should always precede the setting with
7918 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7919 option. Here is an example where two MySQL servers are listed:
7920 .code
7921 hide mysql_servers = localhost/users/root/secret:\
7922                      otherhost/users/root/othersecret
7923 .endd
7924 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7925 because this is a colon-separated list, the colon has to be doubled. For each
7926 query, these parameter groups are tried in order until a connection is made and
7927 a query is successfully processed. The result of a query may be that no data is
7928 found, but that is still a successful query. In other words, the list of
7929 servers provides a backup facility, not a list of different places to look.
7930
7931 For Redis the global option need not be specified if all queries contain their
7932 own server information &-- see section &<<SECTspeserque>>&.
7933 If specified, the option must be set to a colon-separated list of server
7934 information.
7935 Each item in the list is a slash-separated list of three items:
7936 host, database number, and password.
7937 .olist
7938 The host is required and may be either an IPv4 address and optional
7939 port number (separated by a colon, which needs doubling due to the
7940 higher-level list), or a Unix socket pathname enclosed in parentheses
7941 .next
7942 The database number is optional; if present that number is selected in the backend
7943 .next
7944 The password is optional; if present it is used to authenticate to the backend
7945 .endlist
7946
7947 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7948 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7949 respectively, and the characters single-quote, double-quote, and backslash
7950 itself are escaped with backslashes.
7951
7952 The &%quote_redis%& expansion operator
7953 escapes whitespace and backslash characters with a backslash.
7954
7955 .section "Specifying the server in the query" "SECTspeserque"
7956 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7957 it is possible to specify a list of servers with an individual query. This is
7958 done by starting the query with
7959 .display
7960 &`servers=`&&'server1:server2:server3:...'&&`;`&
7961 .endd
7962 Each item in the list may take one of two forms:
7963 .olist
7964 If it contains no slashes it is assumed to be just a host name. The appropriate
7965 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7966 of the same name, and the remaining parameters (database, user, password) are
7967 taken from there.
7968 .next
7969 If it contains any slashes, it is taken as a complete parameter set.
7970 .endlist
7971 The list of servers is used in exactly the same way as the global list.
7972 Once a connection to a server has happened and a query has been
7973 successfully executed, processing of the lookup ceases.
7974
7975 This feature is intended for use in master/slave situations where updates
7976 are occurring and you want to update the master rather than a slave. If the
7977 master is in the list as a backup for reading, you might have a global setting
7978 like this:
7979 .code
7980 mysql_servers = slave1/db/name/pw:\
7981                 slave2/db/name/pw:\
7982                 master/db/name/pw
7983 .endd
7984 In an updating lookup, you could then write:
7985 .code
7986 ${lookup mysql{servers=master; UPDATE ...} }
7987 .endd
7988 That query would then be sent only to the master server. If, on the other hand,
7989 the master is not to be used for reading, and so is not present in the global
7990 option, you can still update it by a query of this form:
7991 .code
7992 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7993 .endd
7994
7995
7996 .section "Special MySQL features" "SECID73"
7997 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7998 causes a connection to the server on the local host by means of a Unix domain
7999 socket. An alternate socket can be specified in parentheses.
8000 An option group name for MySQL option files can be specified in square brackets;
8001 the default value is &"exim"&.
8002 The full syntax of each item in &%mysql_servers%& is:
8003 .display
8004 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8005   <&'database'&>/<&'user'&>/<&'password'&>
8006 .endd
8007 Any of the four sub-parts of the first field can be omitted. For normal use on
8008 the local host it can be left blank or set to just &"localhost"&.
8009
8010 No database need be supplied &-- but if it is absent here, it must be given in
8011 the queries.
8012
8013 If a MySQL query is issued that does not request any data (an insert, update,
8014 or delete command), the result of the lookup is the number of rows affected.
8015
8016 &*Warning*&: This can be misleading. If an update does not actually change
8017 anything (for example, setting a field to the value it already has), the result
8018 is zero because no rows are affected.
8019
8020
8021 .section "Special PostgreSQL features" "SECID74"
8022 PostgreSQL lookups can also use Unix domain socket connections to the database.
8023 This is usually faster and costs less CPU time than a TCP/IP connection.
8024 However it can be used only if the mail server runs on the same machine as the
8025 database server. A configuration line for PostgreSQL via Unix domain sockets
8026 looks like this:
8027 .code
8028 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8029 .endd
8030 In other words, instead of supplying a host name, a path to the socket is
8031 given. The path name is enclosed in parentheses so that its slashes aren't
8032 visually confused with the delimiters for the other server parameters.
8033
8034 If a PostgreSQL query is issued that does not request any data (an insert,
8035 update, or delete command), the result of the lookup is the number of rows
8036 affected.
8037
8038 .section "More about SQLite" "SECTsqlite"
8039 .cindex "lookup" "SQLite"
8040 .cindex "sqlite lookup type"
8041 SQLite is different to the other SQL lookups because a filename is required in
8042 addition to the SQL query. An SQLite database is a single file, and there is no
8043 daemon as in the other SQL databases. The interface to Exim requires the name
8044 of the file, as an absolute path, to be given at the start of the query. It is
8045 separated from the query by white space. This means that the path name cannot
8046 contain white space. Here is a lookup expansion example:
8047 .code
8048 ${lookup sqlite {/some/thing/sqlitedb \
8049   select name from aliases where id='userx';}}
8050 .endd
8051 In a list, the syntax is similar. For example:
8052 .code
8053 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8054    select * from relays where ip='$sender_host_address';
8055 .endd
8056 The only character affected by the &%quote_sqlite%& operator is a single
8057 quote, which it doubles.
8058
8059 .cindex timeout SQLite
8060 .cindex sqlite "lookup timeout"
8061 The SQLite library handles multiple simultaneous accesses to the database
8062 internally. Multiple readers are permitted, but only one process can
8063 update at once. Attempts to access the database while it is being updated
8064 are rejected after a timeout period, during which the SQLite library
8065 waits for the lock to be released. In Exim, the default timeout is set
8066 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8067 option.
8068
8069 .section "More about Redis" "SECTredis"
8070 .cindex "lookup" "Redis"
8071 .cindex "redis lookup type"
8072 Redis is a non-SQL database. Commands are simple get and set.
8073 Examples:
8074 .code
8075 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8076 ${lookup redis{get keyname}}
8077 .endd
8078
8079 As of release 4.91, "lightweight" support for Redis Cluster is available.
8080 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8081 of which must be reachable from the running exim instance. If the cluster has
8082 master/slave replication, the list must contain all the master and slave
8083 servers.
8084
8085 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8086 immediately follow the redirection but treats the response as a DEFER, moving on
8087 to the next server in the &%redis_servers%& list until the correct server is
8088 reached.
8089
8090 .ecindex IIDfidalo1
8091 .ecindex IIDfidalo2
8092
8093
8094 . ////////////////////////////////////////////////////////////////////////////
8095 . ////////////////////////////////////////////////////////////////////////////
8096
8097 .chapter "Domain, host, address, and local part lists" &&&
8098          "CHAPdomhosaddlists" &&&
8099          "Domain, host, and address lists"
8100 .scindex IIDdohoadli "lists of domains; hosts; etc."
8101 A number of Exim configuration options contain lists of domains, hosts,
8102 email addresses, or local parts. For example, the &%hold_domains%& option
8103 contains a list of domains whose delivery is currently suspended. These lists
8104 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8105 arguments to expansion conditions such as &%match_domain%&.
8106
8107 Each item in one of these lists is a pattern to be matched against a domain,
8108 host, email address, or local part, respectively. In the sections below, the
8109 different types of pattern for each case are described, but first we cover some
8110 general facilities that apply to all four kinds of list.
8111
8112 Note that other parts of Exim use a &'string list'& which does not
8113 support all the complexity available in
8114 domain, host, address and local part lists.
8115
8116
8117
8118 .section "Expansion of lists" "SECTlistexpand"
8119 .cindex "expansion" "of lists"
8120 Each list is expanded as a single string before it is used.
8121
8122 &'Exception: the router headers_remove option, where list-item
8123 splitting is done before string-expansion.'&
8124
8125 The result of
8126 expansion must be a list, possibly containing empty items, which is split up
8127 into separate items for matching. By default, colon is the separator character,
8128 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8129 &<<SECTempitelis>>& for details of the list syntax; the second of these
8130 discusses the way to specify empty list items.
8131
8132
8133 If the string expansion is forced to fail, Exim behaves as if the item it is
8134 testing (domain, host, address, or local part) is not in the list. Other
8135 expansion failures cause temporary errors.
8136
8137 If an item in a list is a regular expression, backslashes, dollars and possibly
8138 other special characters in the expression must be protected against
8139 misinterpretation by the string expander. The easiest way to do this is to use
8140 the &`\N`& expansion feature to indicate that the contents of the regular
8141 expression should not be expanded. For example, in an ACL you might have:
8142 .code
8143 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8144                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8145 .endd
8146 The first item is a regular expression that is protected from expansion by
8147 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8148 senders based on the receiving domain.
8149
8150
8151
8152
8153 .section "Negated items in lists" "SECID76"
8154 .cindex "list" "negation"
8155 .cindex "negation" "in lists"
8156 Items in a list may be positive or negative. Negative items are indicated by a
8157 leading exclamation mark, which may be followed by optional white space. A list
8158 defines a set of items (domains, etc). When Exim processes one of these lists,
8159 it is trying to find out whether a domain, host, address, or local part
8160 (respectively) is in the set that is defined by the list. It works like this:
8161
8162 The list is scanned from left to right. If a positive item is matched, the
8163 subject that is being checked is in the set; if a negative item is matched, the
8164 subject is not in the set. If the end of the list is reached without the
8165 subject having matched any of the patterns, it is in the set if the last item
8166 was a negative one, but not if it was a positive one. For example, the list in
8167 .code
8168 domainlist relay_to_domains = !a.b.c : *.b.c
8169 .endd
8170 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8171 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8172 list is positive. However, if the setting were
8173 .code
8174 domainlist relay_to_domains = !a.b.c
8175 .endd
8176 then all domains other than &'a.b.c'& would match because the last item in the
8177 list is negative. In other words, a list that ends with a negative item behaves
8178 as if it had an extra item &`:*`& on the end.
8179
8180 Another way of thinking about positive and negative items in lists is to read
8181 the connector as &"or"& after a positive item and as &"and"& after a negative
8182 item.
8183
8184
8185
8186 .section "File names in lists" "SECTfilnamlis"
8187 .cindex "list" "filename in"
8188 If an item in a domain, host, address, or local part list is an absolute
8189 filename (beginning with a slash character), each line of the file is read and
8190 processed as if it were an independent item in the list, except that further
8191 filenames are not allowed,
8192 and no expansion of the data from the file takes place.
8193 Empty lines in the file are ignored, and the file may also contain comment
8194 lines:
8195
8196 .ilist
8197 For domain and host lists, if a # character appears anywhere in a line of the
8198 file, it and all following characters are ignored.
8199 .next
8200 Because local parts may legitimately contain # characters, a comment in an
8201 address list or local part list file is recognized only if # is preceded by
8202 white space or the start of the line. For example:
8203 .code
8204 not#comment@x.y.z   # but this is a comment
8205 .endd
8206 .endlist
8207
8208 Putting a filename in a list has the same effect as inserting each line of the
8209 file as an item in the list (blank lines and comments excepted). However, there
8210 is one important difference: the file is read each time the list is processed,
8211 so if its contents vary over time, Exim's behaviour changes.
8212
8213 If a filename is preceded by an exclamation mark, the sense of any match
8214 within the file is inverted. For example, if
8215 .code
8216 hold_domains = !/etc/nohold-domains
8217 .endd
8218 and the file contains the lines
8219 .code
8220 !a.b.c
8221 *.b.c
8222 .endd
8223 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8224 any domain matching &`*.b.c`& is not.
8225
8226
8227
8228 .section "An lsearch file is not an out-of-line list" "SECID77"
8229 As will be described in the sections that follow, lookups can be used in lists
8230 to provide indexed methods of checking list membership. There has been some
8231 confusion about the way &(lsearch)& lookups work in lists. Because
8232 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8233 sometimes thought that it is allowed to contain wild cards and other kinds of
8234 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8235 always fixed strings, just as for any other single-key lookup type.
8236
8237 If you want to use a file to contain wild-card patterns that form part of a
8238 list, just give the filename on its own, without a search type, as described
8239 in the previous section. You could also use the &(wildlsearch)& or
8240 &(nwildlsearch)&, but there is no advantage in doing this.
8241
8242
8243
8244
8245 .section "Named lists" "SECTnamedlists"
8246 .cindex "named lists"
8247 .cindex "list" "named"
8248 A list of domains, hosts, email addresses, or local parts can be given a name
8249 which is then used to refer to the list elsewhere in the configuration. This is
8250 particularly convenient if the same list is required in several different
8251 places. It also allows lists to be given meaningful names, which can improve
8252 the readability of the configuration. For example, it is conventional to define
8253 a domain list called &'local_domains'& for all the domains that are handled
8254 locally on a host, using a configuration line such as
8255 .code
8256 domainlist local_domains = localhost:my.dom.example
8257 .endd
8258 Named lists are referenced by giving their name preceded by a plus sign, so,
8259 for example, a router that is intended to handle local domains would be
8260 configured with the line
8261 .code
8262 domains = +local_domains
8263 .endd
8264 The first router in a configuration is often one that handles all domains
8265 except the local ones, using a configuration with a negated item like this:
8266 .code
8267 dnslookup:
8268   driver = dnslookup
8269   domains = ! +local_domains
8270   transport = remote_smtp
8271   no_more
8272 .endd
8273 The four kinds of named list are created by configuration lines starting with
8274 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8275 respectively. Then there follows the name that you are defining, followed by an
8276 equals sign and the list itself. For example:
8277 .code
8278 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8279 addresslist bad_senders = cdb;/etc/badsenders
8280 .endd
8281 A named list may refer to other named lists:
8282 .code
8283 domainlist  dom1 = first.example : second.example
8284 domainlist  dom2 = +dom1 : third.example
8285 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8286 .endd
8287 &*Warning*&: If the last item in a referenced list is a negative one, the
8288 effect may not be what you intended, because the negation does not propagate
8289 out to the higher level. For example, consider:
8290 .code
8291 domainlist  dom1 = !a.b
8292 domainlist  dom2 = +dom1 : *.b
8293 .endd
8294 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8295 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8296 means it matches the second list as well. The effect is not the same as
8297 .code
8298 domainlist  dom2 = !a.b : *.b
8299 .endd
8300 where &'x.y'& does not match. It's best to avoid negation altogether in
8301 referenced lists if you can.
8302
8303 .new
8304 .cindex "hiding named list values"
8305 .cindex "named lists" "hiding value of"
8306 Some named list definitions may contain sensitive data, for example, passwords for
8307 accessing databases. To stop non-admin users from using the &%-bP%& command
8308 line option to read these values, you can precede the definition with the
8309 word &"hide"&. For example:
8310 .code
8311 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8312 .endd
8313 .wen
8314
8315
8316 Named lists may have a performance advantage. When Exim is routing an
8317 address or checking an incoming message, it caches the result of tests on named
8318 lists. So, if you have a setting such as
8319 .code
8320 domains = +local_domains
8321 .endd
8322 on several of your routers
8323 or in several ACL statements,
8324 the actual test is done only for the first one. However, the caching works only
8325 if there are no expansions within the list itself or any sublists that it
8326 references. In other words, caching happens only for lists that are known to be
8327 the same each time they are referenced.
8328
8329 By default, there may be up to 16 named lists of each type. This limit can be
8330 extended by changing a compile-time variable. The use of domain and host lists
8331 is recommended for concepts such as local domains, relay domains, and relay
8332 hosts. The default configuration is set up like this.
8333
8334
8335
8336 .section "Named lists compared with macros" "SECID78"
8337 .cindex "list" "named compared with macro"
8338 .cindex "macro" "compared with named list"
8339 At first sight, named lists might seem to be no different from macros in the
8340 configuration file. However, macros are just textual substitutions. If you
8341 write
8342 .code
8343 ALIST = host1 : host2
8344 auth_advertise_hosts = !ALIST
8345 .endd
8346 it probably won't do what you want, because that is exactly the same as
8347 .code
8348 auth_advertise_hosts = !host1 : host2
8349 .endd
8350 Notice that the second host name is not negated. However, if you use a host
8351 list, and write
8352 .code
8353 hostlist alist = host1 : host2
8354 auth_advertise_hosts = ! +alist
8355 .endd
8356 the negation applies to the whole list, and so that is equivalent to
8357 .code
8358 auth_advertise_hosts = !host1 : !host2
8359 .endd
8360
8361
8362 .section "Named list caching" "SECID79"
8363 .cindex "list" "caching of named"
8364 .cindex "caching" "named lists"
8365 While processing a message, Exim caches the result of checking a named list if
8366 it is sure that the list is the same each time. In practice, this means that
8367 the cache operates only if the list contains no $ characters, which guarantees
8368 that it will not change when it is expanded. Sometimes, however, you may have
8369 an expanded list that you know will be the same each time within a given
8370 message. For example:
8371 .code
8372 domainlist special_domains = \
8373            ${lookup{$sender_host_address}cdb{/some/file}}
8374 .endd
8375 This provides a list of domains that depends only on the sending host's IP
8376 address. If this domain list is referenced a number of times (for example,
8377 in several ACL lines, or in several routers) the result of the check is not
8378 cached by default, because Exim does not know that it is going to be the
8379 same list each time.
8380
8381 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8382 cache the result anyway. For example:
8383 .code
8384 domainlist_cache special_domains = ${lookup{...
8385 .endd
8386 If you do this, you should be absolutely sure that caching is going to do
8387 the right thing in all cases. When in doubt, leave it out.
8388
8389
8390
8391 .section "Domain lists" "SECTdomainlist"
8392 .cindex "domain list" "patterns for"
8393 .cindex "list" "domain list"
8394 Domain lists contain patterns that are to be matched against a mail domain.
8395 The following types of item may appear in domain lists:
8396
8397 .ilist
8398 .cindex "primary host name"
8399 .cindex "host name" "matched in domain list"
8400 .oindex "&%primary_hostname%&"
8401 .cindex "domain list" "matching primary host name"
8402 .cindex "@ in a domain list"
8403 If a pattern consists of a single @ character, it matches the local host name,
8404 as set by the &%primary_hostname%& option (or defaulted). This makes it
8405 possible to use the same configuration file on several different hosts that
8406 differ only in their names.
8407 .next
8408 .cindex "@[] in a domain list"
8409 .cindex "domain list" "matching local IP interfaces"
8410 .cindex "domain literal"
8411 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8412 in square brackets (as in an email address that contains a domain literal), but
8413 only if that IP address is recognized as local for email routing purposes. The
8414 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8415 control which of a host's several IP addresses are treated as local.
8416 In today's Internet, the use of domain literals is controversial.
8417 .next
8418 .cindex "@mx_any"
8419 .cindex "@mx_primary"
8420 .cindex "@mx_secondary"
8421 .cindex "domain list" "matching MX pointers to local host"
8422 If a pattern consists of the string &`@mx_any`& it matches any domain that
8423 has an MX record pointing to the local host or to any host that is listed in
8424 .oindex "&%hosts_treat_as_local%&"
8425 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8426 are similar, except that the first matches only when a primary MX target is the
8427 local host, and the second only when no primary MX target is the local host,
8428 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8429 preference value &-- there may of course be more than one of them.
8430
8431 The MX lookup that takes place when matching a pattern of this type is
8432 performed with the resolver options for widening names turned off. Thus, for
8433 example, a single-component domain will &'not'& be expanded by adding the
8434 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8435 options of the &(dnslookup)& router for a discussion of domain widening.
8436
8437 Sometimes you may want to ignore certain IP addresses when using one of these
8438 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8439 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8440 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8441 on a router). For example:
8442 .code
8443 domains = @mx_any/ignore=127.0.0.1
8444 .endd
8445 This example matches any domain that has an MX record pointing to one of
8446 the local host's IP addresses other than 127.0.0.1.
8447
8448 The list of IP addresses is in fact processed by the same code that processes
8449 host lists, so it may contain CIDR-coded network specifications and it may also
8450 contain negative items.
8451
8452 Because the list of IP addresses is a sublist within a domain list, you have to
8453 be careful about delimiters if there is more than one address. Like any other
8454 list, the default delimiter can be changed. Thus, you might have:
8455 .code
8456 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8457           an.other.domain : ...
8458 .endd
8459 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8460 involved, it is easiest to change the delimiter for the main list as well:
8461 .code
8462 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8463           an.other.domain ? ...
8464 .endd
8465 .next
8466 .cindex "asterisk" "in domain list"
8467 .cindex "domain list" "asterisk in"
8468 .cindex "domain list" "matching &""ends with""&"
8469 If a pattern starts with an asterisk, the remaining characters of the pattern
8470 are compared with the terminating characters of the domain. The use of &"*"& in
8471 domain lists differs from its use in partial matching lookups. In a domain
8472 list, the character following the asterisk need not be a dot, whereas partial
8473 matching works only in terms of dot-separated components. For example, a domain
8474 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8475 &'cipher.key.ex'&.
8476
8477 .next
8478 .cindex "regular expressions" "in domain list"
8479 .cindex "domain list" "matching regular expression"
8480 If a pattern starts with a circumflex character, it is treated as a regular
8481 expression, and matched against the domain using a regular expression matching
8482 function. The circumflex is treated as part of the regular expression.
8483 Email domains are case-independent, so this regular expression match is by
8484 default case-independent, but you can make it case-dependent by starting it
8485 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8486 are given in chapter &<<CHAPregexp>>&.
8487
8488 &*Warning*&: Because domain lists are expanded before being processed, you
8489 must escape any backslash and dollar characters in the regular expression, or
8490 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8491 it is not to be expanded (unless you really do want to build a regular
8492 expression by expansion, of course).
8493 .next
8494 .cindex "lookup" "in domain list"
8495 .cindex "domain list" "matching by lookup"
8496 If a pattern starts with the name of a single-key lookup type followed by a
8497 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8498 must be a filename in a suitable format for the lookup type. For example, for
8499 &"cdb;"& it must be an absolute path:
8500 .code
8501 domains = cdb;/etc/mail/local_domains.cdb
8502 .endd
8503 The appropriate type of lookup is done on the file using the domain name as the
8504 key. In most cases, the data that is looked up is not used; Exim is interested
8505 only in whether or not the key is present in the file. However, when a lookup
8506 is used for the &%domains%& option on a router
8507 or a &%domains%& condition in an ACL statement, the data is preserved in the
8508 &$domain_data$& variable and can be referred to in other router options or
8509 other statements in the same ACL.
8510
8511 .next
8512 Any of the single-key lookup type names may be preceded by
8513 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8514 .code
8515 domains = partial-dbm;/partial/domains
8516 .endd
8517 This causes partial matching logic to be invoked; a description of how this
8518 works is given in section &<<SECTpartiallookup>>&.
8519
8520 .next
8521 .cindex "asterisk" "in lookup type"
8522 Any of the single-key lookup types may be followed by an asterisk. This causes
8523 a default lookup for a key consisting of a single asterisk to be done if the
8524 original lookup fails. This is not a useful feature when using a domain list to
8525 select particular domains (because any domain would match), but it might have
8526 value if the result of the lookup is being used via the &$domain_data$&
8527 expansion variable.
8528 .next
8529 If the pattern starts with the name of a query-style lookup type followed by a
8530 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8531 pattern must be an appropriate query for the lookup type, as described in
8532 chapter &<<CHAPfdlookup>>&. For example:
8533 .code
8534 hold_domains = mysql;select domain from holdlist \
8535   where domain = '${quote_mysql:$domain}';
8536 .endd
8537 In most cases, the data that is looked up is not used (so for an SQL query, for
8538 example, it doesn't matter what field you select). Exim is interested only in
8539 whether or not the query succeeds. However, when a lookup is used for the
8540 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8541 variable and can be referred to in other options.
8542 .next
8543 .cindex "domain list" "matching literal domain name"
8544 If none of the above cases apply, a caseless textual comparison is made
8545 between the pattern and the domain.
8546 .endlist
8547
8548 Here is an example that uses several different kinds of pattern:
8549 .code
8550 domainlist funny_domains = \
8551   @ : \
8552   lib.unseen.edu : \
8553   *.foundation.fict.example : \
8554   \N^[1-2]\d{3}\.fict\.example$\N : \
8555   partial-dbm;/opt/data/penguin/book : \
8556   nis;domains.byname : \
8557   nisplus;[name=$domain,status=local],domains.org_dir
8558 .endd
8559 There are obvious processing trade-offs among the various matching modes. Using
8560 an asterisk is faster than a regular expression, and listing a few names
8561 explicitly probably is too. The use of a file or database lookup is expensive,
8562 but may be the only option if hundreds of names are required. Because the
8563 patterns are tested in order, it makes sense to put the most commonly matched
8564 patterns earlier.
8565
8566
8567
8568 .section "Host lists" "SECThostlist"
8569 .cindex "host list" "patterns in"
8570 .cindex "list" "host list"
8571 Host lists are used to control what remote hosts are allowed to do. For
8572 example, some hosts may be allowed to use the local host as a relay, and some
8573 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8574 two different ways, by name or by IP address. In a host list, some types of
8575 pattern are matched to a host name, and some are matched to an IP address.
8576 You need to be particularly careful with this when single-key lookups are
8577 involved, to ensure that the right value is being used as the key.
8578
8579
8580 .section "Special host list patterns" "SECID80"
8581 .cindex "empty item in hosts list"
8582 .cindex "host list" "empty string in"
8583 If a host list item is the empty string, it matches only when no remote host is
8584 involved. This is the case when a message is being received from a local
8585 process using SMTP on the standard input, that is, when a TCP/IP connection is
8586 not used.
8587
8588 .cindex "asterisk" "in host list"
8589 The special pattern &"*"& in a host list matches any host or no host. Neither
8590 the IP address nor the name is actually inspected.
8591
8592
8593
8594 .section "Host list patterns that match by IP address" "SECThoslispatip"
8595 .cindex "host list" "matching IP addresses"
8596 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8597 the incoming address actually appears in the IPv6 host as
8598 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8599 list, it is converted into a traditional IPv4 address first. (Not all operating
8600 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8601 concerns.)
8602
8603 The following types of pattern in a host list check the remote host by
8604 inspecting its IP address:
8605
8606 .ilist
8607 If the pattern is a plain domain name (not a regular expression, not starting
8608 with *, not a lookup of any kind), Exim calls the operating system function
8609 to find the associated IP address(es). Exim uses the newer
8610 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8611 This typically causes a forward DNS lookup of the name. The result is compared
8612 with the IP address of the subject host.
8613
8614 If there is a temporary problem (such as a DNS timeout) with the host name
8615 lookup, a temporary error occurs. For example, if the list is being used in an
8616 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8617 temporary SMTP error code. If no IP address can be found for the host name,
8618 what happens is described in section &<<SECTbehipnot>>& below.
8619
8620 .next
8621 .cindex "@ in a host list"
8622 If the pattern is &"@"&, the primary host name is substituted and used as a
8623 domain name, as just described.
8624
8625 .next
8626 If the pattern is an IP address, it is matched against the IP address of the
8627 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8628 IPv6 addresses can be given in colon-separated format, but the colons have to
8629 be doubled so as not to be taken as item separators when the default list
8630 separator is used. IPv6 addresses are recognized even when Exim is compiled
8631 without IPv6 support. This means that if they appear in a host list on an
8632 IPv4-only host, Exim will not treat them as host names. They are just addresses
8633 that can never match a client host.
8634
8635 .next
8636 .cindex "@[] in a host list"
8637 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8638 the local host. For example, if the local host is an IPv4 host with one
8639 interface address 10.45.23.56, these two ACL statements have the same effect:
8640 .code
8641 accept hosts = 127.0.0.1 : 10.45.23.56
8642 accept hosts = @[]
8643 .endd
8644 .next
8645 .cindex "CIDR notation"
8646 If the pattern is an IP address followed by a slash and a mask length (for
8647 example 10.11.42.0/24), it is matched against the IP address of the subject
8648 host under the given mask. This allows, an entire network of hosts to be
8649 included (or excluded) by a single item. The mask uses CIDR notation; it
8650 specifies the number of address bits that must match, starting from the most
8651 significant end of the address.
8652
8653 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8654 of a range of addresses. It is the number of bits in the network portion of the
8655 address. The above example specifies a 24-bit netmask, so it matches all 256
8656 addresses in the 10.11.42.0 network. An item such as
8657 .code
8658 192.168.23.236/31
8659 .endd
8660 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8661 32 for an IPv4 address is the same as no mask at all; just a single address
8662 matches.
8663
8664 Here is another example which shows an IPv4 and an IPv6 network:
8665 .code
8666 recipient_unqualified_hosts = 192.168.0.0/16: \
8667                               3ffe::ffff::836f::::/48
8668 .endd
8669 The doubling of list separator characters applies only when these items
8670 appear inline in a host list. It is not required when indirecting via a file.
8671 For example:
8672 .code
8673 recipient_unqualified_hosts = /opt/exim/unqualnets
8674 .endd
8675 could make use of a file containing
8676 .code
8677 172.16.0.0/12
8678 3ffe:ffff:836f::/48
8679 .endd
8680 to have exactly the same effect as the previous example. When listing IPv6
8681 addresses inline, it is usually more convenient to use the facility for
8682 changing separator characters. This list contains the same two networks:
8683 .code
8684 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8685                                  3ffe:ffff:836f::/48
8686 .endd
8687 The separator is changed to semicolon by the leading &"<;"& at the start of the
8688 list.
8689 .endlist
8690
8691
8692
8693 .section "Host list patterns for single-key lookups by host address" &&&
8694          "SECThoslispatsikey"
8695 .cindex "host list" "lookup of IP address"
8696 When a host is to be identified by a single-key lookup of its complete IP
8697 address, the pattern takes this form:
8698 .display
8699 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8700 .endd
8701 For example:
8702 .code
8703 hosts_lookup = net-cdb;/hosts-by-ip.db
8704 .endd
8705 The text form of the IP address of the subject host is used as the lookup key.
8706 IPv6 addresses are converted to an unabbreviated form, using lower case
8707 letters, with dots as separators because colon is the key terminator in
8708 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8709 quoting the keys, but this is a facility that was added later.] The data
8710 returned by the lookup is not used.
8711
8712 .cindex "IP address" "masking"
8713 .cindex "host list" "masked IP address"
8714 Single-key lookups can also be performed using masked IP addresses, using
8715 patterns of this form:
8716 .display
8717 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8718 .endd
8719 For example:
8720 .code
8721 net24-dbm;/networks.db
8722 .endd
8723 The IP address of the subject host is masked using <&'number'&> as the mask
8724 length. A textual string is constructed from the masked value, followed by the
8725 mask, and this is used as the lookup key. For example, if the host's IP address
8726 is 192.168.34.6, the key that is looked up for the above example is
8727 &"192.168.34.0/24"&.
8728
8729 When an IPv6 address is converted to a string, dots are normally used instead
8730 of colons, so that keys in &(lsearch)& files need not contain colons (which
8731 terminate &(lsearch)& keys). This was implemented some time before the ability
8732 to quote keys was made available in &(lsearch)& files. However, the more
8733 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8734 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8735 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8736 converted using colons and not dots.
8737 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8738 addresses are always used.
8739 The latter are converted to IPv4 addresses, in dotted-quad form.
8740
8741 Ideally, it would be nice to tidy up this anomalous situation by changing to
8742 colons in all cases, given that quoting is now available for &(lsearch)&.
8743 However, this would be an incompatible change that might break some existing
8744 configurations.
8745
8746 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8747 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8748 the former case the key strings include the mask value, whereas in the latter
8749 case the IP address is used on its own.
8750
8751
8752
8753 .section "Host list patterns that match by host name" "SECThoslispatnam"
8754 .cindex "host" "lookup failures"
8755 .cindex "unknown host name"
8756 .cindex "host list" "matching host name"
8757 There are several types of pattern that require Exim to know the name of the
8758 remote host. These are either wildcard patterns or lookups by name. (If a
8759 complete hostname is given without any wildcarding, it is used to find an IP
8760 address to match against, as described in section &<<SECThoslispatip>>&
8761 above.)
8762
8763 If the remote host name is not already known when Exim encounters one of these
8764 patterns, it has to be found from the IP address.
8765 Although many sites on the Internet are conscientious about maintaining reverse
8766 DNS data for their hosts, there are also many that do not do this.
8767 Consequently, a name cannot always be found, and this may lead to unwanted
8768 effects. Take care when configuring host lists with wildcarded name patterns.
8769 Consider what will happen if a name cannot be found.
8770
8771 Because of the problems of determining host names from IP addresses, matching
8772 against host names is not as common as matching against IP addresses.
8773
8774 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8775 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8776 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8777 are done can be changed by setting the &%host_lookup_order%& option. For
8778 security, once Exim has found one or more names, it looks up the IP addresses
8779 for these names and compares them with the IP address that it started with.
8780 Only those names whose IP addresses match are accepted. Any other names are
8781 discarded. If no names are left, Exim behaves as if the host name cannot be
8782 found. In the most common case there is only one name and one IP address.
8783
8784 There are some options that control what happens if a host name cannot be
8785 found. These are described in section &<<SECTbehipnot>>& below.
8786
8787 .cindex "host" "alias for"
8788 .cindex "alias for host"
8789 As a result of aliasing, hosts may have more than one name. When processing any
8790 of the following types of pattern, all the host's names are checked:
8791
8792 .ilist
8793 .cindex "asterisk" "in host list"
8794 If a pattern starts with &"*"& the remainder of the item must match the end of
8795 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8796 &'.b.c'&. This special simple form is provided because this is a very common
8797 requirement. Other kinds of wildcarding require the use of a regular
8798 expression.
8799 .next
8800 .cindex "regular expressions" "in host list"
8801 .cindex "host list" "regular expression in"
8802 If the item starts with &"^"& it is taken to be a regular expression which is
8803 matched against the host name. Host names are case-independent, so this regular
8804 expression match is by default case-independent, but you can make it
8805 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8806 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8807 example,
8808 .code
8809 ^(a|b)\.c\.d$
8810 .endd
8811 is a regular expression that matches either of the two hosts &'a.c.d'& or
8812 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8813 that backslash and dollar characters are not misinterpreted as part of the
8814 string expansion. The simplest way to do this is to use &`\N`& to mark that
8815 part of the string as non-expandable. For example:
8816 .code
8817 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8818 .endd
8819 &*Warning*&: If you want to match a complete host name, you must include the
8820 &`$`& terminating metacharacter in the regular expression, as in the above
8821 example. Without it, a match at the start of the host name is all that is
8822 required.
8823 .endlist
8824
8825
8826
8827
8828 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8829 .cindex "host" "lookup failures, permanent"
8830 While processing a host list, Exim may need to look up an IP address from a
8831 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8832 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8833 behaviour when it fails to find the information it is seeking is the same.
8834
8835 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8836 apply to temporary DNS errors, whose handling is described in the next section.
8837
8838 .cindex "&`+include_unknown`&"
8839 .cindex "&`+ignore_unknown`&"
8840 Exim parses a host list from left to right. If it encounters a permanent
8841 lookup failure in any item in the host list before it has found a match,
8842 Exim treats it as a failure and the default behavior is as if the host
8843 does not match the list. This may not always be what you want to happen.
8844 To change Exim's behaviour, the special items &`+include_unknown`& or
8845 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8846 not recognized in an indirected file).
8847
8848 .ilist
8849 If any item that follows &`+include_unknown`& requires information that
8850 cannot found, Exim behaves as if the host does match the list. For example,
8851 .code
8852 host_reject_connection = +include_unknown:*.enemy.ex
8853 .endd
8854 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8855 any hosts whose name it cannot find.
8856
8857 .next
8858 If any item that follows &`+ignore_unknown`& requires information that cannot
8859 be found, Exim ignores that item and proceeds to the rest of the list. For
8860 example:
8861 .code
8862 accept hosts = +ignore_unknown : friend.example : \
8863                192.168.4.5
8864 .endd
8865 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8866 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8867 name can be found for 192.168.4.5, it is rejected.
8868 .endlist
8869
8870 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8871 list. The effect of each one lasts until the next, or until the end of the
8872 list.
8873
8874 .section "Mixing wildcarded host names and addresses in host lists" &&&
8875          "SECTmixwilhos"
8876 .cindex "host list" "mixing names and addresses in"
8877
8878 This section explains the host/ip processing logic with the same concepts
8879 as the previous section, but specifically addresses what happens when a
8880 wildcarded hostname is one of the items in the hostlist.
8881
8882 .ilist
8883 If you have name lookups or wildcarded host names and
8884 IP addresses in the same host list, you should normally put the IP
8885 addresses first. For example, in an ACL you could have:
8886 .code
8887 accept hosts = 10.9.8.7 : *.friend.example
8888 .endd
8889 The reason you normally would order it this way lies in the
8890 left-to-right way that Exim processes lists.  It can test IP addresses
8891 without doing any DNS lookups, but when it reaches an item that requires
8892 a host name, it fails if it cannot find a host name to compare with the
8893 pattern. If the above list is given in the opposite order, the
8894 &%accept%& statement fails for a host whose name cannot be found, even
8895 if its IP address is 10.9.8.7.
8896
8897 .next
8898 If you really do want to do the name check first, and still recognize the IP
8899 address, you can rewrite the ACL like this:
8900 .code
8901 accept hosts = *.friend.example
8902 accept hosts = 10.9.8.7
8903 .endd
8904 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8905 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8906 &`+ignore_unknown`&, which was discussed in depth in the first example in
8907 this section.
8908 .endlist
8909
8910
8911 .section "Temporary DNS errors when looking up host information" &&&
8912          "SECTtemdnserr"
8913 .cindex "host" "lookup failures, temporary"
8914 .cindex "&`+include_defer`&"
8915 .cindex "&`+ignore_defer`&"
8916 A temporary DNS lookup failure normally causes a defer action (except when
8917 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8918 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8919 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8920 section. These options should be used with care, probably only in non-critical
8921 host lists such as whitelists.
8922
8923
8924
8925 .section "Host list patterns for single-key lookups by host name" &&&
8926          "SECThoslispatnamsk"
8927 .cindex "unknown host name"
8928 .cindex "host list" "matching host name"
8929 If a pattern is of the form
8930 .display
8931 <&'single-key-search-type'&>;<&'search-data'&>
8932 .endd
8933 for example
8934 .code
8935 dbm;/host/accept/list
8936 .endd
8937 a single-key lookup is performed, using the host name as its key. If the
8938 lookup succeeds, the host matches the item. The actual data that is looked up
8939 is not used.
8940
8941 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8942 keys in the file, not IP addresses. If you want to do lookups based on IP
8943 addresses, you must precede the search type with &"net-"& (see section
8944 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8945 two items in the same list, one doing an address lookup and one doing a name
8946 lookup, both using the same file.
8947
8948
8949
8950 .section "Host list patterns for query-style lookups" "SECID81"
8951 If a pattern is of the form
8952 .display
8953 <&'query-style-search-type'&>;<&'query'&>
8954 .endd
8955 the query is obeyed, and if it succeeds, the host matches the item. The actual
8956 data that is looked up is not used. The variables &$sender_host_address$& and
8957 &$sender_host_name$& can be used in the query. For example:
8958 .code
8959 hosts_lookup = pgsql;\
8960   select ip from hostlist where ip='$sender_host_address'
8961 .endd
8962 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8963 can use the &%sg%& expansion item to change this if you need to. If you want to
8964 use masked IP addresses in database queries, you can use the &%mask%& expansion
8965 operator.
8966
8967 If the query contains a reference to &$sender_host_name$&, Exim automatically
8968 looks up the host name if it has not already done so. (See section
8969 &<<SECThoslispatnam>>& for comments on finding host names.)
8970
8971 Historical note: prior to release 4.30, Exim would always attempt to find a
8972 host name before running the query, unless the search type was preceded by
8973 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8974 still recognized for query-style lookups, but its presence or absence has no
8975 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8976 See section &<<SECThoslispatsikey>>&.)
8977
8978
8979
8980
8981
8982 .section "Address lists" "SECTaddresslist"
8983 .cindex "list" "address list"
8984 .cindex "address list" "empty item"
8985 .cindex "address list" "patterns"
8986 Address lists contain patterns that are matched against mail addresses. There
8987 is one special case to be considered: the sender address of a bounce message is
8988 always empty. You can test for this by providing an empty item in an address
8989 list. For example, you can set up a router to process bounce messages by
8990 using this option setting:
8991 .code
8992 senders = :
8993 .endd
8994 The presence of the colon creates an empty item. If you do not provide any
8995 data, the list is empty and matches nothing. The empty sender can also be
8996 detected by a regular expression that matches an empty string,
8997 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8998
8999 Non-empty items in an address list can be straightforward email addresses. For
9000 example:
9001 .code
9002 senders = jbc@askone.example : hs@anacreon.example
9003 .endd
9004 A certain amount of wildcarding is permitted. If a pattern contains an @
9005 character, but is not a regular expression and does not begin with a
9006 semicolon-terminated lookup type (described below), the local part of the
9007 subject address is compared with the local part of the pattern, which may start
9008 with an asterisk. If the local parts match, the domain is checked in exactly
9009 the same way as for a pattern in a domain list. For example, the domain can be
9010 wildcarded, refer to a named list, or be a lookup:
9011 .code
9012 deny senders = *@*.spamming.site:\
9013                *@+hostile_domains:\
9014                bozo@partial-lsearch;/list/of/dodgy/sites:\
9015                *@dbm;/bad/domains.db
9016 .endd
9017 .cindex "local part" "starting with !"
9018 .cindex "address list" "local part starting with !"
9019 If a local part that begins with an exclamation mark is required, it has to be
9020 specified using a regular expression, because otherwise the exclamation mark is
9021 treated as a sign of negation, as is standard in lists.
9022
9023 If a non-empty pattern that is not a regular expression or a lookup does not
9024 contain an @ character, it is matched against the domain part of the subject
9025 address. The only two formats that are recognized this way are a literal
9026 domain, or a domain pattern that starts with *. In both these cases, the effect
9027 is the same as if &`*@`& preceded the pattern. For example:
9028 .code
9029 deny senders = enemy.domain : *.enemy.domain
9030 .endd
9031
9032 The following kinds of more complicated address list pattern can match any
9033 address, including the empty address that is characteristic of bounce message
9034 senders:
9035
9036 .ilist
9037 .cindex "regular expressions" "in address list"
9038 .cindex "address list" "regular expression in"
9039 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9040 done against the complete address, with the pattern as the regular expression.
9041 You must take care that backslash and dollar characters are not misinterpreted
9042 as part of the string expansion. The simplest way to do this is to use &`\N`&
9043 to mark that part of the string as non-expandable. For example:
9044 .code
9045 deny senders = \N^.*this.*@example\.com$\N : \
9046                \N^\d{8}.+@spamhaus.example$\N : ...
9047 .endd
9048 The &`\N`& sequences are removed by the expansion, so these items do indeed
9049 start with &"^"& by the time they are being interpreted as address patterns.
9050
9051 .next
9052 .cindex "address list" "lookup for complete address"
9053 Complete addresses can be looked up by using a pattern that starts with a
9054 lookup type terminated by a semicolon, followed by the data for the lookup. For
9055 example:
9056 .code
9057 deny senders = cdb;/etc/blocked.senders : \
9058   mysql;select address from blocked where \
9059   address='${quote_mysql:$sender_address}'
9060 .endd
9061 Both query-style and single-key lookup types can be used. For a single-key
9062 lookup type, Exim uses the complete address as the key. However, empty keys are
9063 not supported for single-key lookups, so a match against the empty address
9064 always fails. This restriction does not apply to query-style lookups.
9065
9066 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9067 cannot be used, and is ignored if specified, with an entry being written to the
9068 panic log.
9069 .cindex "*@ with single-key lookup"
9070 However, you can configure lookup defaults, as described in section
9071 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9072 default. For example, with this lookup:
9073 .code
9074 accept senders = lsearch*@;/some/file
9075 .endd
9076 the file could contains lines like this:
9077 .code
9078 user1@domain1.example
9079 *@domain2.example
9080 .endd
9081 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9082 that are tried is:
9083 .code
9084 nimrod@jaeger.example
9085 *@jaeger.example
9086 *
9087 .endd
9088 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9089 would mean that every address matches, thus rendering the test useless.
9090
9091 &*Warning 2*&: Do not confuse these two kinds of item:
9092 .code
9093 deny recipients = dbm*@;/some/file
9094 deny recipients = *@dbm;/some/file
9095 .endd
9096 The first does a whole address lookup, with defaulting, as just described,
9097 because it starts with a lookup type. The second matches the local part and
9098 domain independently, as described in a bullet point below.
9099 .endlist
9100
9101
9102 The following kinds of address list pattern can match only non-empty addresses.
9103 If the subject address is empty, a match against any of these pattern types
9104 always fails.
9105
9106
9107 .ilist
9108 .cindex "@@ with single-key lookup"
9109 .cindex "address list" "@@ lookup type"
9110 .cindex "address list" "split local part and domain"
9111 If a pattern starts with &"@@"& followed by a single-key lookup item
9112 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9113 split into a local part and a domain. The domain is looked up in the file. If
9114 it is not found, there is no match. If it is found, the data that is looked up
9115 from the file is treated as a colon-separated list of local part patterns, each
9116 of which is matched against the subject local part in turn.
9117
9118 .cindex "asterisk" "in address list"
9119 The lookup may be a partial one, and/or one involving a search for a default
9120 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9121 patterns that are looked up can be regular expressions or begin with &"*"&, or
9122 even be further lookups. They may also be independently negated. For example,
9123 with
9124 .code
9125 deny senders = @@dbm;/etc/reject-by-domain
9126 .endd
9127 the data from which the DBM file is built could contain lines like
9128 .code
9129 baddomain.com:  !postmaster : *
9130 .endd
9131 to reject all senders except &%postmaster%& from that domain.
9132
9133 .cindex "local part" "starting with !"
9134 If a local part that actually begins with an exclamation mark is required, it
9135 has to be specified using a regular expression. In &(lsearch)& files, an entry
9136 may be split over several lines by indenting the second and subsequent lines,
9137 but the separating colon must still be included at line breaks. White space
9138 surrounding the colons is ignored. For example:
9139 .code
9140 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9141   spammer3 : spammer4
9142 .endd
9143 As in all colon-separated lists in Exim, a colon can be included in an item by
9144 doubling.
9145
9146 If the last item in the list starts with a right angle-bracket, the remainder
9147 of the item is taken as a new key to look up in order to obtain a continuation
9148 list of local parts. The new key can be any sequence of characters. Thus one
9149 might have entries like
9150 .code
9151 aol.com: spammer1 : spammer 2 : >*
9152 xyz.com: spammer3 : >*
9153 *:       ^\d{8}$
9154 .endd
9155 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9156 local parts for all domains, in addition to the specific local parts listed for
9157 each domain. Of course, using this feature costs another lookup each time a
9158 chain is followed, but the effort needed to maintain the data is reduced.
9159
9160 .cindex "loop" "in lookups"
9161 It is possible to construct loops using this facility, and in order to catch
9162 them, the chains may be no more than fifty items long.
9163
9164 .next
9165 The @@<&'lookup'&> style of item can also be used with a query-style
9166 lookup, but in this case, the chaining facility is not available. The lookup
9167 can only return a single list of local parts.
9168 .endlist
9169
9170 &*Warning*&: There is an important difference between the address list items
9171 in these two examples:
9172 .code
9173 senders = +my_list
9174 senders = *@+my_list
9175 .endd
9176 In the first one, &`my_list`& is a named address list, whereas in the second
9177 example it is a named domain list.
9178
9179
9180
9181
9182 .section "Case of letters in address lists" "SECTcasletadd"
9183 .cindex "case of local parts"
9184 .cindex "address list" "case forcing"
9185 .cindex "case forcing in address lists"
9186 Domains in email addresses are always handled caselessly, but for local parts
9187 case may be significant on some systems (see &%caseful_local_part%& for how
9188 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9189 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9190 blocking lists should be done in a case-independent manner. Since most address
9191 lists in Exim are used for this kind of control, Exim attempts to do this by
9192 default.
9193
9194 The domain portion of an address is always lowercased before matching it to an
9195 address list. The local part is lowercased by default, and any string
9196 comparisons that take place are done caselessly. This means that the data in
9197 the address list itself, in files included as plain filenames, and in any file
9198 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9199 keys in files that are looked up by a search type other than &(lsearch)& (which
9200 works caselessly) must be in lower case, because these lookups are not
9201 case-independent.
9202
9203 .cindex "&`+caseful`&"
9204 To allow for the possibility of caseful address list matching, if an item in
9205 an address list is the string &"+caseful"&, the original case of the local
9206 part is restored for any comparisons that follow, and string comparisons are no
9207 longer case-independent. This does not affect the domain, which remains in
9208 lower case. However, although independent matches on the domain alone are still
9209 performed caselessly, regular expressions that match against an entire address
9210 become case-sensitive after &"+caseful"& has been seen.
9211
9212
9213
9214 .section "Local part lists" "SECTlocparlis"
9215 .cindex "list" "local part list"
9216 .cindex "local part" "list"
9217 Case-sensitivity in local part lists is handled in the same way as for address
9218 lists, as just described. The &"+caseful"& item can be used if required. In a
9219 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9220 set false, the subject is lowercased and the matching is initially
9221 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9222 matching in the local part list, but not elsewhere in the router. If
9223 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9224 option is case-sensitive from the start.
9225
9226 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9227 comments are handled in the same way as address lists &-- they are recognized
9228 only if the # is preceded by white space or the start of the line.
9229 Otherwise, local part lists are matched in the same way as domain lists, except
9230 that the special items that refer to the local host (&`@`&, &`@[]`&,
9231 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9232 Refer to section &<<SECTdomainlist>>& for details of the other available item
9233 types.
9234 .ecindex IIDdohoadli
9235
9236
9237
9238
9239 . ////////////////////////////////////////////////////////////////////////////
9240 . ////////////////////////////////////////////////////////////////////////////
9241
9242 .chapter "String expansions" "CHAPexpand"
9243 .scindex IIDstrexp "expansion" "of strings"
9244 Many strings in Exim's runtime configuration are expanded before use. Some of
9245 them are expanded every time they are used; others are expanded only once.
9246
9247 When a string is being expanded it is copied verbatim from left to right except
9248 .cindex expansion "string concatenation"
9249 when a dollar or backslash character is encountered. A dollar specifies the
9250 start of a portion of the string that is interpreted and replaced as described
9251 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9252 escape character, as described in the following section.
9253
9254 Whether a string is expanded depends upon the context.  Usually this is solely
9255 dependent upon the option for which a value is sought; in this documentation,
9256 options for which string expansion is performed are marked with &dagger; after
9257 the data type.  ACL rules always expand strings.  A couple of expansion
9258 conditions do not expand some of the brace-delimited branches, for security
9259 reasons,
9260 .cindex "tainted data" expansion
9261 .cindex expansion "tainted data"
9262 and expansion of data deriving from the sender (&"tainted data"&)
9263 is not permitted.
9264
9265
9266
9267 .section "Literal text in expanded strings" "SECTlittext"
9268 .cindex "expansion" "including literal text"
9269 An uninterpreted dollar can be included in an expanded string by putting a
9270 backslash in front of it. A backslash can be used to prevent any special
9271 character being treated specially in an expansion, including backslash itself.
9272 If the string appears in quotes in the configuration file, two backslashes are
9273 required because the quotes themselves cause interpretation of backslashes when
9274 the string is read in (see section &<<SECTstrings>>&).
9275
9276 .cindex "expansion" "non-expandable substrings"
9277 A portion of the string can specified as non-expandable by placing it between
9278 two occurrences of &`\N`&. This is particularly useful for protecting regular
9279 expressions, which often contain backslashes and dollar signs. For example:
9280 .code
9281 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9282 .endd
9283 On encountering the first &`\N`&, the expander copies subsequent characters
9284 without interpretation until it reaches the next &`\N`& or the end of the
9285 string.
9286
9287
9288
9289 .section "Character escape sequences in expanded strings" "SECID82"
9290 .cindex "expansion" "escape sequences"
9291 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9292 expanded string is recognized as an escape sequence for the character newline,
9293 carriage return, or tab, respectively. A backslash followed by up to three
9294 octal digits is recognized as an octal encoding for a single character, and a
9295 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9296 encoding.
9297
9298 These escape sequences are also recognized in quoted strings when they are read
9299 in. Their interpretation in expansions as well is useful for unquoted strings,
9300 and for other cases such as looked-up strings that are then expanded.
9301
9302
9303 .section "Testing string expansions" "SECID83"
9304 .cindex "expansion" "testing"
9305 .cindex "testing" "string expansion"
9306 .oindex "&%-be%&"
9307 Many expansions can be tested by calling Exim with the &%-be%& option. This
9308 takes the command arguments, or lines from the standard input if there are no
9309 arguments, runs them through the string expansion code, and writes the results
9310 to the standard output. Variables based on configuration values are set up, but
9311 since no message is being processed, variables such as &$local_part$& have no
9312 value. Nevertheless the &%-be%& option can be useful for checking out file and
9313 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9314 and &%nhash%&.
9315
9316 Exim gives up its root privilege when it is called with the &%-be%& option, and
9317 instead runs under the uid and gid it was called with, to prevent users from
9318 using &%-be%& for reading files to which they do not have access.
9319
9320 .oindex "&%-bem%&"
9321 If you want to test expansions that include variables whose values are taken
9322 from a message, there are two other options that can be used. The &%-bem%&
9323 option is like &%-be%& except that it is followed by a filename. The file is
9324 read as a message before doing the test expansions. For example:
9325 .code
9326 exim -bem /tmp/test.message '$h_subject:'
9327 .endd
9328 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9329 Exim message identifier. For example:
9330 .code
9331 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9332 .endd
9333 This loads the message from Exim's spool before doing the test expansions, and
9334 is therefore restricted to admin users.
9335
9336
9337 .section "Forced expansion failure" "SECTforexpfai"
9338 .cindex "expansion" "forced failure"
9339 A number of expansions that are described in the following section have
9340 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9341 (which are sometimes called &"curly brackets"&). Which of the two strings is
9342 used depends on some condition that is evaluated as part of the expansion. If,
9343 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9344 the entire string expansion fails in a way that can be detected by the code
9345 that requested the expansion. This is called &"forced expansion failure"&, and
9346 its consequences depend on the circumstances. In some cases it is no different
9347 from any other expansion failure, but in others a different action may be
9348 taken. Such variations are mentioned in the documentation of the option that is
9349 being expanded.
9350
9351
9352
9353
9354 .section "Expansion items" "SECTexpansionitems"
9355 The following items are recognized in expanded strings. White space may be used
9356 between sub-items that are keywords or substrings enclosed in braces inside an
9357 outer set of braces, to improve readability. &*Warning*&: Within braces,
9358 white space is significant.
9359
9360 .vlist
9361 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9362 .cindex "expansion" "variables"
9363 Substitute the contents of the named variable, for example:
9364 .code
9365 $local_part
9366 ${domain}
9367 .endd
9368 The second form can be used to separate the name from subsequent alphanumeric
9369 characters. This form (using braces) is available only for variables; it does
9370 &'not'& apply to message headers. The names of the variables are given in
9371 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9372 given, the expansion fails.
9373
9374 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9375 .cindex "expansion" "operators"
9376 The string is first itself expanded, and then the operation specified by
9377 <&'op'&> is applied to it. For example:
9378 .code
9379 ${lc:$local_part}
9380 .endd
9381 The string starts with the first character after the colon, which may be
9382 leading white space. A list of operators is given in section &<<SECTexpop>>&
9383 below. The operator notation is used for simple expansion items that have just
9384 one argument, because it reduces the number of braces and therefore makes the
9385 string easier to understand.
9386
9387 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9388 This item inserts &"basic"& header lines. It is described with the &%header%&
9389 expansion item below.
9390
9391
9392 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9393 .cindex "expansion" "calling an acl"
9394 .cindex "&%acl%&" "call from expansion"
9395 The name and zero to nine argument strings are first expanded separately.  The expanded
9396 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9397 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9398 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9399 and may use the variables; if another acl expansion is used the values
9400 are restored after it returns.  If the ACL sets
9401 a value using a "message =" modifier and returns accept or deny, the value becomes
9402 the result of the expansion.
9403 If no message is set and the ACL returns accept or deny
9404 the expansion result is an empty string.
9405 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9406
9407
9408 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9409 .cindex authentication "results header"
9410 .cindex headers "authentication-results:"
9411 .cindex authentication "expansion item"
9412 This item returns a string suitable for insertion as an
9413 &'Authentication-Results:'&
9414 header line.
9415 The given <&'authserv-id'&> is included in the result; typically this
9416 will be a domain name identifying the system performing the authentications.
9417 Methods that might be present in the result include:
9418 .code
9419 none
9420 iprev
9421 auth
9422 spf
9423 dkim
9424 .endd
9425
9426 Example use (as an ACL modifier):
9427 .code
9428       add_header = :at_start:${authresults {$primary_hostname}}
9429 .endd
9430 This is safe even if no authentication results are available.
9431
9432
9433 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9434        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9435 .cindex "expansion" "extracting certificate fields"
9436 .cindex "&%certextract%&" "certificate fields"
9437 .cindex "certificate" "extracting fields"
9438 The <&'certificate'&> must be a variable of type certificate.
9439 The field name is expanded and used to retrieve the relevant field from
9440 the certificate.  Supported fields are:
9441 .display
9442 &`version        `&
9443 &`serial_number  `&
9444 &`subject        `& RFC4514 DN
9445 &`issuer         `& RFC4514 DN
9446 &`notbefore      `& time
9447 &`notafter       `& time
9448 &`sig_algorithm  `&
9449 &`signature      `&
9450 &`subj_altname   `& tagged list
9451 &`ocsp_uri       `& list
9452 &`crl_uri        `& list
9453 .endd
9454 If the field is found,
9455 <&'string2'&> is expanded, and replaces the whole item;
9456 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9457 variable &$value$& contains the value that has been extracted. Afterwards, it
9458 is restored to any previous value it might have had.
9459
9460 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9461 key is not found. If {<&'string2'&>} is also omitted, the value that was
9462 extracted is used.
9463
9464 Some field names take optional modifiers, appended and separated by commas.
9465
9466 The field selectors marked as "RFC4514" above
9467 output a Distinguished Name string which is
9468 not quite
9469 parseable by Exim as a comma-separated tagged list
9470 (the exceptions being elements containing commas).
9471 RDN elements of a single type may be selected by
9472 a modifier of the type label; if so the expansion
9473 result is a list (newline-separated by default).
9474 The separator may be changed by another modifier of
9475 a right angle-bracket followed immediately by the new separator.
9476 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9477
9478 The field selectors marked as "time" above
9479 take an optional modifier of "int"
9480 for which the result is the number of seconds since epoch.
9481 Otherwise the result is a human-readable string
9482 in the timezone selected by the main "timezone" option.
9483
9484 The field selectors marked as "list" above return a list,
9485 newline-separated by default,
9486 (embedded separator characters in elements are doubled).
9487 The separator may be changed by a modifier of
9488 a right angle-bracket followed immediately by the new separator.
9489
9490 The field selectors marked as "tagged" above
9491 prefix each list element with a type string and an equals sign.
9492 Elements of only one type may be selected by a modifier
9493 which is one of "dns", "uri" or "mail";
9494 if so the element tags are omitted.
9495
9496 If not otherwise noted field values are presented in human-readable form.
9497
9498 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9499        {*&<&'arg'&>&*}...}*&"
9500 .cindex &%dlfunc%&
9501 This expansion dynamically loads and then calls a locally-written C function.
9502 This functionality is available only if Exim is compiled with
9503 .code
9504 EXPAND_DLFUNC=yes
9505 .endd
9506 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9507 object so that it doesn't reload the same object file in the same Exim process
9508 (but of course Exim does start new processes frequently).
9509
9510 There may be from zero to eight arguments to the function.
9511
9512 When compiling
9513 a local function that is to be called in this way,
9514 first &_DLFUNC_IMPL_& should be defined,
9515 and second &_local_scan.h_& should be included.
9516 The Exim variables and functions that are defined by that API
9517 are also available for dynamically loaded functions. The function itself
9518 must have the following type:
9519 .code
9520 int dlfunction(uschar **yield, int argc, uschar *argv[])
9521 .endd
9522 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9523 function should return one of the following values:
9524
9525 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9526 into the expanded string that is being built.
9527
9528 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9529 from &'yield'&, if it is set.
9530
9531 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9532 taken from &'yield'& if it is set.
9533
9534 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9535
9536 When compiling a function that is to be used in this way with gcc,
9537 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9538 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9539
9540
9541 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9542 .cindex "expansion" "extracting value from environment"
9543 .cindex "environment" "values from"
9544 The key is first expanded separately, and leading and trailing white space
9545 removed.
9546 This is then searched for as a name in the environment.
9547 If a variable is found then its value is placed in &$value$&
9548 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9549
9550 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9551 appear, for example:
9552 .code
9553 ${env{USER}{$value} fail }
9554 .endd
9555 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9556 {<&'string1'&>} must be present for &"fail"& to be recognized.
9557
9558 If {<&'string2'&>} is omitted an empty string is substituted on
9559 search failure.
9560 If {<&'string1'&>} is omitted the search result is substituted on
9561 search success.
9562
9563 The environment is adjusted by the &%keep_environment%& and
9564 &%add_environment%& main section options.
9565
9566
9567 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9568        {*&<&'string3'&>&*}}*&"
9569 .cindex "expansion" "extracting substrings by key"
9570 .cindex "&%extract%&" "substrings by key"
9571 The key and <&'string1'&> are first expanded separately. Leading and trailing
9572 white space is removed from the key (but not from any of the strings). The key
9573 must not be empty and must not consist entirely of digits.
9574 The expanded <&'string1'&> must be of the form:
9575 .display
9576 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9577 .endd
9578 .vindex "&$value$&"
9579 where the equals signs and spaces (but not both) are optional. If any of the
9580 values contain white space, they must be enclosed in double quotes, and any
9581 values that are enclosed in double quotes are subject to escape processing as
9582 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9583 for the value that corresponds to the key. The search is case-insensitive. If
9584 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9585 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9586 variable &$value$& contains the value that has been extracted. Afterwards, it
9587 is restored to any previous value it might have had.
9588
9589 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9590 key is not found. If {<&'string2'&>} is also omitted, the value that was
9591 extracted is used. Thus, for example, these two expansions are identical, and
9592 yield &"2001"&:
9593 .code
9594 ${extract{gid}{uid=1984 gid=2001}}
9595 ${extract{gid}{uid=1984 gid=2001}{$value}}
9596 .endd
9597 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9598 appear, for example:
9599 .code
9600 ${extract{Z}{A=... B=...}{$value} fail }
9601 .endd
9602 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9603 {<&'string2'&>} must be present for &"fail"& to be recognized.
9604
9605 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9606        {*&<&'string3'&>&*}}*&" &&&
9607        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9608        {*&<&'string3'&>&*}}*&"
9609 .cindex "expansion" "extracting from JSON object"
9610 .cindex JSON expansions
9611 The key and <&'string1'&> are first expanded separately. Leading and trailing
9612 white space is removed from the key (but not from any of the strings). The key
9613 must not be empty and must not consist entirely of digits.
9614 The expanded <&'string1'&> must be of the form:
9615 .display
9616 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9617 .endd
9618 .vindex "&$value$&"
9619 The braces, commas and colons, and the quoting of the member name are required;
9620 the spaces are optional.
9621 Matching of the key against the member names is done case-sensitively.
9622 For the &"json"& variant,
9623 if a returned value is a JSON string, it retains its leading and
9624 trailing quotes.
9625 For the &"jsons"& variant, which is intended for use with JSON strings, the
9626 leading and trailing quotes are removed from the returned value.
9627 . XXX should be a UTF-8 compare
9628
9629 The results of matching are handled as above.
9630
9631
9632 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9633         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9634 .cindex "expansion" "extracting substrings by number"
9635 .cindex "&%extract%&" "substrings by number"
9636 The <&'number'&> argument must consist entirely of decimal digits,
9637 apart from leading and trailing white space, which is ignored.
9638 This is what distinguishes this form of &%extract%& from the previous kind. It
9639 behaves in the same way, except that, instead of extracting a named field, it
9640 extracts from <&'string1'&> the field whose number is given as the first
9641 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9642 <&'string3'&> as before.
9643
9644 The fields in the string are separated by any one of the characters in the
9645 separator string. These may include space or tab characters.
9646 The first field is numbered one. If the number is negative, the fields are
9647 counted from the end of the string, with the rightmost one numbered -1. If the
9648 number given is zero, the entire string is returned. If the modulus of the
9649 number is greater than the number of fields in the string, the result is the
9650 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9651 provided. For example:
9652 .code
9653 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9654 .endd
9655 yields &"42"&, and
9656 .code
9657 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9658 .endd
9659 yields &"99"&. Two successive separators mean that the field between them is
9660 empty (for example, the fifth field above).
9661
9662
9663 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9664         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9665        "&*${extract jsons{*&<&'number'&>&*}}&&&
9666         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9667 .cindex "expansion" "extracting from JSON array"
9668 .cindex JSON expansions
9669 The <&'number'&> argument must consist entirely of decimal digits,
9670 apart from leading and trailing white space, which is ignored.
9671
9672 Field selection and result handling is as above;
9673 there is no choice of field separator.
9674 For the &"json"& variant,
9675 if a returned value is a JSON string, it retains its leading and
9676 trailing quotes.
9677 For the &"jsons"& variant, which is intended for use with JSON strings, the
9678 leading and trailing quotes are removed from the returned value.
9679
9680
9681 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9682 .cindex "list" "selecting by condition"
9683 .cindex "expansion" "selecting from list by condition"
9684 .vindex "&$item$&"
9685 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9686 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9687 For each item
9688 in this list, its value is place in &$item$&, and then the condition is
9689 evaluated. If the condition is true, &$item$& is added to the output as an
9690 item in a new list; if the condition is false, the item is discarded. The
9691 separator used for the output list is the same as the one used for the
9692 input, but a separator setting is not included in the output. For example:
9693 .code
9694 ${filter{a:b:c}{!eq{$item}{b}}}
9695 .endd
9696 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9697 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9698
9699
9700 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9701 .cindex "hash function" "textual"
9702 .cindex "expansion" "textual hash"
9703 This is a textual hashing function, and was the first to be implemented in
9704 early versions of Exim. In current releases, there are other hashing functions
9705 (numeric, MD5, and SHA-1), which are described below.
9706
9707 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9708 <&'n'&>. If you are using fixed values for these numbers, that is, if
9709 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9710 use the simpler operator notation that avoids some of the braces:
9711 .code
9712 ${hash_<n>_<m>:<string>}
9713 .endd
9714 The second number is optional (in both notations). If <&'n'&> is greater than
9715 or equal to the length of the string, the expansion item returns the string.
9716 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9717 function to the string. The new string consists of characters taken from the
9718 first <&'m'&> characters of the string
9719 .code
9720 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9721 .endd
9722 If <&'m'&> is not present the value 26 is used, so that only lower case
9723 letters appear. For example:
9724 .display
9725 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9726 &`$hash{5}{monty}}           `&   yields  &`monty`&
9727 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9728 .endd
9729
9730 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9731         &*$h_*&<&'header&~name'&>&*:*&" &&&
9732        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9733         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9734        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9735         &*$lh_*&<&'header&~name'&>&*:*&"
9736        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9737         &*$rh_*&<&'header&~name'&>&*:*&"
9738 .cindex "expansion" "header insertion"
9739 .vindex "&$header_$&"
9740 .vindex "&$bheader_$&"
9741 .vindex "&$lheader_$&"
9742 .vindex "&$rheader_$&"
9743 .cindex "header lines" "in expansion strings"
9744 .cindex "header lines" "character sets"
9745 .cindex "header lines" "decoding"
9746 Substitute the contents of the named message header line, for example
9747 .code
9748 $header_reply-to:
9749 .endd
9750 The newline that terminates a header line is not included in the expansion, but
9751 internal newlines (caused by splitting the header line over several physical
9752 lines) may be present.
9753
9754 The difference between the four pairs of expansions is in the way
9755 the data in the header line is interpreted.
9756
9757 .ilist
9758 .cindex "white space" "in header lines"
9759 &%rheader%& gives the original &"raw"& content of the header line, with no
9760 processing at all, and without the removal of leading and trailing white space.
9761
9762 .next
9763 .cindex "list" "of header lines"
9764 &%lheader%& gives a colon-separated list, one element per header when there
9765 are multiple headers with a given name.
9766 Any embedded colon characters within an element are doubled, so normal Exim
9767 list-processing facilities can be used.
9768 The terminating newline of each element is removed; in other respects
9769 the content is &"raw"&.
9770
9771 .next
9772 .cindex "base64 encoding" "in header lines"
9773 &%bheader%& removes leading and trailing white space, and then decodes base64
9774 or quoted-printable MIME &"words"& within the header text, but does no
9775 character set translation. If decoding of what looks superficially like a MIME
9776 &"word"& fails, the raw string is returned. If decoding
9777 .cindex "binary zero" "in header line"
9778 produces a binary zero character, it is replaced by a question mark &-- this is
9779 what Exim does for binary zeros that are actually received in header lines.
9780
9781 .next
9782 &%header%& tries to translate the string as decoded by &%bheader%& to a
9783 standard character set. This is an attempt to produce the same string as would
9784 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9785 returned. Translation is attempted only on operating systems that support the
9786 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9787 a system Makefile or in &_Local/Makefile_&.
9788 .endlist ilist
9789
9790 In a filter file, the target character set for &%header%& can be specified by a
9791 command of the following form:
9792 .code
9793 headers charset "UTF-8"
9794 .endd
9795 This command affects all references to &$h_$& (or &$header_$&) expansions in
9796 subsequently obeyed filter commands. In the absence of this command, the target
9797 character set in a filter is taken from the setting of the &%headers_charset%&
9798 option in the runtime configuration. The value of this option defaults to the
9799 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9800 ISO-8859-1.
9801
9802 Header names follow the syntax of RFC 2822, which states that they may contain
9803 any printing characters except space and colon. Consequently, curly brackets
9804 &'do not'& terminate header names, and should not be used to enclose them as
9805 if they were variables. Attempting to do so causes a syntax error.
9806
9807 Only header lines that are common to all copies of a message are visible to
9808 this mechanism. These are the original header lines that are received with the
9809 message, and any that are added by an ACL statement or by a system
9810 filter. Header lines that are added to a particular copy of a message by a
9811 router or transport are not accessible.
9812
9813 For incoming SMTP messages, no header lines are visible in
9814 ACLs that are obeyed before the data phase completes,
9815 because the header structure is not set up until the message is received.
9816 They are visible in DKIM, PRDR and DATA ACLs.
9817 Header lines that are added in a RCPT ACL (for example)
9818 are saved until the message's incoming header lines are available, at which
9819 point they are added.
9820 When any of the above ACLs ar
9821 running, however, header lines added by earlier ACLs are visible.
9822
9823 Upper case and lower case letters are synonymous in header names. If the
9824 following character is white space, the terminating colon may be omitted, but
9825 this is not recommended, because you may then forget it when it is needed. When
9826 white space terminates the header name, this white space is included in the
9827 expanded string.  If the message does not contain the given header, the
9828 expansion item is replaced by an empty string. (See the &%def%& condition in
9829 section &<<SECTexpcond>>& for a means of testing for the existence of a
9830 header.)
9831
9832 If there is more than one header with the same name, they are all concatenated
9833 to form the substitution string, up to a maximum length of 64K. Unless
9834 &%rheader%& is being used, leading and trailing white space is removed from
9835 each header before concatenation, and a completely empty header is ignored. A
9836 newline character is then inserted between non-empty headers, but there is no
9837 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9838 those headers that contain lists of addresses, a comma is also inserted at the
9839 junctions between headers. This does not happen for the &%rheader%& expansion.
9840
9841 .new
9842 .cindex "tainted data"
9843 When the headers are from an incoming message,
9844 the result of expanding any of these variables is tainted.
9845 .wen
9846
9847
9848 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9849 .cindex "expansion" "hmac hashing"
9850 .cindex &%hmac%&
9851 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9852 shared secret and some text into a message authentication code, as specified in
9853 RFC 2104. This differs from &`${md5:secret_text...}`& or
9854 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9855 cryptographic hash, allowing for authentication that is not possible with MD5
9856 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9857 present. For example:
9858 .code
9859 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9860 .endd
9861 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9862 produces:
9863 .code
9864 dd97e3ba5d1a61b5006108f8c8252953
9865 .endd
9866 As an example of how this might be used, you might put in the main part of
9867 an Exim configuration:
9868 .code
9869 SPAMSCAN_SECRET=cohgheeLei2thahw
9870 .endd
9871 In a router or a transport you could then have:
9872 .code
9873 headers_add = \
9874   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9875   ${hmac{md5}{SPAMSCAN_SECRET}\
9876   {${primary_hostname},${message_exim_id},$h_message-id:}}
9877 .endd
9878 Then given a message, you can check where it was scanned by looking at the
9879 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9880 this header line is authentic by recomputing the authentication code from the
9881 host name, message ID and the &'Message-id:'& header line. This can be done
9882 using Exim's &%-be%& option, or by other means, for example, by using the
9883 &'hmac_md5_hex()'& function in Perl.
9884
9885
9886 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9887 .cindex "expansion" "conditional"
9888 .cindex "&%if%&, expansion item"
9889 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9890 item; otherwise <&'string2'&> is used. The available conditions are described
9891 in section &<<SECTexpcond>>& below. For example:
9892 .code
9893 ${if eq {$local_part}{postmaster} {yes}{no} }
9894 .endd
9895 The second string need not be present; if it is not and the condition is not
9896 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9897 be present instead of the second string (without any curly brackets). In this
9898 case, the expansion is forced to fail if the condition is not true (see section
9899 &<<SECTforexpfai>>&).
9900
9901 If both strings are omitted, the result is the string &`true`& if the condition
9902 is true, and the empty string if the condition is false. This makes it less
9903 cumbersome to write custom ACL and router conditions. For example, instead of
9904 .code
9905 condition = ${if >{$acl_m4}{3}{true}{false}}
9906 .endd
9907 you can use
9908 .code
9909 condition = ${if >{$acl_m4}{3}}
9910 .endd
9911
9912
9913
9914 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9915 .cindex expansion "imap folder"
9916 .cindex "&%imapfolder%& expansion item"
9917 This item converts a (possibly multilevel, or with non-ASCII characters)
9918 folder specification to a Maildir name for filesystem use.
9919 For information on internationalisation support see &<<SECTi18nMDA>>&.
9920
9921
9922
9923 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9924 .cindex "expansion" "string truncation"
9925 .cindex "&%length%& expansion item"
9926 The &%length%& item is used to extract the initial portion of a string. Both
9927 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9928 you are using a fixed value for the number, that is, if <&'string1'&> does not
9929 change when expanded, you can use the simpler operator notation that avoids
9930 some of the braces:
9931 .code
9932 ${length_<n>:<string>}
9933 .endd
9934 The result of this item is either the first <&'n'&> bytes or the whole
9935 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9936 &%strlen%&, which gives the length of a string.
9937 All measurement is done in bytes and is not UTF-8 aware.
9938
9939
9940 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9941         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9942 .cindex "expansion" "extracting list elements by number"
9943 .cindex "&%listextract%&" "extract list elements by number"
9944 .cindex "list" "extracting elements by number"
9945 The <&'number'&> argument must consist entirely of decimal digits,
9946 apart from an optional leading minus,
9947 and leading and trailing white space (which is ignored).
9948
9949 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9950 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9951
9952 The first field of the list is numbered one.
9953 If the number is negative, the fields are
9954 counted from the end of the list, with the rightmost one numbered -1.
9955 The numbered element of the list is extracted and placed in &$value$&,
9956 then <&'string2'&> is expanded as the result.
9957
9958 If the modulus of the
9959 number is zero or greater than the number of fields in the string,
9960 the result is the expansion of <&'string3'&>.
9961
9962 For example:
9963 .code
9964 ${listextract{2}{x:42:99}}
9965 .endd
9966 yields &"42"&, and
9967 .code
9968 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9969 .endd
9970 yields &"result: 42"&.
9971
9972 If {<&'string3'&>} is omitted, an empty string is used for string3.
9973 If {<&'string2'&>} is also omitted, the value that was
9974 extracted is used.
9975 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9976
9977
9978 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9979         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9980 This is the first of one of two different types of lookup item, which are both
9981 described in the next item.
9982
9983 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9984         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9985 .cindex "expansion" "lookup in"
9986 .cindex "file" "lookups"
9987 .cindex "lookup" "in expanded string"
9988 The two forms of lookup item specify data lookups in files and databases, as
9989 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9990 lookups, and the second is used for query-style lookups. The <&'key'&>,
9991 <&'file'&>, and <&'query'&> strings are expanded before use.
9992
9993 If there is any white space in a lookup item which is part of a filter command,
9994 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9995 other place where white space is significant, the lookup item must be enclosed
9996 in double quotes. The use of data lookups in users' filter files may be locked
9997 out by the system administrator.
9998
9999 .vindex "&$value$&"
10000 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10001 During its expansion, the variable &$value$& contains the data returned by the
10002 lookup. Afterwards it reverts to the value it had previously (at the outer
10003 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10004 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10005 string on failure. If <&'string2'&> is provided, it can itself be a nested
10006 lookup, thus providing a mechanism for looking up a default value when the
10007 original lookup fails.
10008
10009 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10010 data for the outer lookup while the parameters of the second lookup are
10011 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10012 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10013 appear, and in this case, if the lookup fails, the entire expansion is forced
10014 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10015 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10016 successful lookup, and nothing in the case of failure.
10017
10018 For single-key lookups, the string &"partial"& is permitted to precede the
10019 search type in order to do partial matching, and * or *@ may follow a search
10020 type to request default lookups if the key does not match (see sections
10021 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10022
10023 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10024 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10025 and non-wild parts of the key during the expansion of the replacement text.
10026 They return to their previous values at the end of the lookup item.
10027
10028 This example looks up the postmaster alias in the conventional alias file:
10029 .code
10030 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10031 .endd
10032 This example uses NIS+ to look up the full name of the user corresponding to
10033 the local part of an address, forcing the expansion to fail if it is not found:
10034 .code
10035 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10036   {$value}fail}
10037 .endd
10038
10039
10040 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10041 .cindex "expansion" "list creation"
10042 .vindex "&$item$&"
10043 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10044 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10045 For each item
10046 in this list, its value is place in &$item$&, and then <&'string2'&> is
10047 expanded and added to the output as an item in a new list. The separator used
10048 for the output list is the same as the one used for the input, but a separator
10049 setting is not included in the output. For example:
10050 .code
10051 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10052 .endd
10053 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10054 value of &$item$& is restored to what it was before. See also the &%filter%&
10055 and &%reduce%& expansion items.
10056
10057 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10058 .cindex "expansion" "numeric hash"
10059 .cindex "hash function" "numeric"
10060 The three strings are expanded; the first two must yield numbers. Call them
10061 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10062 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10063 can use the simpler operator notation that avoids some of the braces:
10064 .code
10065 ${nhash_<n>_<m>:<string>}
10066 .endd
10067 The second number is optional (in both notations). If there is only one number,
10068 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10069 processed by a div/mod hash function that returns two numbers, separated by a
10070 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10071 example,
10072 .code
10073 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10074 .endd
10075 returns the string &"6/33"&.
10076
10077
10078
10079 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10080 .cindex "Perl" "use in expanded string"
10081 .cindex "expansion" "calling Perl from"
10082 This item is available only if Exim has been built to include an embedded Perl
10083 interpreter. The subroutine name and the arguments are first separately
10084 expanded, and then the Perl subroutine is called with those arguments. No
10085 additional arguments need be given; the maximum number permitted, including the
10086 name of the subroutine, is nine.
10087
10088 The return value of the subroutine is inserted into the expanded string, unless
10089 the return value is &%undef%&. In that case, the expansion fails in the same
10090 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10091 Whatever you return is evaluated in a scalar context. For example, if you
10092 return the name of a Perl vector, the return value is the size of the vector,
10093 not its contents.
10094
10095 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10096 with the error message that was passed to &%die%&. More details of the embedded
10097 Perl facility are given in chapter &<<CHAPperl>>&.
10098
10099 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10100 out the use of this expansion item in filter files.
10101
10102
10103 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10104 .cindex "&%prvs%& expansion item"
10105 The first argument is a complete email address and the second is secret
10106 keystring. The third argument, specifying a key number, is optional. If absent,
10107 it defaults to 0. The result of the expansion is a prvs-signed email address,
10108 to be typically used with the &%return_path%& option on an &(smtp)& transport
10109 as part of a bounce address tag validation (BATV) scheme. For more discussion
10110 and an example, see section &<<SECTverifyPRVS>>&.
10111
10112 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10113         {*&<&'string'&>&*}}*&"
10114 .cindex "&%prvscheck%& expansion item"
10115 This expansion item is the complement of the &%prvs%& item. It is used for
10116 checking prvs-signed addresses. If the expansion of the first argument does not
10117 yield a syntactically valid prvs-signed address, the whole item expands to the
10118 empty string. When the first argument does expand to a syntactically valid
10119 prvs-signed address, the second argument is expanded, with the prvs-decoded
10120 version of the address and the key number extracted from the address in the
10121 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10122
10123 These two variables can be used in the expansion of the second argument to
10124 retrieve the secret. The validity of the prvs-signed address is then checked
10125 against the secret. The result is stored in the variable &$prvscheck_result$&,
10126 which is empty for failure or &"1"& for success.
10127
10128 The third argument is optional; if it is missing, it defaults to an empty
10129 string. This argument is now expanded. If the result is an empty string, the
10130 result of the expansion is the decoded version of the address. This is the case
10131 whether or not the signature was valid. Otherwise, the result of the expansion
10132 is the expansion of the third argument.
10133
10134 All three variables can be used in the expansion of the third argument.
10135 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10136 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10137
10138 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10139 .cindex "expansion" "inserting an entire file"
10140 .cindex "file" "inserting into expansion"
10141 .cindex "&%readfile%& expansion item"
10142 The filename and end-of-line string are first expanded separately. The file is
10143 then read, and its contents replace the entire item. All newline characters in
10144 the file are replaced by the end-of-line string if it is present. Otherwise,
10145 newlines are left in the string.
10146 String expansion is not applied to the contents of the file. If you want this,
10147 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10148 the string expansion fails.
10149
10150 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10151 locks out the use of this expansion item in filter files.
10152
10153
10154
10155 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10156         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10157 .cindex "expansion" "inserting from a socket"
10158 .cindex "socket, use of in expansion"
10159 .cindex "&%readsocket%& expansion item"
10160 This item inserts data from a Unix domain or TCP socket into the expanded
10161 string. The minimal way of using it uses just two arguments, as in these
10162 examples:
10163 .code
10164 ${readsocket{/socket/name}{request string}}
10165 ${readsocket{inet:some.host:1234}{request string}}
10166 .endd
10167 For a Unix domain socket, the first substring must be the path to the socket.
10168 For an Internet socket, the first substring must contain &`inet:`& followed by
10169 a host name or IP address, followed by a colon and a port, which can be a
10170 number or the name of a TCP port in &_/etc/services_&. An IP address may
10171 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10172 example:
10173 .code
10174 ${readsocket{inet:[::1]:1234}{request string}}
10175 .endd
10176 Only a single host name may be given, but if looking it up yields more than
10177 one IP address, they are each tried in turn until a connection is made. For
10178 both kinds of socket, Exim makes a connection, writes the request string
10179 unless it is an empty string; and no terminating NUL is ever sent)
10180 and reads from the socket until an end-of-file
10181 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10182 extend what can be done. Firstly, you can vary the timeout. For example:
10183 .code
10184 ${readsocket{/socket/name}{request string}{3s}}
10185 .endd
10186
10187 The third argument is a list of options, of which the first element is the timeout
10188 and must be present if the argument is given.
10189 Further elements are options of form &'name=value'&.
10190 Two option types is currently recognised: shutdown and tls.
10191 The first defines whether (the default)
10192 or not a shutdown is done on the connection after sending the request.
10193 Example, to not do so (preferred, eg. by some webservers):
10194 .code
10195 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10196 .endd
10197 The second, tls, controls the use of TLS on the connection.  Example:
10198 .code
10199 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10200 .endd
10201 The default is to not use TLS.
10202 If it is enabled, a shutdown as descripbed above is never done.
10203
10204 A fourth argument allows you to change any newlines that are in the data
10205 that is read, in the same way as for &%readfile%& (see above). This example
10206 turns them into spaces:
10207 .code
10208 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10209 .endd
10210 As with all expansions, the substrings are expanded before the processing
10211 happens. Errors in these sub-expansions cause the expansion to fail. In
10212 addition, the following errors can occur:
10213
10214 .ilist
10215 Failure to create a socket file descriptor;
10216 .next
10217 Failure to connect the socket;
10218 .next
10219 Failure to write the request string;
10220 .next
10221 Timeout on reading from the socket.
10222 .endlist
10223
10224 By default, any of these errors causes the expansion to fail. However, if
10225 you supply a fifth substring, it is expanded and used when any of the above
10226 errors occurs. For example:
10227 .code
10228 ${readsocket{/socket/name}{request string}{3s}{\n}\
10229   {socket failure}}
10230 .endd
10231 You can test for the existence of a Unix domain socket by wrapping this
10232 expansion in &`${if exists`&, but there is a race condition between that test
10233 and the actual opening of the socket, so it is safer to use the fifth argument
10234 if you want to be absolutely sure of avoiding an expansion error for a
10235 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10236
10237 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10238 locks out the use of this expansion item in filter files.
10239
10240
10241 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10242 .cindex "expansion" "reducing a list to a scalar"
10243 .cindex "list" "reducing to a scalar"
10244 .vindex "&$value$&"
10245 .vindex "&$item$&"
10246 This operation reduces a list to a single, scalar string. After expansion,
10247 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10248 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10249 Then <&'string2'&> is expanded and
10250 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10251 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10252 them. The result of that expansion is assigned to &$value$& before the next
10253 iteration. When the end of the list is reached, the final value of &$value$& is
10254 added to the expansion output. The &%reduce%& expansion item can be used in a
10255 number of ways. For example, to add up a list of numbers:
10256 .code
10257 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10258 .endd
10259 The result of that expansion would be &`6`&. The maximum of a list of numbers
10260 can be found:
10261 .code
10262 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10263 .endd
10264 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10265 restored to what they were before. See also the &%filter%& and &%map%&
10266 expansion items.
10267
10268 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10269 This item inserts &"raw"& header lines. It is described with the &%header%&
10270 expansion item in section &<<SECTexpansionitems>>& above.
10271
10272 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10273         {*&<&'string2'&>&*}}*&"
10274 .cindex "expansion" "running a command"
10275 .cindex "&%run%& expansion item"
10276 The command and its arguments are first expanded as one string. The string is
10277 split apart into individual arguments by spaces, and then the command is run
10278 in a separate process, but under the same uid and gid.  As in other command
10279 executions from Exim, a shell is not used by default. If the command requires
10280 a shell, you must explicitly code it.
10281
10282 Since the arguments are split by spaces, when there is a variable expansion
10283 which has an empty result, it will cause the situation that the argument will
10284 simply be omitted when the program is actually executed by Exim. If the
10285 script/program requires a specific number of arguments and the expanded
10286 variable could possibly result in this empty expansion, the variable must be
10287 quoted. This is more difficult if the expanded variable itself could result
10288 in a string containing quotes, because it would interfere with the quotes
10289 around the command arguments. A possible guard against this is to wrap the
10290 variable in the &%sg%& operator to change any quote marks to some other
10291 character.
10292
10293 The standard input for the command exists, but is empty. The standard output
10294 and standard error are set to the same file descriptor.
10295 .cindex "return code" "from &%run%& expansion"
10296 .vindex "&$value$&"
10297 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10298 and replaces the entire item; during this expansion, the standard output/error
10299 from the command is in the variable &$value$&. If the command fails,
10300 <&'string2'&>, if present, is expanded and used. Once again, during the
10301 expansion, the standard output/error from the command is in the variable
10302 &$value$&.
10303
10304 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10305 can be the word &"fail"& (not in braces) to force expansion failure if the
10306 command does not succeed. If both strings are omitted, the result is contents
10307 of the standard output/error on success, and nothing on failure.
10308
10309 .vindex "&$run_in_acl$&"
10310 The standard output/error of the command is put in the variable &$value$&.
10311 In this ACL example, the output of a command is logged for the admin to
10312 troubleshoot:
10313 .code
10314 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10315       log_message  = Output of id: $value
10316 .endd
10317 If the command requires shell idioms, such as the > redirect operator, the
10318 shell must be invoked directly, such as with:
10319 .code
10320 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10321 .endd
10322
10323 .vindex "&$runrc$&"
10324 The return code from the command is put in the variable &$runrc$&, and this
10325 remains set afterwards, so in a filter file you can do things like this:
10326 .code
10327 if "${run{x y z}{}}$runrc" is 1 then ...
10328   elif $runrc is 2 then ...
10329   ...
10330 endif
10331 .endd
10332 If execution of the command fails (for example, the command does not exist),
10333 the return code is 127 &-- the same code that shells use for non-existent
10334 commands.
10335
10336 &*Warning*&: In a router or transport, you cannot assume the order in which
10337 option values are expanded, except for those preconditions whose order of
10338 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10339 by the expansion of one option, and use it in another.
10340
10341 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10342 out the use of this expansion item in filter files.
10343
10344
10345 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10346 .cindex "expansion" "string substitution"
10347 .cindex "&%sg%& expansion item"
10348 This item works like Perl's substitution operator (s) with the global (/g)
10349 option; hence its name. However, unlike the Perl equivalent, Exim does not
10350 modify the subject string; instead it returns the modified string for insertion
10351 into the overall expansion. The item takes three arguments: the subject string,
10352 a regular expression, and a substitution string. For example:
10353 .code
10354 ${sg{abcdefabcdef}{abc}{xyz}}
10355 .endd
10356 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10357 if any $, } or \ characters are required in the regular expression or in the
10358 substitution string, they have to be escaped. For example:
10359 .code
10360 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10361 .endd
10362 yields &"defabc"&, and
10363 .code
10364 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10365 .endd
10366 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10367 the regular expression from string expansion.
10368
10369 The regular expression is compiled in 8-bit mode, working against bytes
10370 rather than any Unicode-aware character handling.
10371
10372
10373 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10374 .cindex sorting "a list"
10375 .cindex list sorting
10376 .cindex expansion "list sorting"
10377 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10378 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10379 The <&'comparator'&> argument is interpreted as the operator
10380 of a two-argument expansion condition.
10381 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10382 The comparison should return true when applied to two values
10383 if the first value should sort before the second value.
10384 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10385 the element being placed in &$item$&,
10386 to give values for comparison.
10387
10388 The item result is a sorted list,
10389 with the original list separator,
10390 of the list elements (in full) of the original.
10391
10392 Examples:
10393 .code
10394 ${sort{3:2:1:4}{<}{$item}}
10395 .endd
10396 sorts a list of numbers, and
10397 .code
10398 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10399 .endd
10400 will sort an MX lookup into priority order.
10401
10402
10403 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10404 .cindex "&%substr%& expansion item"
10405 .cindex "substring extraction"
10406 .cindex "expansion" "substring extraction"
10407 The three strings are expanded; the first two must yield numbers. Call them
10408 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10409 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10410 can use the simpler operator notation that avoids some of the braces:
10411 .code
10412 ${substr_<n>_<m>:<string>}
10413 .endd
10414 The second number is optional (in both notations).
10415 If it is absent in the simpler format, the preceding underscore must also be
10416 omitted.
10417
10418 The &%substr%& item can be used to extract more general substrings than
10419 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10420 length required. For example
10421 .code
10422 ${substr{3}{2}{$local_part}}
10423 .endd
10424 If the starting offset is greater than the string length the result is the
10425 null string; if the length plus starting offset is greater than the string
10426 length, the result is the right-hand part of the string, starting from the
10427 given offset. The first byte (character) in the string has offset zero.
10428
10429 The &%substr%& expansion item can take negative offset values to count
10430 from the right-hand end of its operand. The last byte (character) is offset -1,
10431 the second-last is offset -2, and so on. Thus, for example,
10432 .code
10433 ${substr{-5}{2}{1234567}}
10434 .endd
10435 yields &"34"&. If the absolute value of a negative offset is greater than the
10436 length of the string, the substring starts at the beginning of the string, and
10437 the length is reduced by the amount of overshoot. Thus, for example,
10438 .code
10439 ${substr{-5}{2}{12}}
10440 .endd
10441 yields an empty string, but
10442 .code
10443 ${substr{-3}{2}{12}}
10444 .endd
10445 yields &"1"&.
10446
10447 When the second number is omitted from &%substr%&, the remainder of the string
10448 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10449 string preceding the offset point are taken. For example, an offset of -1 and
10450 no length, as in these semantically identical examples:
10451 .code
10452 ${substr_-1:abcde}
10453 ${substr{-1}{abcde}}
10454 .endd
10455 yields all but the last character of the string, that is, &"abcd"&.
10456
10457 All measurement is done in bytes and is not UTF-8 aware.
10458
10459
10460
10461 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10462         {*&<&'replacements'&>&*}}*&"
10463 .cindex "expansion" "character translation"
10464 .cindex "&%tr%& expansion item"
10465 This item does single-character (in bytes) translation on its subject string. The second
10466 argument is a list of characters to be translated in the subject string. Each
10467 matching character is replaced by the corresponding character from the
10468 replacement list. For example
10469 .code
10470 ${tr{abcdea}{ac}{13}}
10471 .endd
10472 yields &`1b3de1`&. If there are duplicates in the second character string, the
10473 last occurrence is used. If the third string is shorter than the second, its
10474 last character is replicated. However, if it is empty, no translation takes
10475 place.
10476
10477 All character handling is done in bytes and is not UTF-8 aware.
10478
10479 .endlist
10480
10481
10482
10483 .section "Expansion operators" "SECTexpop"
10484 .cindex "expansion" "operators"
10485 For expansion items that perform transformations on a single argument string,
10486 the &"operator"& notation is used because it is simpler and uses fewer braces.
10487 The substring is first expanded before the operation is applied to it. The
10488 following operations can be performed:
10489
10490 .vlist
10491 .vitem &*${address:*&<&'string'&>&*}*&
10492 .cindex "expansion" "RFC 2822 address handling"
10493 .cindex "&%address%& expansion item"
10494 The string is interpreted as an RFC 2822 address, as it might appear in a
10495 header line, and the effective address is extracted from it. If the string does
10496 not parse successfully, the result is empty.
10497
10498 The parsing correctly handles SMTPUTF8 Unicode in the string.
10499
10500
10501 .vitem &*${addresses:*&<&'string'&>&*}*&
10502 .cindex "expansion" "RFC 2822 address handling"
10503 .cindex "&%addresses%& expansion item"
10504 The string (after expansion) is interpreted as a list of addresses in RFC
10505 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10506 operative address (&'local-part@domain'&) is extracted from each item, and the
10507 result of the expansion is a colon-separated list, with appropriate
10508 doubling of colons should any happen to be present in the email addresses.
10509 Syntactically invalid RFC2822 address items are omitted from the output.
10510
10511 It is possible to specify a character other than colon for the output
10512 separator by starting the string with > followed by the new separator
10513 character. For example:
10514 .code
10515 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10516 .endd
10517 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10518 first, so if the expanded string starts with >, it may change the output
10519 separator unintentionally. This can be avoided by setting the output
10520 separator explicitly:
10521 .code
10522 ${addresses:>:$h_from:}
10523 .endd
10524
10525 Compare the &%address%& (singular)
10526 expansion item, which extracts the working address from a single RFC2822
10527 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10528 processing lists.
10529
10530 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10531 a strict interpretation of header line formatting.  Exim parses the bare,
10532 unquoted portion of an email address and if it finds a comma, treats it as an
10533 email address separator. For the example header line:
10534 .code
10535 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10536 .endd
10537 The first example below demonstrates that Q-encoded email addresses are parsed
10538 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10539 It does not see the comma because it's still encoded as "=2C".  The second
10540 example below is passed the contents of &`$header_from:`&, meaning it gets
10541 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10542 The third example shows that the presence of a comma is skipped when it is
10543 quoted.  The fourth example shows SMTPUTF8 handling.
10544 .code
10545 # exim -be '${addresses:From: \
10546 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10547 user@example.com
10548 # exim -be '${addresses:From: Last, First <user@example.com>}'
10549 Last:user@example.com
10550 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10551 user@example.com
10552 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10553 フィリップ@example.jp
10554 .endd
10555
10556 .vitem &*${base32:*&<&'digits'&>&*}*&
10557 .cindex "&%base32%& expansion item"
10558 .cindex "expansion" "conversion to base 32"
10559 The string must consist entirely of decimal digits. The number is converted to
10560 base 32 and output as a (empty, for zero) string of characters.
10561 Only lowercase letters are used.
10562
10563 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10564 .cindex "&%base32d%& expansion item"
10565 .cindex "expansion" "conversion to base 32"
10566 The string must consist entirely of base-32 digits.
10567 The number is converted to decimal and output as a string.
10568
10569 .vitem &*${base62:*&<&'digits'&>&*}*&
10570 .cindex "&%base62%& expansion item"
10571 .cindex "expansion" "conversion to base 62"
10572 The string must consist entirely of decimal digits. The number is converted to
10573 base 62 and output as a string of six characters, including leading zeros. In
10574 the few operating environments where Exim uses base 36 instead of base 62 for
10575 its message identifiers (because those systems do not have case-sensitive
10576 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10577 to be absolutely clear: this is &'not'& base64 encoding.
10578
10579 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10580 .cindex "&%base62d%& expansion item"
10581 .cindex "expansion" "conversion to base 62"
10582 The string must consist entirely of base-62 digits, or, in operating
10583 environments where Exim uses base 36 instead of base 62 for its message
10584 identifiers, base-36 digits. The number is converted to decimal and output as a
10585 string.
10586
10587 .vitem &*${base64:*&<&'string'&>&*}*&
10588 .cindex "expansion" "base64 encoding"
10589 .cindex "base64 encoding" "in string expansion"
10590 .cindex "&%base64%& expansion item"
10591 .cindex certificate "base64 of DER"
10592 This operator converts a string into one that is base64 encoded.
10593
10594 If the string is a single variable of type certificate,
10595 returns the base64 encoding of the DER form of the certificate.
10596
10597
10598 .vitem &*${base64d:*&<&'string'&>&*}*&
10599 .cindex "expansion" "base64 decoding"
10600 .cindex "base64 decoding" "in string expansion"
10601 .cindex "&%base64d%& expansion item"
10602 This operator converts a base64-encoded string into the un-coded form.
10603
10604
10605 .vitem &*${domain:*&<&'string'&>&*}*&
10606 .cindex "domain" "extraction"
10607 .cindex "expansion" "domain extraction"
10608 The string is interpreted as an RFC 2822 address and the domain is extracted
10609 from it. If the string does not parse successfully, the result is empty.
10610
10611
10612 .vitem &*${escape:*&<&'string'&>&*}*&
10613 .cindex "expansion" "escaping non-printing characters"
10614 .cindex "&%escape%& expansion item"
10615 If the string contains any non-printing characters, they are converted to
10616 escape sequences starting with a backslash. Whether characters with the most
10617 significant bit set (so-called &"8-bit characters"&) count as printing or not
10618 is controlled by the &%print_topbitchars%& option.
10619
10620 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10621 .cindex "expansion" "escaping 8-bit characters"
10622 .cindex "&%escape8bit%& expansion item"
10623 If the string contains and characters with the most significant bit set,
10624 they are converted to escape sequences starting with a backslash.
10625 Backslashes and DEL characters are also converted.
10626
10627
10628 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10629 .cindex "expansion" "expression evaluation"
10630 .cindex "expansion" "arithmetic expression"
10631 .cindex "&%eval%& expansion item"
10632 These items supports simple arithmetic and bitwise logical operations in
10633 expansion strings. The string (after expansion) must be a conventional
10634 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10635 logical operators, and parentheses. All operations are carried out using
10636 integer arithmetic. The operator priorities are as follows (the same as in the
10637 C programming language):
10638 .table2 70pt 300pt
10639 .irow &'highest:'& "not (~), negate (-)"
10640 .irow ""   "multiply (*), divide (/), remainder (%)"
10641 .irow ""   "plus (+), minus (-)"
10642 .irow ""   "shift-left (<<), shift-right (>>)"
10643 .irow ""   "and (&&)"
10644 .irow ""   "xor (^)"
10645 .irow &'lowest:'&  "or (|)"
10646 .endtable
10647 Binary operators with the same priority are evaluated from left to right. White
10648 space is permitted before or after operators.
10649
10650 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10651 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10652 decimal, even if they start with a leading zero; hexadecimal numbers are not
10653 permitted. This can be useful when processing numbers extracted from dates or
10654 times, which often do have leading zeros.
10655
10656 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10657 or 1024*1024*1024,
10658 respectively. Negative numbers are supported. The result of the computation is
10659 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10660
10661 .display
10662 &`${eval:1+1}            `&  yields 2
10663 &`${eval:1+2*3}          `&  yields 7
10664 &`${eval:(1+2)*3}        `&  yields 9
10665 &`${eval:2+42%5}         `&  yields 4
10666 &`${eval:0xc&amp;5}          `&  yields 4
10667 &`${eval:0xc|5}          `&  yields 13
10668 &`${eval:0xc^5}          `&  yields 9
10669 &`${eval:0xc>>1}         `&  yields 6
10670 &`${eval:0xc<<1}         `&  yields 24
10671 &`${eval:~255&amp;0x1234}    `&  yields 4608
10672 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10673 .endd
10674
10675 As a more realistic example, in an ACL you might have
10676 .code
10677 deny   message = Too many bad recipients
10678        condition =                    \
10679          ${if and {                   \
10680            {>{$rcpt_count}{10}}       \
10681            {                          \
10682            <                          \
10683              {$recipients_count}      \
10684              {${eval:$rcpt_count/2}}  \
10685            }                          \
10686          }{yes}{no}}
10687 .endd
10688 The condition is true if there have been more than 10 RCPT commands and
10689 fewer than half of them have resulted in a valid recipient.
10690
10691
10692 .vitem &*${expand:*&<&'string'&>&*}*&
10693 .cindex "expansion" "re-expansion of substring"
10694 The &%expand%& operator causes a string to be expanded for a second time. For
10695 example,
10696 .code
10697 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10698 .endd
10699 first looks up a string in a file while expanding the operand for &%expand%&,
10700 and then re-expands what it has found.
10701
10702
10703 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10704 .cindex "Unicode"
10705 .cindex "UTF-8" "conversion from"
10706 .cindex "expansion" "UTF-8 conversion"
10707 .cindex "&%from_utf8%& expansion item"
10708 The world is slowly moving towards Unicode, although there are no standards for
10709 email yet. However, other applications (including some databases) are starting
10710 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10711 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10712 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10713 the result is an undefined sequence of bytes.
10714
10715 Unicode code points with values less than 256 are compatible with ASCII and
10716 ISO-8859-1 (also known as Latin-1).
10717 For example, character 169 is the copyright symbol in both cases, though the
10718 way it is encoded is different. In UTF-8, more than one byte is needed for
10719 characters with code values greater than 127, whereas ISO-8859-1 is a
10720 single-byte encoding (but thereby limited to 256 characters). This makes
10721 translation from UTF-8 to ISO-8859-1 straightforward.
10722
10723
10724 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10725 .cindex "hash function" "textual"
10726 .cindex "expansion" "textual hash"
10727 The &%hash%& operator is a simpler interface to the hashing function that can
10728 be used when the two parameters are fixed numbers (as opposed to strings that
10729 change when expanded). The effect is the same as
10730 .code
10731 ${hash{<n>}{<m>}{<string>}}
10732 .endd
10733 See the description of the general &%hash%& item above for details. The
10734 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10735
10736
10737
10738 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10739 .cindex "base64 encoding" "conversion from hex"
10740 .cindex "expansion" "hex to base64"
10741 .cindex "&%hex2b64%& expansion item"
10742 This operator converts a hex string into one that is base64 encoded. This can
10743 be useful for processing the output of the various hashing functions.
10744
10745
10746
10747 .vitem &*${hexquote:*&<&'string'&>&*}*&
10748 .cindex "quoting" "hex-encoded unprintable characters"
10749 .cindex "&%hexquote%& expansion item"
10750 This operator converts non-printable characters in a string into a hex
10751 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10752 as is, and other byte values are converted to &`\xNN`&, for example, a
10753 byte value 127 is converted to &`\x7f`&.
10754
10755
10756 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10757 .cindex "&%ipv6denorm%& expansion item"
10758 .cindex "IP address" normalisation
10759 This expands an IPv6 address to a full eight-element colon-separated set
10760 of hex digits including leading zeroes.
10761 A trailing ipv4-style dotted-decimal set is converted to hex.
10762 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10763
10764 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10765 .cindex "&%ipv6norm%& expansion item"
10766 .cindex "IP address" normalisation
10767 .cindex "IP address" "canonical form"
10768 This converts an IPv6 address to canonical form.
10769 Leading zeroes of groups are omitted, and the longest
10770 set of zero-valued groups is replaced with a double colon.
10771 A trailing ipv4-style dotted-decimal set is converted to hex.
10772 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10773
10774
10775 .vitem &*${lc:*&<&'string'&>&*}*&
10776 .cindex "case forcing in strings"
10777 .cindex "string" "case forcing"
10778 .cindex "lower casing"
10779 .cindex "expansion" "case forcing"
10780 .cindex "&%lc%& expansion item"
10781 This forces the letters in the string into lower-case, for example:
10782 .code
10783 ${lc:$local_part}
10784 .endd
10785 Case is defined per the system C locale.
10786
10787 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10788 .cindex "expansion" "string truncation"
10789 .cindex "&%length%& expansion item"
10790 The &%length%& operator is a simpler interface to the &%length%& function that
10791 can be used when the parameter is a fixed number (as opposed to a string that
10792 changes when expanded). The effect is the same as
10793 .code
10794 ${length{<number>}{<string>}}
10795 .endd
10796 See the description of the general &%length%& item above for details. Note that
10797 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10798 when &%length%& is used as an operator.
10799 All measurement is done in bytes and is not UTF-8 aware.
10800
10801
10802 .vitem &*${listcount:*&<&'string'&>&*}*&
10803 .cindex "expansion" "list item count"
10804 .cindex "list" "item count"
10805 .cindex "list" "count of items"
10806 .cindex "&%listcount%& expansion item"
10807 The string is interpreted as a list and the number of items is returned.
10808
10809
10810 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10811 .cindex "expansion" "named list"
10812 .cindex "&%listnamed%& expansion item"
10813 The name is interpreted as a named list and the content of the list is returned,
10814 expanding any referenced lists, re-quoting as needed for colon-separation.
10815 If the optional type is given it must be one of "a", "d", "h" or "l"
10816 and selects address-, domain-, host- or localpart- lists to search among respectively.
10817 Otherwise all types are searched in an undefined order and the first
10818 matching list is returned.
10819
10820
10821 .vitem &*${local_part:*&<&'string'&>&*}*&
10822 .cindex "expansion" "local part extraction"
10823 .cindex "&%local_part%& expansion item"
10824 The string is interpreted as an RFC 2822 address and the local part is
10825 extracted from it. If the string does not parse successfully, the result is
10826 empty.
10827 The parsing correctly handles SMTPUTF8 Unicode in the string.
10828
10829
10830 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10831 .cindex "masked IP address"
10832 .cindex "IP address" "masking"
10833 .cindex "CIDR notation"
10834 .cindex "expansion" "IP address masking"
10835 .cindex "&%mask%& expansion item"
10836 If the form of the string to be operated on is not an IP address followed by a
10837 slash and an integer (that is, a network address in CIDR notation), the
10838 expansion fails. Otherwise, this operator converts the IP address to binary,
10839 masks off the least significant bits according to the bit count, and converts
10840 the result back to text, with mask appended. For example,
10841 .code
10842 ${mask:10.111.131.206/28}
10843 .endd
10844 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10845 be mostly used for looking up masked addresses in files, the result for an IPv6
10846 address uses dots to separate components instead of colons, because colon
10847 terminates a key string in lsearch files. So, for example,
10848 .code
10849 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10850 .endd
10851 returns the string
10852 .code
10853 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10854 .endd
10855 Letters in IPv6 addresses are always output in lower case.
10856
10857
10858 .vitem &*${md5:*&<&'string'&>&*}*&
10859 .cindex "MD5 hash"
10860 .cindex "expansion" "MD5 hash"
10861 .cindex certificate fingerprint
10862 .cindex "&%md5%& expansion item"
10863 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10864 as a 32-digit hexadecimal number, in which any letters are in lower case.
10865
10866 If the string is a single variable of type certificate,
10867 returns the MD5 hash fingerprint of the certificate.
10868
10869
10870 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10871 .cindex "expansion" "numeric hash"
10872 .cindex "hash function" "numeric"
10873 The &%nhash%& operator is a simpler interface to the numeric hashing function
10874 that can be used when the two parameters are fixed numbers (as opposed to
10875 strings that change when expanded). The effect is the same as
10876 .code
10877 ${nhash{<n>}{<m>}{<string>}}
10878 .endd
10879 See the description of the general &%nhash%& item above for details.
10880
10881
10882 .vitem &*${quote:*&<&'string'&>&*}*&
10883 .cindex "quoting" "in string expansions"
10884 .cindex "expansion" "quoting"
10885 .cindex "&%quote%& expansion item"
10886 The &%quote%& operator puts its argument into double quotes if it
10887 is an empty string or
10888 contains anything other than letters, digits, underscores, dots, and hyphens.
10889 Any occurrences of double quotes and backslashes are escaped with a backslash.
10890 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10891 respectively For example,
10892 .code
10893 ${quote:ab"*"cd}
10894 .endd
10895 becomes
10896 .code
10897 "ab\"*\"cd"
10898 .endd
10899 The place where this is useful is when the argument is a substitution from a
10900 variable or a message header.
10901
10902 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10903 .cindex "&%quote_local_part%& expansion item"
10904 This operator is like &%quote%&, except that it quotes the string only if
10905 required to do so by the rules of RFC 2822 for quoting local parts. For
10906 example, a plus sign would not cause quoting (but it would for &%quote%&).
10907 If you are creating a new email address from the contents of &$local_part$&
10908 (or any other unknown data), you should always use this operator.
10909
10910 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10911 will likely use the quoting form.
10912 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10913
10914
10915 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10916 .cindex "quoting" "lookup-specific"
10917 This operator applies lookup-specific quoting rules to the string. Each
10918 query-style lookup type has its own quoting rules which are described with
10919 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10920 .code
10921 ${quote_ldap:two * two}
10922 .endd
10923 returns
10924 .code
10925 two%20%5C2A%20two
10926 .endd
10927 For single-key lookup types, no quoting is ever necessary and this operator
10928 yields an unchanged string.
10929
10930
10931 .vitem &*${randint:*&<&'n'&>&*}*&
10932 .cindex "random number"
10933 This operator returns a somewhat random number which is less than the
10934 supplied number and is at least 0.  The quality of this randomness depends
10935 on how Exim was built; the values are not suitable for keying material.
10936 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10937 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10938 for versions of GnuTLS with that function.
10939 Otherwise, the implementation may be arc4random(), random() seeded by
10940 srandomdev() or srandom(), or a custom implementation even weaker than
10941 random().
10942
10943
10944 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10945 .cindex "expansion" "IP address"
10946 This operator reverses an IP address; for IPv4 addresses, the result is in
10947 dotted-quad decimal form, while for IPv6 addresses the result is in
10948 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10949 for DNS.  For example,
10950 .code
10951 ${reverse_ip:192.0.2.4}
10952 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10953 .endd
10954 returns
10955 .code
10956 4.2.0.192
10957 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
10958 .endd
10959
10960
10961 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10962 .cindex "expansion" "RFC 2047"
10963 .cindex "RFC 2047" "expansion operator"
10964 .cindex "&%rfc2047%& expansion item"
10965 This operator encodes text according to the rules of RFC 2047. This is an
10966 encoding that is used in header lines to encode non-ASCII characters. It is
10967 assumed that the input string is in the encoding specified by the
10968 &%headers_charset%& option, which gets its default at build time. If the string
10969 contains only characters in the range 33&--126, and no instances of the
10970 characters
10971 .code
10972 ? = ( ) < > @ , ; : \ " . [ ] _
10973 .endd
10974 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10975 string, using as many &"encoded words"& as necessary to encode all the
10976 characters.
10977
10978
10979 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10980 .cindex "expansion" "RFC 2047"
10981 .cindex "RFC 2047" "decoding"
10982 .cindex "&%rfc2047d%& expansion item"
10983 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10984 bytes are replaced by question marks. Characters are converted into the
10985 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10986 not recognized unless &%check_rfc2047_length%& is set false.
10987
10988 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10989 access a header line, RFC 2047 decoding is done automatically. You do not need
10990 to use this operator as well.
10991
10992
10993
10994 .vitem &*${rxquote:*&<&'string'&>&*}*&
10995 .cindex "quoting" "in regular expressions"
10996 .cindex "regular expressions" "quoting"
10997 .cindex "&%rxquote%& expansion item"
10998 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10999 characters in its argument. This is useful when substituting the values of
11000 variables or headers inside regular expressions.
11001
11002
11003 .vitem &*${sha1:*&<&'string'&>&*}*&
11004 .cindex "SHA-1 hash"
11005 .cindex "expansion" "SHA-1 hashing"
11006 .cindex certificate fingerprint
11007 .cindex "&%sha1%& expansion item"
11008 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11009 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11010
11011 If the string is a single variable of type certificate,
11012 returns the SHA-1 hash fingerprint of the certificate.
11013
11014
11015 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11016        &*${sha2:*&<&'string'&>&*}*& &&&
11017        &*${sha2_<n>:*&<&'string'&>&*}*&
11018 .cindex "SHA-256 hash"
11019 .cindex "SHA-2 hash"
11020 .cindex certificate fingerprint
11021 .cindex "expansion" "SHA-256 hashing"
11022 .cindex "&%sha256%& expansion item"
11023 .cindex "&%sha2%& expansion item"
11024 The &%sha256%& operator computes the SHA-256 hash value of the string
11025 and returns
11026 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11027
11028 If the string is a single variable of type certificate,
11029 returns the SHA-256 hash fingerprint of the certificate.
11030
11031 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11032 (except for certificates, which are not supported).
11033 Finally, if an underbar
11034 and a number is appended it specifies the output length, selecting a
11035 member of the SHA-2 family of hash functions.
11036 Values of 256, 384 and 512 are accepted, with 256 being the default.
11037
11038
11039 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11040        &*${sha3_<n>:*&<&'string'&>&*}*&
11041 .cindex "SHA3 hash"
11042 .cindex "expansion" "SHA3 hashing"
11043 .cindex "&%sha3%& expansion item"
11044 The &%sha3%& operator computes the SHA3-256 hash value of the string
11045 and returns
11046 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11047
11048 If a number is appended, separated by an underbar, it specifies
11049 the output length.  Values of 224, 256, 384 and 512 are accepted;
11050 with 256 being the default.
11051
11052 The &%sha3%& expansion item is only supported if Exim has been
11053 compiled with GnuTLS 3.5.0 or later,
11054 or OpenSSL 1.1.1 or later.
11055 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11056
11057
11058 .vitem &*${stat:*&<&'string'&>&*}*&
11059 .cindex "expansion" "statting a file"
11060 .cindex "file" "extracting characteristics"
11061 .cindex "&%stat%& expansion item"
11062 The string, after expansion, must be a file path. A call to the &[stat()]&
11063 function is made for this path. If &[stat()]& fails, an error occurs and the
11064 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11065 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11066 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11067 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11068 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11069 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11070 can extract individual fields using the &%extract%& expansion item.
11071
11072 The use of the &%stat%& expansion in users' filter files can be locked out by
11073 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11074 systems for files larger than 2GB.
11075
11076 .vitem &*${str2b64:*&<&'string'&>&*}*&
11077 .cindex "&%str2b64%& expansion item"
11078 Now deprecated, a synonym for the &%base64%& expansion operator.
11079
11080
11081
11082 .vitem &*${strlen:*&<&'string'&>&*}*&
11083 .cindex "expansion" "string length"
11084 .cindex "string" "length in expansion"
11085 .cindex "&%strlen%& expansion item"
11086 The item is replace by the length of the expanded string, expressed as a
11087 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11088 All measurement is done in bytes and is not UTF-8 aware.
11089
11090
11091 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11092 .cindex "&%substr%& expansion item"
11093 .cindex "substring extraction"
11094 .cindex "expansion" "substring expansion"
11095 The &%substr%& operator is a simpler interface to the &%substr%& function that
11096 can be used when the two parameters are fixed numbers (as opposed to strings
11097 that change when expanded). The effect is the same as
11098 .code
11099 ${substr{<start>}{<length>}{<string>}}
11100 .endd
11101 See the description of the general &%substr%& item above for details. The
11102 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11103 All measurement is done in bytes and is not UTF-8 aware.
11104
11105 .vitem &*${time_eval:*&<&'string'&>&*}*&
11106 .cindex "&%time_eval%& expansion item"
11107 .cindex "time interval" "decoding"
11108 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11109 seconds.
11110
11111 .vitem &*${time_interval:*&<&'string'&>&*}*&
11112 .cindex "&%time_interval%& expansion item"
11113 .cindex "time interval" "formatting"
11114 The argument (after sub-expansion) must be a sequence of decimal digits that
11115 represents an interval of time as a number of seconds. It is converted into a
11116 number of larger units and output in Exim's normal time format, for example,
11117 &`1w3d4h2m6s`&.
11118
11119 .vitem &*${uc:*&<&'string'&>&*}*&
11120 .cindex "case forcing in strings"
11121 .cindex "string" "case forcing"
11122 .cindex "upper casing"
11123 .cindex "expansion" "case forcing"
11124 .cindex "&%uc%& expansion item"
11125 This forces the letters in the string into upper-case.
11126 Case is defined per the system C locale.
11127
11128 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11129 .cindex "correction of invalid utf-8 sequences in strings"
11130 .cindex "utf-8" "utf-8 sequences"
11131 .cindex "incorrect utf-8"
11132 .cindex "expansion" "utf-8 forcing"
11133 .cindex "&%utf8clean%& expansion item"
11134 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11135 In versions of Exim before 4.92, this did not correctly do so for a truncated
11136 final codepoint's encoding, and the character would be silently dropped.
11137 If you must handle detection of this scenario across both sets of Exim behavior,
11138 the complexity will depend upon the task.
11139 For instance, to detect if the first character is multibyte and a 1-byte
11140 extraction can be successfully used as a path component (as is common for
11141 dividing up delivery folders), you might use:
11142 .code
11143 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11144 .endd
11145 (which will false-positive if the first character of the local part is a
11146 literal question mark).
11147
11148 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11149        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11150        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11151        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11152 .cindex expansion UTF-8
11153 .cindex UTF-8 expansion
11154 .cindex EAI
11155 .cindex internationalisation
11156 .cindex "&%utf8_domain_to_alabel%& expansion item"
11157 .cindex "&%utf8_domain_from_alabel%& expansion item"
11158 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11159 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11160 These convert EAI mail name components between UTF-8 and a-label forms.
11161 For information on internationalisation support see &<<SECTi18nMTA>>&.
11162 .endlist
11163
11164
11165
11166
11167
11168
11169 .section "Expansion conditions" "SECTexpcond"
11170 .scindex IIDexpcond "expansion" "conditions"
11171 The following conditions are available for testing by the &%${if%& construct
11172 while expanding strings:
11173
11174 .vlist
11175 .vitem &*!*&<&'condition'&>
11176 .cindex "expansion" "negating a condition"
11177 .cindex "negation" "in expansion condition"
11178 Preceding any condition with an exclamation mark negates the result of the
11179 condition.
11180
11181 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11182 .cindex "numeric comparison"
11183 .cindex "expansion" "numeric comparison"
11184 There are a number of symbolic operators for doing numeric comparisons. They
11185 are:
11186 .display
11187 &`=   `&   equal
11188 &`==  `&   equal
11189 &`>   `&   greater
11190 &`>=  `&   greater or equal
11191 &`<   `&   less
11192 &`<=  `&   less or equal
11193 .endd
11194 For example:
11195 .code
11196 ${if >{$message_size}{10M} ...
11197 .endd
11198 Note that the general negation operator provides for inequality testing. The
11199 two strings must take the form of optionally signed decimal integers,
11200 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11201 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11202 As a special case, the numerical value of an empty string is taken as
11203 zero.
11204
11205 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11206 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11207 10M, not if 10M is larger than &$message_size$&.
11208
11209
11210 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11211         {*&<&'arg2'&>&*}...}*&
11212 .cindex "expansion" "calling an acl"
11213 .cindex "&%acl%&" "expansion condition"
11214 The name and zero to nine argument strings are first expanded separately.  The expanded
11215 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11216 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11217 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11218 and may use the variables; if another acl expansion is used the values
11219 are restored after it returns.  If the ACL sets
11220 a value using a "message =" modifier the variable $value becomes
11221 the result of the expansion, otherwise it is empty.
11222 If the ACL returns accept the condition is true; if deny, false.
11223 If the ACL returns defer the result is a forced-fail.
11224
11225 .vitem &*bool&~{*&<&'string'&>&*}*&
11226 .cindex "expansion" "boolean parsing"
11227 .cindex "&%bool%& expansion condition"
11228 This condition turns a string holding a true or false representation into
11229 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11230 (case-insensitively); also integer numbers map to true if non-zero,
11231 false if zero.
11232 An empty string is treated as false.
11233 Leading and trailing whitespace is ignored;
11234 thus a string consisting only of whitespace is false.
11235 All other string values will result in expansion failure.
11236
11237 When combined with ACL variables, this expansion condition will let you
11238 make decisions in one place and act on those decisions in another place.
11239 For example:
11240 .code
11241 ${if bool{$acl_m_privileged_sender} ...
11242 .endd
11243
11244
11245 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11246 .cindex "expansion" "boolean parsing"
11247 .cindex "&%bool_lax%& expansion condition"
11248 Like &%bool%&, this condition turns a string into a boolean state.  But
11249 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11250 loose definition that the Router &%condition%& option uses.  The empty string
11251 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11252 true.  Leading and trailing whitespace is ignored.
11253
11254 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11255
11256 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11257 .cindex "expansion" "encrypted comparison"
11258 .cindex "encrypted strings, comparing"
11259 .cindex "&%crypteq%& expansion condition"
11260 This condition is included in the Exim binary if it is built to support any
11261 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11262 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11263 included in the binary.
11264
11265 The &%crypteq%& condition has two arguments. The first is encrypted and
11266 compared against the second, which is already encrypted. The second string may
11267 be in the LDAP form for storing encrypted strings, which starts with the
11268 encryption type in curly brackets, followed by the data. If the second string
11269 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11270 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11271 Typically this will be a field from a password file. An example of an encrypted
11272 string in LDAP form is:
11273 .code
11274 {md5}CY9rzUYh03PK3k6DJie09g==
11275 .endd
11276 If such a string appears directly in an expansion, the curly brackets have to
11277 be quoted, because they are part of the expansion syntax. For example:
11278 .code
11279 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11280 .endd
11281 The following encryption types (whose names are matched case-independently) are
11282 supported:
11283
11284 .ilist
11285 .cindex "MD5 hash"
11286 .cindex "base64 encoding" "in encrypted password"
11287 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11288 printable characters to compare with the remainder of the second string. If the
11289 length of the comparison string is 24, Exim assumes that it is base64 encoded
11290 (as in the above example). If the length is 32, Exim assumes that it is a
11291 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11292 comparison fails.
11293
11294 .next
11295 .cindex "SHA-1 hash"
11296 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11297 printable characters to compare with the remainder of the second string. If the
11298 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11299 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11300 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11301
11302 .next
11303 .cindex "&[crypt()]&"
11304 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11305 only the first eight characters of the password. However, in modern operating
11306 systems this is no longer true, and in many cases the entire password is used,
11307 whatever its length.
11308
11309 .next
11310 .cindex "&[crypt16()]&"
11311 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11312 use up to 16 characters of the password in some operating systems. Again, in
11313 modern operating systems, more characters may be used.
11314 .endlist
11315 Exim has its own version of &[crypt16()]&, which is just a double call to
11316 &[crypt()]&. For operating systems that have their own version, setting
11317 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11318 operating system version instead of its own. This option is set by default in
11319 the OS-dependent &_Makefile_& for those operating systems that are known to
11320 support &[crypt16()]&.
11321
11322 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11323 it was not using the same algorithm as some operating systems' versions. It
11324 turns out that as well as &[crypt16()]& there is a function called
11325 &[bigcrypt()]& in some operating systems. This may or may not use the same
11326 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11327
11328 However, since there is now a move away from the traditional &[crypt()]&
11329 functions towards using SHA1 and other algorithms, tidying up this area of
11330 Exim is seen as very low priority.
11331
11332 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11333 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11334 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11335 default is &`{crypt}`&. Whatever the default, you can always use either
11336 function by specifying it explicitly in curly brackets.
11337
11338 .vitem &*def:*&<&'variable&~name'&>
11339 .cindex "expansion" "checking for empty variable"
11340 .cindex "&%def%& expansion condition"
11341 The &%def%& condition must be followed by the name of one of the expansion
11342 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11343 variable does not contain the empty string. For example:
11344 .code
11345 ${if def:sender_ident {from $sender_ident}}
11346 .endd
11347 Note that the variable name is given without a leading &%$%& character. If the
11348 variable does not exist, the expansion fails.
11349
11350 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11351         &~&*def:h_*&<&'header&~name'&>&*:*&"
11352 .cindex "expansion" "checking header line existence"
11353 This condition is true if a message is being processed and the named header
11354 exists in the message. For example,
11355 .code
11356 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11357 .endd
11358 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11359 the header name must be terminated by a colon if white space does not follow.
11360
11361 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11362        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11363 .cindex "string" "comparison"
11364 .cindex "expansion" "string comparison"
11365 .cindex "&%eq%& expansion condition"
11366 .cindex "&%eqi%& expansion condition"
11367 The two substrings are first expanded. The condition is true if the two
11368 resulting strings are identical. For &%eq%& the comparison includes the case of
11369 letters, whereas for &%eqi%& the comparison is case-independent, where
11370 case is defined per the system C locale.
11371
11372 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11373 .cindex "expansion" "file existence test"
11374 .cindex "file" "existence test"
11375 .cindex "&%exists%&, expansion condition"
11376 The substring is first expanded and then interpreted as an absolute path. The
11377 condition is true if the named file (or directory) exists. The existence test
11378 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11379 users' filter files may be locked out by the system administrator.
11380
11381 .vitem &*first_delivery*&
11382 .cindex "delivery" "first"
11383 .cindex "first delivery"
11384 .cindex "expansion" "first delivery test"
11385 .cindex "&%first_delivery%& expansion condition"
11386 This condition, which has no data, is true during a message's first delivery
11387 attempt. It is false during any subsequent delivery attempts.
11388
11389
11390 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11391        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11392 .cindex "list" "iterative conditions"
11393 .cindex "expansion" "&*forall*& condition"
11394 .cindex "expansion" "&*forany*& condition"
11395 .vindex "&$item$&"
11396 These conditions iterate over a list. The first argument is expanded to form
11397 the list. By default, the list separator is a colon, but it can be changed by
11398 the normal method (&<<SECTlistsepchange>>&).
11399 The second argument is interpreted as a condition that is to
11400 be applied to each item in the list in turn. During the interpretation of the
11401 condition, the current list item is placed in a variable called &$item$&.
11402 .ilist
11403 For &*forany*&, interpretation stops if the condition is true for any item, and
11404 the result of the whole condition is true. If the condition is false for all
11405 items in the list, the overall condition is false.
11406 .next
11407 For &*forall*&, interpretation stops if the condition is false for any item,
11408 and the result of the whole condition is false. If the condition is true for
11409 all items in the list, the overall condition is true.
11410 .endlist
11411 Note that negation of &*forany*& means that the condition must be false for all
11412 items for the overall condition to succeed, and negation of &*forall*& means
11413 that the condition must be false for at least one item. In this example, the
11414 list separator is changed to a comma:
11415 .code
11416 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11417 .endd
11418 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11419 being processed, to enable these expansion items to be nested.
11420
11421 To scan a named list, expand it with the &*listnamed*& operator.
11422
11423 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11424        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11425        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11426        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11427 .cindex JSON "iterative conditions"
11428 .cindex JSON expansions
11429 .cindex expansion "&*forall_json*& condition"
11430 .cindex expansion "&*forany_json*& condition"
11431 .cindex expansion "&*forall_jsons*& condition"
11432 .cindex expansion "&*forany_jsons*& condition"
11433 As for the above, except that the first argument must, after expansion,
11434 be a JSON array.
11435 The array separator is not changeable.
11436 For the &"jsons"& variants the elements are expected to be JSON strings
11437 and have their quotes removed before the evaluation of the condition.
11438
11439
11440
11441 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11442        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11443 .cindex "string" "comparison"
11444 .cindex "expansion" "string comparison"
11445 .cindex "&%ge%& expansion condition"
11446 .cindex "&%gei%& expansion condition"
11447 The two substrings are first expanded. The condition is true if the first
11448 string is lexically greater than or equal to the second string. For &%ge%& the
11449 comparison includes the case of letters, whereas for &%gei%& the comparison is
11450 case-independent.
11451 Case and collation order are defined per the system C locale.
11452
11453 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11454        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11455 .cindex "string" "comparison"
11456 .cindex "expansion" "string comparison"
11457 .cindex "&%gt%& expansion condition"
11458 .cindex "&%gti%& expansion condition"
11459 The two substrings are first expanded. The condition is true if the first
11460 string is lexically greater than the second string. For &%gt%& the comparison
11461 includes the case of letters, whereas for &%gti%& the comparison is
11462 case-independent.
11463 Case and collation order are defined per the system C locale.
11464
11465 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11466        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11467 .cindex "string" "comparison"
11468 .cindex "list" "iterative conditions"
11469 Both strings are expanded; the second string is treated as a list of simple
11470 strings; if the first string is a member of the second, then the condition
11471 is true.
11472 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11473
11474 These are simpler to use versions of the more powerful &*forany*& condition.
11475 Examples, and the &*forany*& equivalents:
11476 .code
11477 ${if inlist{needle}{foo:needle:bar}}
11478   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11479 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11480   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11481 .endd
11482
11483 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11484        &*isip4&~{*&<&'string'&>&*}*& &&&
11485        &*isip6&~{*&<&'string'&>&*}*&
11486 .cindex "IP address" "testing string format"
11487 .cindex "string" "testing for IP address"
11488 .cindex "&%isip%& expansion condition"
11489 .cindex "&%isip4%& expansion condition"
11490 .cindex "&%isip6%& expansion condition"
11491 The substring is first expanded, and then tested to see if it has the form of
11492 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11493 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11494
11495 For an IPv4 address, the test is for four dot-separated components, each of
11496 which consists of from one to three digits. For an IPv6 address, up to eight
11497 colon-separated components are permitted, each containing from one to four
11498 hexadecimal digits. There may be fewer than eight components if an empty
11499 component (adjacent colons) is present. Only one empty component is permitted.
11500
11501 &*Note*&: The checks used to be just on the form of the address; actual numerical
11502 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11503 check.
11504 This is no longer the case.
11505
11506 The main use of these tests is to distinguish between IP addresses and
11507 host names, or between IPv4 and IPv6 addresses. For example, you could use
11508 .code
11509 ${if isip4{$sender_host_address}...
11510 .endd
11511 to test which IP version an incoming SMTP connection is using.
11512
11513 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11514 .cindex "LDAP" "use for authentication"
11515 .cindex "expansion" "LDAP authentication test"
11516 .cindex "&%ldapauth%& expansion condition"
11517 This condition supports user authentication using LDAP. See section
11518 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11519 queries. For this use, the query must contain a user name and password. The
11520 query itself is not used, and can be empty. The condition is true if the
11521 password is not empty, and the user name and password are accepted by the LDAP
11522 server. An empty password is rejected without calling LDAP because LDAP binds
11523 with an empty password are considered anonymous regardless of the username, and
11524 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11525 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11526 this can be used.
11527
11528
11529 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11530        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11531 .cindex "string" "comparison"
11532 .cindex "expansion" "string comparison"
11533 .cindex "&%le%& expansion condition"
11534 .cindex "&%lei%& expansion condition"
11535 The two substrings are first expanded. The condition is true if the first
11536 string is lexically less than or equal to the second string. For &%le%& the
11537 comparison includes the case of letters, whereas for &%lei%& the comparison is
11538 case-independent.
11539 Case and collation order are defined per the system C locale.
11540
11541 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11542        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11543 .cindex "string" "comparison"
11544 .cindex "expansion" "string comparison"
11545 .cindex "&%lt%& expansion condition"
11546 .cindex "&%lti%& expansion condition"
11547 The two substrings are first expanded. The condition is true if the first
11548 string is lexically less than the second string. For &%lt%& the comparison
11549 includes the case of letters, whereas for &%lti%& the comparison is
11550 case-independent.
11551 Case and collation order are defined per the system C locale.
11552
11553
11554 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11555 .cindex "expansion" "regular expression comparison"
11556 .cindex "regular expressions" "match in expanded string"
11557 .cindex "&%match%& expansion condition"
11558 The two substrings are first expanded. The second is then treated as a regular
11559 expression and applied to the first. Because of the pre-expansion, if the
11560 regular expression contains dollar, or backslash characters, they must be
11561 escaped. Care must also be taken if the regular expression contains braces
11562 (curly brackets). A closing brace must be escaped so that it is not taken as a
11563 premature termination of <&'string2'&>. The easiest approach is to use the
11564 &`\N`& feature to disable expansion of the regular expression.
11565 For example,
11566 .code
11567 ${if match {$local_part}{\N^\d{3}\N} ...
11568 .endd
11569 If the whole expansion string is in double quotes, further escaping of
11570 backslashes is also required.
11571
11572 The condition is true if the regular expression match succeeds.
11573 The regular expression is not required to begin with a circumflex
11574 metacharacter, but if there is no circumflex, the expression is not anchored,
11575 and it may match anywhere in the subject, not just at the start. If you want
11576 the pattern to match at the end of the subject, you must include the &`$`&
11577 metacharacter at an appropriate point.
11578 All character handling is done in bytes and is not UTF-8 aware,
11579 but we might change this in a future Exim release.
11580
11581 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11582 At the start of an &%if%& expansion the values of the numeric variable
11583 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11584 succeeds causes them to be reset to the substrings of that condition and they
11585 will have these values during the expansion of the success string. At the end
11586 of the &%if%& expansion, the previous values are restored. After testing a
11587 combination of conditions using &%or%&, the subsequent values of the numeric
11588 variables are those of the condition that succeeded.
11589
11590 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11591 .cindex "&%match_address%& expansion condition"
11592 See &*match_local_part*&.
11593
11594 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11595 .cindex "&%match_domain%& expansion condition"
11596 See &*match_local_part*&.
11597
11598 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11599 .cindex "&%match_ip%& expansion condition"
11600 This condition matches an IP address to a list of IP address patterns. It must
11601 be followed by two argument strings. The first (after expansion) must be an IP
11602 address or an empty string. The second (not expanded) is a restricted host
11603 list that can match only an IP address, not a host name. For example:
11604 .code
11605 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11606 .endd
11607 The specific types of host list item that are permitted in the list are:
11608
11609 .ilist
11610 An IP address, optionally with a CIDR mask.
11611 .next
11612 A single asterisk, which matches any IP address.
11613 .next
11614 An empty item, which matches only if the IP address is empty. This could be
11615 useful for testing for a locally submitted message or one from specific hosts
11616 in a single test such as
11617 . ==== As this is a nested list, any displays it contains must be indented
11618 . ==== as otherwise they are too far to the left. This comment applies to
11619 . ==== the use of xmlto plus fop. There's no problem when formatting with
11620 . ==== sdop, with or without the extra indent.
11621 .code
11622   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11623 .endd
11624 where the first item in the list is the empty string.
11625 .next
11626 The item @[] matches any of the local host's interface addresses.
11627 .next
11628 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11629 even if &`net-`& is not specified. There is never any attempt to turn the IP
11630 address into a host name. The most common type of linear search for
11631 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11632 masks. For example:
11633 .code
11634   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11635 .endd
11636 It is of course possible to use other kinds of lookup, and in such a case, you
11637 do need to specify the &`net-`& prefix if you want to specify a specific
11638 address mask, for example:
11639 .code
11640   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11641 .endd
11642 However, unless you are combining a &%match_ip%& condition with others, it is
11643 just as easy to use the fact that a lookup is itself a condition, and write:
11644 .code
11645   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11646 .endd
11647 .endlist ilist
11648
11649 Note that <&'string2'&> is not itself subject to string expansion, unless
11650 Exim was built with the EXPAND_LISTMATCH_RHS option.
11651
11652 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11653
11654 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11655 .cindex "domain list" "in expansion condition"
11656 .cindex "address list" "in expansion condition"
11657 .cindex "local part" "list, in expansion condition"
11658 .cindex "&%match_local_part%& expansion condition"
11659 This condition, together with &%match_address%& and &%match_domain%&, make it
11660 possible to test domain, address, and local part lists within expansions. Each
11661 condition requires two arguments: an item and a list to match. A trivial
11662 example is:
11663 .code
11664 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11665 .endd
11666 In each case, the second argument may contain any of the allowable items for a
11667 list of the appropriate type. Also, because the second argument
11668 is a standard form of list, it is possible to refer to a named list.
11669 Thus, you can use conditions like this:
11670 .code
11671 ${if match_domain{$domain}{+local_domains}{...
11672 .endd
11673 .cindex "&`+caseful`&"
11674 For address lists, the matching starts off caselessly, but the &`+caseful`&
11675 item can be used, as in all address lists, to cause subsequent items to
11676 have their local parts matched casefully. Domains are always matched
11677 caselessly.
11678
11679 Note that <&'string2'&> is not itself subject to string expansion, unless
11680 Exim was built with the EXPAND_LISTMATCH_RHS option.
11681
11682 &*Note*&: Host lists are &'not'& supported in this way. This is because
11683 hosts have two identities: a name and an IP address, and it is not clear
11684 how to specify cleanly how such a test would work. However, IP addresses can be
11685 matched using &%match_ip%&.
11686
11687 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11688 .cindex "PAM authentication"
11689 .cindex "AUTH" "with PAM"
11690 .cindex "Solaris" "PAM support"
11691 .cindex "expansion" "PAM authentication test"
11692 .cindex "&%pam%& expansion condition"
11693 &'Pluggable Authentication Modules'&
11694 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11695 available in the latest releases of Solaris and in some GNU/Linux
11696 distributions. The Exim support, which is intended for use in conjunction with
11697 the SMTP AUTH command, is available only if Exim is compiled with
11698 .code
11699 SUPPORT_PAM=yes
11700 .endd
11701 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11702 in some releases of GNU/Linux &%-ldl%& is also needed.
11703
11704 The argument string is first expanded, and the result must be a
11705 colon-separated list of strings. Leading and trailing white space is ignored.
11706 The PAM module is initialized with the service name &"exim"& and the user name
11707 taken from the first item in the colon-separated data string (<&'string1'&>).
11708 The remaining items in the data string are passed over in response to requests
11709 from the authentication function. In the simple case there will only be one
11710 request, for a password, so the data consists of just two strings.
11711
11712 There can be problems if any of the strings are permitted to contain colon
11713 characters. In the usual way, these have to be doubled to avoid being taken as
11714 separators. If the data is being inserted from a variable, the &%sg%& expansion
11715 item can be used to double any existing colons. For example, the configuration
11716 of a LOGIN authenticator might contain this setting:
11717 .code
11718 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11719 .endd
11720 For a PLAIN authenticator you could use:
11721 .code
11722 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11723 .endd
11724 In some operating systems, PAM authentication can be done only from a process
11725 running as root. Since Exim is running as the Exim user when receiving
11726 messages, this means that PAM cannot be used directly in those systems.
11727 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11728
11729
11730 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11731 .cindex "&'pwcheck'& daemon"
11732 .cindex "Cyrus"
11733 .cindex "expansion" "&'pwcheck'& authentication test"
11734 .cindex "&%pwcheck%& expansion condition"
11735 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11736 This is one way of making it possible for passwords to be checked by a process
11737 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11738 deprecated. Its replacement is &'saslauthd'& (see below).
11739
11740 The pwcheck support is not included in Exim by default. You need to specify
11741 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11742 building Exim. For example:
11743 .code
11744 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11745 .endd
11746 You do not need to install the full Cyrus software suite in order to use
11747 the pwcheck daemon. You can compile and install just the daemon alone
11748 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11749 access to the &_/var/pwcheck_& directory.
11750
11751 The &%pwcheck%& condition takes one argument, which must be the user name and
11752 password, separated by a colon. For example, in a LOGIN authenticator
11753 configuration, you might have this:
11754 .code
11755 server_condition = ${if pwcheck{$auth1:$auth2}}
11756 .endd
11757 Again, for a PLAIN authenticator configuration, this would be:
11758 .code
11759 server_condition = ${if pwcheck{$auth2:$auth3}}
11760 .endd
11761 .vitem &*queue_running*&
11762 .cindex "queue runner" "detecting when delivering from"
11763 .cindex "expansion" "queue runner test"
11764 .cindex "&%queue_running%& expansion condition"
11765 This condition, which has no data, is true during delivery attempts that are
11766 initiated by queue runner processes, and false otherwise.
11767
11768
11769 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11770 .cindex "Radius"
11771 .cindex "expansion" "Radius authentication"
11772 .cindex "&%radius%& expansion condition"
11773 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11774 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11775 the Radius client configuration file in order to build Exim with Radius
11776 support.
11777
11778 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11779 library, using the original API. If you are using release 0.4.0 or later of
11780 this library, you need to set
11781 .code
11782 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11783 .endd
11784 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11785 &%libradius%& library that comes with FreeBSD. To do this, set
11786 .code
11787 RADIUS_LIB_TYPE=RADLIB
11788 .endd
11789 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11790 You may also have to supply a suitable setting in EXTRALIBS so that the
11791 Radius library can be found when Exim is linked.
11792
11793 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11794 Radius client library, which calls the Radius server. The condition is true if
11795 the authentication is successful. For example:
11796 .code
11797 server_condition = ${if radius{<arguments>}}
11798 .endd
11799
11800
11801 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11802         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11803 .cindex "&'saslauthd'& daemon"
11804 .cindex "Cyrus"
11805 .cindex "expansion" "&'saslauthd'& authentication test"
11806 .cindex "&%saslauthd%& expansion condition"
11807 This condition supports user authentication using the Cyrus &'saslauthd'&
11808 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11809 Using this daemon is one way of making it possible for passwords to be checked
11810 by a process that is not running as root.
11811
11812 The saslauthd support is not included in Exim by default. You need to specify
11813 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11814 building Exim. For example:
11815 .code
11816 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11817 .endd
11818 You do not need to install the full Cyrus software suite in order to use
11819 the saslauthd daemon. You can compile and install just the daemon alone
11820 from the Cyrus SASL library.
11821
11822 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11823 two are mandatory. For example:
11824 .code
11825 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11826 .endd
11827 The service and the realm are optional (which is why the arguments are enclosed
11828 in their own set of braces). For details of the meaning of the service and
11829 realm, and how to run the daemon, consult the Cyrus documentation.
11830 .endlist vlist
11831
11832
11833
11834 .section "Combining expansion conditions" "SECID84"
11835 .cindex "expansion" "combining conditions"
11836 Several conditions can be tested at once by combining them using the &%and%&
11837 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11838 conditions on their own, and precede their lists of sub-conditions. Each
11839 sub-condition must be enclosed in braces within the overall braces that contain
11840 the list. No repetition of &%if%& is used.
11841
11842
11843 .vlist
11844 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11845 .cindex "&""or""& expansion condition"
11846 .cindex "expansion" "&""or""& of conditions"
11847 The sub-conditions are evaluated from left to right. The condition is true if
11848 any one of the sub-conditions is true.
11849 For example,
11850 .code
11851 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11852 .endd
11853 When a true sub-condition is found, the following ones are parsed but not
11854 evaluated. If there are several &"match"& sub-conditions the values of the
11855 numeric variables afterwards are taken from the first one that succeeds.
11856
11857 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11858 .cindex "&""and""& expansion condition"
11859 .cindex "expansion" "&""and""& of conditions"
11860 The sub-conditions are evaluated from left to right. The condition is true if
11861 all of the sub-conditions are true. If there are several &"match"&
11862 sub-conditions, the values of the numeric variables afterwards are taken from
11863 the last one. When a false sub-condition is found, the following ones are
11864 parsed but not evaluated.
11865 .endlist
11866 .ecindex IIDexpcond
11867
11868
11869
11870
11871 .section "Expansion variables" "SECTexpvar"
11872 .cindex "expansion" "variables, list of"
11873 This section contains an alphabetical list of all the expansion variables. Some
11874 of them are available only when Exim is compiled with specific options such as
11875 support for TLS or the content scanning extension.
11876
11877 .vlist
11878 .vitem "&$0$&, &$1$&, etc"
11879 .cindex "numerical variables (&$1$& &$2$& etc)"
11880 When a &%match%& expansion condition succeeds, these variables contain the
11881 captured substrings identified by the regular expression during subsequent
11882 processing of the success string of the containing &%if%& expansion item.
11883 In the expansion condition case
11884 they do not retain their values afterwards; in fact, their previous
11885 values are restored at the end of processing an &%if%& item. The numerical
11886 variables may also be set externally by some other matching process which
11887 precedes the expansion of the string. For example, the commands available in
11888 Exim filter files include an &%if%& command with its own regular expression
11889 matching condition.
11890
11891 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11892 Within an acl condition, expansion condition or expansion item
11893 any arguments are copied to these variables,
11894 any unused variables being made empty.
11895
11896 .vitem "&$acl_c...$&"
11897 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11898 can be given any name that starts with &$acl_c$& and is at least six characters
11899 long, but the sixth character must be either a digit or an underscore. For
11900 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11901 variables persist throughout the lifetime of an SMTP connection. They can be
11902 used to pass information between ACLs and between different invocations of the
11903 same ACL. When a message is received, the values of these variables are saved
11904 with the message, and can be accessed by filters, routers, and transports
11905 during subsequent delivery.
11906
11907 .vitem "&$acl_m...$&"
11908 These variables are like the &$acl_c...$& variables, except that their values
11909 are reset after a message has been received. Thus, if several messages are
11910 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11911 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11912 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11913 message is received, the values of these variables are saved with the message,
11914 and can be accessed by filters, routers, and transports during subsequent
11915 delivery.
11916
11917 .vitem &$acl_narg$&
11918 Within an acl condition, expansion condition or expansion item
11919 this variable has the number of arguments.
11920
11921 .vitem &$acl_verify_message$&
11922 .vindex "&$acl_verify_message$&"
11923 After an address verification has failed, this variable contains the failure
11924 message. It retains its value for use in subsequent modifiers. The message can
11925 be preserved by coding like this:
11926 .code
11927 warn !verify = sender
11928      set acl_m0 = $acl_verify_message
11929 .endd
11930 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11931 &%log_message%& modifiers, to include information about the verification
11932 failure.
11933
11934 .vitem &$address_data$&
11935 .vindex "&$address_data$&"
11936 This variable is set by means of the &%address_data%& option in routers. The
11937 value then remains with the address while it is processed by subsequent routers
11938 and eventually a transport. If the transport is handling multiple addresses,
11939 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11940 for more details. &*Note*&: The contents of &$address_data$& are visible in
11941 user filter files.
11942
11943 If &$address_data$& is set when the routers are called from an ACL to verify
11944 a recipient address, the final value is still in the variable for subsequent
11945 conditions and modifiers of the ACL statement. If routing the address caused it
11946 to be redirected to just one address, the child address is also routed as part
11947 of the verification, and in this case the final value of &$address_data$& is
11948 from the child's routing.
11949
11950 If &$address_data$& is set when the routers are called from an ACL to verify a
11951 sender address, the final value is also preserved, but this time in
11952 &$sender_address_data$&, to distinguish it from data from a recipient
11953 address.
11954
11955 In both cases (recipient and sender verification), the value does not persist
11956 after the end of the current ACL statement. If you want to preserve
11957 these values for longer, you can save them in ACL variables.
11958
11959 .vitem &$address_file$&
11960 .vindex "&$address_file$&"
11961 When, as a result of aliasing, forwarding, or filtering, a message is directed
11962 to a specific file, this variable holds the name of the file when the transport
11963 is running. At other times, the variable is empty. For example, using the
11964 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11965 .code
11966 /home/r2d2/savemail
11967 .endd
11968 then when the &(address_file)& transport is running, &$address_file$&
11969 contains the text string &`/home/r2d2/savemail`&.
11970 .cindex "Sieve filter" "value of &$address_file$&"
11971 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11972 then up to the transport configuration to generate an appropriate absolute path
11973 to the relevant file.
11974
11975 .vitem &$address_pipe$&
11976 .vindex "&$address_pipe$&"
11977 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11978 this variable holds the pipe command when the transport is running.
11979
11980 .vitem "&$auth1$& &-- &$auth3$&"
11981 .vindex "&$auth1$&, &$auth2$&, etc"
11982 These variables are used in SMTP authenticators (see chapters
11983 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11984
11985 .vitem &$authenticated_id$&
11986 .cindex "authentication" "id"
11987 .vindex "&$authenticated_id$&"
11988 When a server successfully authenticates a client it may be configured to
11989 preserve some of the authentication information in the variable
11990 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11991 user/password authenticator configuration might preserve the user name for use
11992 in the routers. Note that this is not the same information that is saved in
11993 &$sender_host_authenticated$&.
11994
11995 When a message is submitted locally (that is, not over a TCP connection)
11996 the value of &$authenticated_id$& is normally the login name of the calling
11997 process. However, a trusted user can override this by means of the &%-oMai%&
11998 command line option.
11999 This second case also sets up information used by the
12000 &$authresults$& expansion item.
12001
12002 .vitem &$authenticated_fail_id$&
12003 .cindex "authentication" "fail" "id"
12004 .vindex "&$authenticated_fail_id$&"
12005 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12006 will contain the failed authentication id. If more than one authentication
12007 id is attempted, it will contain only the last one. The variable is
12008 available for processing in the ACL's, generally the quit or notquit ACL.
12009 A message to a local recipient could still be accepted without requiring
12010 authentication, which means this variable could also be visible in all of
12011 the ACL's as well.
12012
12013
12014 .vitem &$authenticated_sender$&
12015 .cindex "sender" "authenticated"
12016 .cindex "authentication" "sender"
12017 .cindex "AUTH" "on MAIL command"
12018 .vindex "&$authenticated_sender$&"
12019 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12020 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12021 described in section &<<SECTauthparamail>>&. Unless the data is the string
12022 &"<>"&, it is set as the authenticated sender of the message, and the value is
12023 available during delivery in the &$authenticated_sender$& variable. If the
12024 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12025
12026 .vindex "&$qualify_domain$&"
12027 When a message is submitted locally (that is, not over a TCP connection), the
12028 value of &$authenticated_sender$& is an address constructed from the login
12029 name of the calling process and &$qualify_domain$&, except that a trusted user
12030 can override this by means of the &%-oMas%& command line option.
12031
12032
12033 .vitem &$authentication_failed$&
12034 .cindex "authentication" "failure"
12035 .vindex "&$authentication_failed$&"
12036 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12037 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12038 possible to distinguish between &"did not try to authenticate"&
12039 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12040 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12041 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12042 negative response to an AUTH command, including (for example) an attempt to use
12043 an undefined mechanism.
12044
12045 .vitem &$av_failed$&
12046 .cindex "content scanning" "AV scanner failure"
12047 This variable is available when Exim is compiled with the content-scanning
12048 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12049 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12050 the ACL malware condition.
12051
12052 .vitem &$body_linecount$&
12053 .cindex "message body" "line count"
12054 .cindex "body of message" "line count"
12055 .vindex "&$body_linecount$&"
12056 When a message is being received or delivered, this variable contains the
12057 number of lines in the message's body. See also &$message_linecount$&.
12058
12059 .vitem &$body_zerocount$&
12060 .cindex "message body" "binary zero count"
12061 .cindex "body of message" "binary zero count"
12062 .cindex "binary zero" "in message body"
12063 .vindex "&$body_zerocount$&"
12064 When a message is being received or delivered, this variable contains the
12065 number of binary zero bytes (ASCII NULs) in the message's body.
12066
12067 .vitem &$bounce_recipient$&
12068 .vindex "&$bounce_recipient$&"
12069 This is set to the recipient address of a bounce message while Exim is creating
12070 it. It is useful if a customized bounce message text file is in use (see
12071 chapter &<<CHAPemsgcust>>&).
12072
12073 .vitem &$bounce_return_size_limit$&
12074 .vindex "&$bounce_return_size_limit$&"
12075 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12076 up to a multiple of 1000. It is useful when a customized error message text
12077 file is in use (see chapter &<<CHAPemsgcust>>&).
12078
12079 .vitem &$caller_gid$&
12080 .cindex "gid (group id)" "caller"
12081 .vindex "&$caller_gid$&"
12082 The real group id under which the process that called Exim was running. This is
12083 not the same as the group id of the originator of a message (see
12084 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12085 incarnation normally contains the Exim gid.
12086
12087 .vitem &$caller_uid$&
12088 .cindex "uid (user id)" "caller"
12089 .vindex "&$caller_uid$&"
12090 The real user id under which the process that called Exim was running. This is
12091 not the same as the user id of the originator of a message (see
12092 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12093 incarnation normally contains the Exim uid.
12094
12095 .vitem &$callout_address$&
12096 .vindex "&$callout_address$&"
12097 After a callout for verification, spamd or malware daemon service, the
12098 address that was connected to.
12099
12100 .vitem &$compile_number$&
12101 .vindex "&$compile_number$&"
12102 The building process for Exim keeps a count of the number
12103 of times it has been compiled. This serves to distinguish different
12104 compilations of the same version of Exim.
12105
12106 .vitem &$config_dir$&
12107 .vindex "&$config_dir$&"
12108 The directory name of the main configuration file. That is, the content of
12109 &$config_file$& with the last component stripped. The value does not
12110 contain the trailing slash. If &$config_file$& does not contain a slash,
12111 &$config_dir$& is ".".
12112
12113 .vitem &$config_file$&
12114 .vindex "&$config_file$&"
12115 The name of the main configuration file Exim is using.
12116
12117 .vitem &$dmarc_domain_policy$& &&&
12118        &$dmarc_status$& &&&
12119        &$dmarc_status_text$& &&&
12120        &$dmarc_used_domains$&
12121 Results of DMARC verification.
12122 For details see section &<<SECDMARC>>&.
12123
12124 .vitem &$dkim_verify_status$&
12125 Results of DKIM verification.
12126 For details see section &<<SECDKIMVFY>>&.
12127
12128 .vitem &$dkim_cur_signer$& &&&
12129        &$dkim_verify_reason$& &&&
12130        &$dkim_domain$& &&&
12131        &$dkim_identity$& &&&
12132        &$dkim_selector$& &&&
12133        &$dkim_algo$& &&&
12134        &$dkim_canon_body$& &&&
12135        &$dkim_canon_headers$& &&&
12136        &$dkim_copiedheaders$& &&&
12137        &$dkim_bodylength$& &&&
12138        &$dkim_created$& &&&
12139        &$dkim_expires$& &&&
12140        &$dkim_headernames$& &&&
12141        &$dkim_key_testing$& &&&
12142        &$dkim_key_nosubdomains$& &&&
12143        &$dkim_key_srvtype$& &&&
12144        &$dkim_key_granularity$& &&&
12145        &$dkim_key_notes$& &&&
12146        &$dkim_key_length$&
12147 These variables are only available within the DKIM ACL.
12148 For details see section &<<SECDKIMVFY>>&.
12149
12150 .vitem &$dkim_signers$&
12151 .vindex &$dkim_signers$&
12152 When a message has been received this variable contains
12153 a colon-separated list of signer domains and identities for the message.
12154 For details see section &<<SECDKIMVFY>>&.
12155
12156 .vitem &$dnslist_domain$& &&&
12157        &$dnslist_matched$& &&&
12158        &$dnslist_text$& &&&
12159        &$dnslist_value$&
12160 .vindex "&$dnslist_domain$&"
12161 .vindex "&$dnslist_matched$&"
12162 .vindex "&$dnslist_text$&"
12163 .vindex "&$dnslist_value$&"
12164 .cindex "black list (DNS)"
12165 When a DNS (black) list lookup succeeds, these variables are set to contain
12166 the following data from the lookup: the list's domain name, the key that was
12167 looked up, the contents of any associated TXT record, and the value from the
12168 main A record. See section &<<SECID204>>& for more details.
12169
12170 .vitem &$domain$&
12171 .vindex "&$domain$&"
12172 When an address is being routed, or delivered on its own, this variable
12173 contains the domain. Uppercase letters in the domain are converted into lower
12174 case for &$domain$&.
12175
12176 Global address rewriting happens when a message is received, so the value of
12177 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12178 is set during user filtering, but not during system filtering, because a
12179 message may have many recipients and the system filter is called just once.
12180
12181 When more than one address is being delivered at once (for example, several
12182 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12183 have the same domain. Transports can be restricted to handling only one domain
12184 at a time if the value of &$domain$& is required at transport time &-- this is
12185 the default for local transports. For further details of the environment in
12186 which local transports are run, see chapter &<<CHAPenvironment>>&.
12187
12188 .oindex "&%delay_warning_condition%&"
12189 At the end of a delivery, if all deferred addresses have the same domain, it is
12190 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12191
12192 The &$domain$& variable is also used in some other circumstances:
12193
12194 .ilist
12195 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12196 the recipient address. The domain of the &'sender'& address is in
12197 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12198 normally set during the running of the MAIL ACL. However, if the sender address
12199 is verified with a callout during the MAIL ACL, the sender domain is placed in
12200 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12201 the &(smtp)& transport.
12202
12203 .next
12204 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12205 &$domain$& contains the domain portion of the address that is being rewritten;
12206 it can be used in the expansion of the replacement address, for example, to
12207 rewrite domains by file lookup.
12208
12209 .next
12210 With one important exception, whenever a domain list is being scanned,
12211 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12212 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12213 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12214 that, in a RCPT ACL, the sender domain list can be dependent on the
12215 recipient domain (which is what is in &$domain$& at this time).
12216
12217 .next
12218 .cindex "ETRN" "value of &$domain$&"
12219 .oindex "&%smtp_etrn_command%&"
12220 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12221 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12222 .endlist
12223
12224 .new
12225 .cindex "tainted data"
12226 If the origin of the data is an incoming message,
12227 the result of expanding this variable is tainted.
12228 See also &$domain_verified$&.
12229 .wen
12230
12231
12232 .vitem &$domain_data$&
12233 .vindex "&$domain_data$&"
12234 When the &%domains%& option on a router matches a domain by
12235 means of a lookup, the data read by the lookup is available during the running
12236 of the router as &$domain_data$&. In addition, if the driver routes the
12237 address to a transport, the value is available in that transport. If the
12238 transport is handling multiple addresses, the value from the first address is
12239 used.
12240
12241 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12242 domain by means of a lookup. The data read by the lookup is available during
12243 the rest of the ACL statement. In all other situations, this variable expands
12244 to nothing.
12245
12246 .vitem &$exim_gid$&
12247 .vindex "&$exim_gid$&"
12248 This variable contains the numerical value of the Exim group id.
12249
12250 .vitem &$exim_path$&
12251 .vindex "&$exim_path$&"
12252 This variable contains the path to the Exim binary.
12253
12254 .vitem &$exim_uid$&
12255 .vindex "&$exim_uid$&"
12256 This variable contains the numerical value of the Exim user id.
12257
12258 .vitem &$exim_version$&
12259 .vindex "&$exim_version$&"
12260 This variable contains the version string of the Exim build.
12261 The first character is a major version number, currently 4.
12262 Then after a dot, the next group of digits is a minor version number.
12263 There may be other characters following the minor version.
12264 This value may be overridden by the &%exim_version%& main config option.
12265
12266 .vitem &$header_$&<&'name'&>
12267 This is not strictly an expansion variable. It is expansion syntax for
12268 inserting the message header line with the given name. Note that the name must
12269 be terminated by colon or white space, because it may contain a wide variety of
12270 characters. Note also that braces must &'not'& be used.
12271 See the full description in section &<<SECTexpansionitems>>& above.
12272
12273 .vitem &$headers_added$&
12274 .vindex "&$headers_added$&"
12275 Within an ACL this variable contains the headers added so far by
12276 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12277 The headers are a newline-separated list.
12278
12279 .vitem &$home$&
12280 .vindex "&$home$&"
12281 When the &%check_local_user%& option is set for a router, the user's home
12282 directory is placed in &$home$& when the check succeeds. In particular, this
12283 means it is set during the running of users' filter files. A router may also
12284 explicitly set a home directory for use by a transport; this can be overridden
12285 by a setting on the transport itself.
12286
12287 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12288 of the environment variable HOME, which is subject to the
12289 &%keep_environment%& and &%add_environment%& main config options.
12290
12291 .vitem &$host$&
12292 .vindex "&$host$&"
12293 If a router assigns an address to a transport (any transport), and passes a
12294 list of hosts with the address, the value of &$host$& when the transport starts
12295 to run is the name of the first host on the list. Note that this applies both
12296 to local and remote transports.
12297
12298 .cindex "transport" "filter"
12299 .cindex "filter" "transport filter"
12300 For the &(smtp)& transport, if there is more than one host, the value of
12301 &$host$& changes as the transport works its way through the list. In
12302 particular, when the &(smtp)& transport is expanding its options for encryption
12303 using TLS, or for specifying a transport filter (see chapter
12304 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12305 is connected.
12306
12307 When used in the client part of an authenticator configuration (see chapter
12308 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12309 client is connected.
12310
12311
12312 .vitem &$host_address$&
12313 .vindex "&$host_address$&"
12314 This variable is set to the remote host's IP address whenever &$host$& is set
12315 for a remote connection. It is also set to the IP address that is being checked
12316 when the &%ignore_target_hosts%& option is being processed.
12317
12318 .vitem &$host_data$&
12319 .vindex "&$host_data$&"
12320 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12321 result of the lookup is made available in the &$host_data$& variable. This
12322 allows you, for example, to do things like this:
12323 .code
12324 deny  hosts = net-lsearch;/some/file
12325 message = $host_data
12326 .endd
12327 .vitem &$host_lookup_deferred$&
12328 .cindex "host name" "lookup, failure of"
12329 .vindex "&$host_lookup_deferred$&"
12330 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12331 message comes from a remote host and there is an attempt to look up the host's
12332 name from its IP address, and the attempt is not successful, one of these
12333 variables is set to &"1"&.
12334
12335 .ilist
12336 If the lookup receives a definite negative response (for example, a DNS lookup
12337 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12338
12339 .next
12340 If there is any kind of problem during the lookup, such that Exim cannot
12341 tell whether or not the host name is defined (for example, a timeout for a DNS
12342 lookup), &$host_lookup_deferred$& is set to &"1"&.
12343 .endlist ilist
12344
12345 Looking up a host's name from its IP address consists of more than just a
12346 single reverse lookup. Exim checks that a forward lookup of at least one of the
12347 names it receives from a reverse lookup yields the original IP address. If this
12348 is not the case, Exim does not accept the looked up name(s), and
12349 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12350 IP address (for example, the existence of a PTR record in the DNS) is not
12351 sufficient on its own for the success of a host name lookup. If the reverse
12352 lookup succeeds, but there is a lookup problem such as a timeout when checking
12353 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12354 &"1"&. See also &$sender_host_name$&.
12355
12356 .cindex authentication "expansion item"
12357 Performing these checks sets up information used by the
12358 &%authresults%& expansion item.
12359
12360
12361 .vitem &$host_lookup_failed$&
12362 .vindex "&$host_lookup_failed$&"
12363 See &$host_lookup_deferred$&.
12364
12365 .vitem &$host_port$&
12366 .vindex "&$host_port$&"
12367 This variable is set to the remote host's TCP port whenever &$host$& is set
12368 for an outbound connection.
12369
12370 .vitem &$initial_cwd$&
12371 .vindex "&$initial_cwd$&
12372 This variable contains the full path name of the initial working
12373 directory of the current Exim process. This may differ from the current
12374 working directory, as Exim changes this to "/" during early startup, and
12375 to &$spool_directory$& later.
12376
12377 .vitem &$inode$&
12378 .vindex "&$inode$&"
12379 The only time this variable is set is while expanding the &%directory_file%&
12380 option in the &(appendfile)& transport. The variable contains the inode number
12381 of the temporary file which is about to be renamed. It can be used to construct
12382 a unique name for the file.
12383
12384 .vitem &$interface_address$&
12385 .vindex "&$interface_address$&"
12386 This is an obsolete name for &$received_ip_address$&.
12387
12388 .vitem &$interface_port$&
12389 .vindex "&$interface_port$&"
12390 This is an obsolete name for &$received_port$&.
12391
12392 .vitem &$item$&
12393 .vindex "&$item$&"
12394 This variable is used during the expansion of &*forall*& and &*forany*&
12395 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12396 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12397 empty.
12398
12399 .vitem &$ldap_dn$&
12400 .vindex "&$ldap_dn$&"
12401 This variable, which is available only when Exim is compiled with LDAP support,
12402 contains the DN from the last entry in the most recently successful LDAP
12403 lookup.
12404
12405 .vitem &$load_average$&
12406 .vindex "&$load_average$&"
12407 This variable contains the system load average, multiplied by 1000 so that it
12408 is an integer. For example, if the load average is 0.21, the value of the
12409 variable is 210. The value is recomputed every time the variable is referenced.
12410
12411 .vitem &$local_part$&
12412 .vindex "&$local_part$&"
12413 When an address is being routed, or delivered on its own, this
12414 variable contains the local part. When a number of addresses are being
12415 delivered together (for example, multiple RCPT commands in an SMTP
12416 session), &$local_part$& is not set.
12417
12418 Global address rewriting happens when a message is received, so the value of
12419 &$local_part$& during routing and delivery is the value after rewriting.
12420 &$local_part$& is set during user filtering, but not during system filtering,
12421 because a message may have many recipients and the system filter is called just
12422 once.
12423
12424 .new
12425 .cindex "tainted data"
12426 If the origin of the data is an incoming message,
12427 the result of expanding this variable is tainted.
12428
12429 &*Warning*&: the content of this variable is usually provided by a potential
12430 attacker.
12431 Consider carefully the implications of using it unvalidated as a name
12432 for file access.
12433 This presents issues for users' &_.forward_& and filter files.
12434 For traditional full user accounts, use &%check_local_users%& and the
12435 &$local_part_verified$& variable rather than this one.
12436 For virtual users, store a suitable pathname component in the database
12437 which is used for account name validation, and use that retrieved value
12438 rather than this variable.
12439 If needed, use a router &%address_data%& or &%set%& option for
12440 the retrieved data.
12441 .wen
12442
12443 .vindex "&$local_part_prefix$&"
12444 .vindex "&$local_part_suffix$&"
12445 .cindex affix variables
12446 If a local part prefix or suffix has been recognized, it is not included in the
12447 value of &$local_part$& during routing and subsequent delivery. The values of
12448 any prefix or suffix are in &$local_part_prefix$& and
12449 &$local_part_suffix$&, respectively.
12450
12451 When a message is being delivered to a file, pipe, or autoreply transport as a
12452 result of aliasing or forwarding, &$local_part$& is set to the local part of
12453 the parent address, not to the filename or command (see &$address_file$& and
12454 &$address_pipe$&).
12455
12456 When an ACL is running for a RCPT command, &$local_part$& contains the
12457 local part of the recipient address.
12458
12459 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12460 &$local_part$& contains the local part of the address that is being rewritten;
12461 it can be used in the expansion of the replacement address, for example.
12462
12463 In all cases, all quoting is removed from the local part. For example, for both
12464 the addresses
12465 .code
12466 "abc:xyz"@test.example
12467 abc\:xyz@test.example
12468 .endd
12469 the value of &$local_part$& is
12470 .code
12471 abc:xyz
12472 .endd
12473 If you use &$local_part$& to create another address, you should always wrap it
12474 inside a quoting operator. For example, in a &(redirect)& router you could
12475 have:
12476 .code
12477 data = ${quote_local_part:$local_part}@new.domain.example
12478 .endd
12479 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12480 to process local parts in a case-dependent manner in a router, you can set the
12481 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12482
12483 .vitem &$local_part_data$&
12484 .vindex "&$local_part_data$&"
12485 When the &%local_parts%& option on a router matches a local part by means of a
12486 lookup, the data read by the lookup is available during the running of the
12487 router as &$local_part_data$&. In addition, if the driver routes the address
12488 to a transport, the value is available in that transport. If the transport is
12489 handling multiple addresses, the value from the first address is used.
12490
12491 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12492 matches a local part by means of a lookup. The data read by the lookup is
12493 available during the rest of the ACL statement. In all other situations, this
12494 variable expands to nothing.
12495
12496 .vitem &$local_part_prefix$&
12497 .vindex "&$local_part_prefix$&"
12498 .cindex affix variables
12499 When an address is being routed or delivered, and a
12500 specific prefix for the local part was recognized, it is available in this
12501 variable, having been removed from &$local_part$&.
12502
12503 .vitem &$local_part_suffix$&
12504 .vindex "&$local_part_suffix$&"
12505 When an address is being routed or delivered, and a
12506 specific suffix for the local part was recognized, it is available in this
12507 variable, having been removed from &$local_part$&.
12508
12509 .new
12510 .vitem &$local_part_verified$&
12511 .vindex "&$local_part_verified$&"
12512 If the router generic option &%check_local_part%& has run successfully,
12513 this variable has the user database version of &$local_part$&.
12514 Such values are not tainted and hence usable for building file names.
12515 .wen
12516
12517 .vitem &$local_scan_data$&
12518 .vindex "&$local_scan_data$&"
12519 This variable contains the text returned by the &[local_scan()]& function when
12520 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12521
12522 .vitem &$local_user_gid$&
12523 .vindex "&$local_user_gid$&"
12524 See &$local_user_uid$&.
12525
12526 .vitem &$local_user_uid$&
12527 .vindex "&$local_user_uid$&"
12528 This variable and &$local_user_gid$& are set to the uid and gid after the
12529 &%check_local_user%& router precondition succeeds. This means that their values
12530 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12531 and &%condition%&), for the &%address_data%& expansion, and for any
12532 router-specific expansions. At all other times, the values in these variables
12533 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12534
12535 .vitem &$localhost_number$&
12536 .vindex "&$localhost_number$&"
12537 This contains the expanded value of the
12538 &%localhost_number%& option. The expansion happens after the main options have
12539 been read.
12540
12541 .vitem &$log_inodes$&
12542 .vindex "&$log_inodes$&"
12543 The number of free inodes in the disk partition where Exim's
12544 log files are being written. The value is recalculated whenever the variable is
12545 referenced. If the relevant file system does not have the concept of inodes,
12546 the value of is -1. See also the &%check_log_inodes%& option.
12547
12548 .vitem &$log_space$&
12549 .vindex "&$log_space$&"
12550 The amount of free space (as a number of kilobytes) in the disk
12551 partition where Exim's log files are being written. The value is recalculated
12552 whenever the variable is referenced. If the operating system does not have the
12553 ability to find the amount of free space (only true for experimental systems),
12554 the space value is -1. See also the &%check_log_space%& option.
12555
12556
12557 .vitem &$lookup_dnssec_authenticated$&
12558 .vindex "&$lookup_dnssec_authenticated$&"
12559 This variable is set after a DNS lookup done by
12560 a dnsdb lookup expansion, dnslookup router or smtp transport.
12561 .cindex "DNS" "DNSSEC"
12562 It will be empty if &(DNSSEC)& was not requested,
12563 &"no"& if the result was not labelled as authenticated data
12564 and &"yes"& if it was.
12565 Results that are labelled as authoritative answer that match
12566 the &%dns_trust_aa%& configuration variable count also
12567 as authenticated data.
12568
12569 .vitem &$mailstore_basename$&
12570 .vindex "&$mailstore_basename$&"
12571 This variable is set only when doing deliveries in &"mailstore"& format in the
12572 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12573 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12574 contains the basename of the files that are being written, that is, the name
12575 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12576 variable is empty.
12577
12578 .vitem &$malware_name$&
12579 .vindex "&$malware_name$&"
12580 This variable is available when Exim is compiled with the
12581 content-scanning extension. It is set to the name of the virus that was found
12582 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12583
12584 .vitem &$max_received_linelength$&
12585 .vindex "&$max_received_linelength$&"
12586 .cindex "maximum" "line length"
12587 .cindex "line length" "maximum"
12588 This variable contains the number of bytes in the longest line that was
12589 received as part of the message, not counting the line termination
12590 character(s).
12591 It is not valid if the &%spool_files_wireformat%& option is used.
12592
12593 .vitem &$message_age$&
12594 .cindex "message" "age of"
12595 .vindex "&$message_age$&"
12596 This variable is set at the start of a delivery attempt to contain the number
12597 of seconds since the message was received. It does not change during a single
12598 delivery attempt.
12599
12600 .vitem &$message_body$&
12601 .cindex "body of message" "expansion variable"
12602 .cindex "message body" "in expansion"
12603 .cindex "binary zero" "in message body"
12604 .vindex "&$message_body$&"
12605 .oindex "&%message_body_visible%&"
12606 This variable contains the initial portion of a message's body while it is
12607 being delivered, and is intended mainly for use in filter files. The maximum
12608 number of characters of the body that are put into the variable is set by the
12609 &%message_body_visible%& configuration option; the default is 500.
12610
12611 .oindex "&%message_body_newlines%&"
12612 By default, newlines are converted into spaces in &$message_body$&, to make it
12613 easier to search for phrases that might be split over a line break. However,
12614 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12615 zeros are always converted into spaces.
12616
12617 .vitem &$message_body_end$&
12618 .cindex "body of message" "expansion variable"
12619 .cindex "message body" "in expansion"
12620 .vindex "&$message_body_end$&"
12621 This variable contains the final portion of a message's
12622 body while it is being delivered. The format and maximum size are as for
12623 &$message_body$&.
12624
12625 .vitem &$message_body_size$&
12626 .cindex "body of message" "size"
12627 .cindex "message body" "size"
12628 .vindex "&$message_body_size$&"
12629 When a message is being delivered, this variable contains the size of the body
12630 in bytes. The count starts from the character after the blank line that
12631 separates the body from the header. Newlines are included in the count. See
12632 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12633
12634 If the spool file is wireformat
12635 (see the &%spool_files_wireformat%& main option)
12636 the CRLF line-terminators are included in the count.
12637
12638 .vitem &$message_exim_id$&
12639 .vindex "&$message_exim_id$&"
12640 When a message is being received or delivered, this variable contains the
12641 unique message id that is generated and used by Exim to identify the message.
12642 An id is not created for a message until after its header has been successfully
12643 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12644 line; it is the local id that Exim assigns to the message, for example:
12645 &`1BXTIK-0001yO-VA`&.
12646
12647 .vitem &$message_headers$&
12648 .vindex &$message_headers$&
12649 This variable contains a concatenation of all the header lines when a message
12650 is being processed, except for lines added by routers or transports. The header
12651 lines are separated by newline characters. Their contents are decoded in the
12652 same way as a header line that is inserted by &%bheader%&.
12653
12654 .vitem &$message_headers_raw$&
12655 .vindex &$message_headers_raw$&
12656 This variable is like &$message_headers$& except that no processing of the
12657 contents of header lines is done.
12658
12659 .vitem &$message_id$&
12660 This is an old name for &$message_exim_id$&. It is now deprecated.
12661
12662 .vitem &$message_linecount$&
12663 .vindex "&$message_linecount$&"
12664 This variable contains the total number of lines in the header and body of the
12665 message. Compare &$body_linecount$&, which is the count for the body only.
12666 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12667 number of lines received. Before delivery happens (that is, before filters,
12668 routers, and transports run) the count is increased to include the
12669 &'Received:'& header line that Exim standardly adds, and also any other header
12670 lines that are added by ACLs. The blank line that separates the message header
12671 from the body is not counted.
12672
12673 As with the special case of &$message_size$&, during the expansion of the
12674 appendfile transport's maildir_tag option in maildir format, the value of
12675 &$message_linecount$& is the precise size of the number of newlines in the
12676 file that has been written (minus one for the blank line between the
12677 header and the body).
12678
12679 Here is an example of the use of this variable in a DATA ACL:
12680 .code
12681 deny message   = Too many lines in message header
12682      condition = \
12683       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12684 .endd
12685 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12686 message has not yet been received.
12687
12688 This variable is not valid if the &%spool_files_wireformat%& option is used.
12689
12690 .vitem &$message_size$&
12691 .cindex "size" "of message"
12692 .cindex "message" "size"
12693 .vindex "&$message_size$&"
12694 When a message is being processed, this variable contains its size in bytes. In
12695 most cases, the size includes those headers that were received with the
12696 message, but not those (such as &'Envelope-to:'&) that are added to individual
12697 deliveries as they are written. However, there is one special case: during the
12698 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12699 doing a delivery in maildir format, the value of &$message_size$& is the
12700 precise size of the file that has been written. See also
12701 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12702
12703 .cindex "RCPT" "value of &$message_size$&"
12704 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12705 contains the size supplied on the MAIL command, or -1 if no size was given. The
12706 value may not, of course, be truthful.
12707
12708 .vitem &$mime_$&&'xxx'&
12709 A number of variables whose names start with &$mime$& are
12710 available when Exim is compiled with the content-scanning extension. For
12711 details, see section &<<SECTscanmimepart>>&.
12712
12713 .vitem "&$n0$& &-- &$n9$&"
12714 These variables are counters that can be incremented by means
12715 of the &%add%& command in filter files.
12716
12717 .vitem &$original_domain$&
12718 .vindex "&$domain$&"
12719 .vindex "&$original_domain$&"
12720 When a top-level address is being processed for delivery, this contains the
12721 same value as &$domain$&. However, if a &"child"& address (for example,
12722 generated by an alias, forward, or filter file) is being processed, this
12723 variable contains the domain of the original address (lower cased). This
12724 differs from &$parent_domain$& only when there is more than one level of
12725 aliasing or forwarding. When more than one address is being delivered in a
12726 single transport run, &$original_domain$& is not set.
12727
12728 If a new address is created by means of a &%deliver%& command in a system
12729 filter, it is set up with an artificial &"parent"& address. This has the local
12730 part &'system-filter'& and the default qualify domain.
12731
12732 .vitem &$original_local_part$&
12733 .vindex "&$local_part$&"
12734 .vindex "&$original_local_part$&"
12735 When a top-level address is being processed for delivery, this contains the
12736 same value as &$local_part$&, unless a prefix or suffix was removed from the
12737 local part, because &$original_local_part$& always contains the full local
12738 part. When a &"child"& address (for example, generated by an alias, forward, or
12739 filter file) is being processed, this variable contains the full local part of
12740 the original address.
12741
12742 If the router that did the redirection processed the local part
12743 case-insensitively, the value in &$original_local_part$& is in lower case.
12744 This variable differs from &$parent_local_part$& only when there is more than
12745 one level of aliasing or forwarding. When more than one address is being
12746 delivered in a single transport run, &$original_local_part$& is not set.
12747
12748 If a new address is created by means of a &%deliver%& command in a system
12749 filter, it is set up with an artificial &"parent"& address. This has the local
12750 part &'system-filter'& and the default qualify domain.
12751
12752 .vitem &$originator_gid$&
12753 .cindex "gid (group id)" "of originating user"
12754 .cindex "sender" "gid"
12755 .vindex "&$caller_gid$&"
12756 .vindex "&$originator_gid$&"
12757 This variable contains the value of &$caller_gid$& that was set when the
12758 message was received. For messages received via the command line, this is the
12759 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12760 normally the gid of the Exim user.
12761
12762 .vitem &$originator_uid$&
12763 .cindex "uid (user id)" "of originating user"
12764 .cindex "sender" "uid"
12765 .vindex "&$caller_uid$&"
12766 .vindex "&$originator_uid$&"
12767 The value of &$caller_uid$& that was set when the message was received. For
12768 messages received via the command line, this is the uid of the sending user.
12769 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12770 user.
12771
12772 .vitem &$parent_domain$&
12773 .vindex "&$parent_domain$&"
12774 This variable is similar to &$original_domain$& (see
12775 above), except that it refers to the immediately preceding parent address.
12776
12777 .vitem &$parent_local_part$&
12778 .vindex "&$parent_local_part$&"
12779 This variable is similar to &$original_local_part$&
12780 (see above), except that it refers to the immediately preceding parent address.
12781
12782 .vitem &$pid$&
12783 .cindex "pid (process id)" "of current process"
12784 .vindex "&$pid$&"
12785 This variable contains the current process id.
12786
12787 .vitem &$pipe_addresses$&
12788 .cindex "filter" "transport filter"
12789 .cindex "transport" "filter"
12790 .vindex "&$pipe_addresses$&"
12791 This is not an expansion variable, but is mentioned here because the string
12792 &`$pipe_addresses`& is handled specially in the command specification for the
12793 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12794 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12795 It cannot be used in general expansion strings, and provokes an &"unknown
12796 variable"& error if encountered.
12797
12798 .vitem &$primary_hostname$&
12799 .vindex "&$primary_hostname$&"
12800 This variable contains the value set by &%primary_hostname%& in the
12801 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12802 a single-component name, Exim calls &[gethostbyname()]& (or
12803 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12804 qualified host name. See also &$smtp_active_hostname$&.
12805
12806
12807 .vitem &$proxy_external_address$& &&&
12808        &$proxy_external_port$& &&&
12809        &$proxy_local_address$& &&&
12810        &$proxy_local_port$& &&&
12811        &$proxy_session$&
12812 These variables are only available when built with Proxy Protocol
12813 or SOCKS5 support.
12814 For details see chapter &<<SECTproxyInbound>>&.
12815
12816 .vitem &$prdr_requested$&
12817 .cindex "PRDR" "variable for"
12818 This variable is set to &"yes"& if PRDR was requested by the client for the
12819 current message, otherwise &"no"&.
12820
12821 .vitem &$prvscheck_address$&
12822 This variable is used in conjunction with the &%prvscheck%& expansion item,
12823 which is described in sections &<<SECTexpansionitems>>& and
12824 &<<SECTverifyPRVS>>&.
12825
12826 .vitem &$prvscheck_keynum$&
12827 This variable is used in conjunction with the &%prvscheck%& expansion item,
12828 which is described in sections &<<SECTexpansionitems>>& and
12829 &<<SECTverifyPRVS>>&.
12830
12831 .vitem &$prvscheck_result$&
12832 This variable is used in conjunction with the &%prvscheck%& expansion item,
12833 which is described in sections &<<SECTexpansionitems>>& and
12834 &<<SECTverifyPRVS>>&.
12835
12836 .vitem &$qualify_domain$&
12837 .vindex "&$qualify_domain$&"
12838 The value set for the &%qualify_domain%& option in the configuration file.
12839
12840 .vitem &$qualify_recipient$&
12841 .vindex "&$qualify_recipient$&"
12842 The value set for the &%qualify_recipient%& option in the configuration file,
12843 or if not set, the value of &$qualify_domain$&.
12844
12845 .vitem &$queue_name$&
12846 .vindex &$queue_name$&
12847 .cindex "named queues"
12848 .cindex queues named
12849 The name of the spool queue in use; empty for the default queue.
12850
12851 .vitem &$r_...$&
12852 .vindex &$r_...$&
12853 .cindex router variables
12854 Values can be placed in these variables by the &%set%& option of a router.
12855 They can be given any name that starts with &$r_$&.
12856 The values persist for the address being handled through subsequent routers
12857 and the eventual transport.
12858
12859 .vitem &$rcpt_count$&
12860 .vindex "&$rcpt_count$&"
12861 When a message is being received by SMTP, this variable contains the number of
12862 RCPT commands received for the current message. If this variable is used in a
12863 RCPT ACL, its value includes the current command.
12864
12865 .vitem &$rcpt_defer_count$&
12866 .vindex "&$rcpt_defer_count$&"
12867 .cindex "4&'xx'& responses" "count of"
12868 When a message is being received by SMTP, this variable contains the number of
12869 RCPT commands in the current message that have previously been rejected with a
12870 temporary (4&'xx'&) response.
12871
12872 .vitem &$rcpt_fail_count$&
12873 .vindex "&$rcpt_fail_count$&"
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 permanent (5&'xx'&) response.
12877
12878 .vitem &$received_count$&
12879 .vindex "&$received_count$&"
12880 This variable contains the number of &'Received:'& header lines in the message,
12881 including the one added by Exim (so its value is always greater than zero). It
12882 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12883 delivering.
12884
12885 .vitem &$received_for$&
12886 .vindex "&$received_for$&"
12887 If there is only a single recipient address in an incoming message, this
12888 variable contains that address when the &'Received:'& header line is being
12889 built. The value is copied after recipient rewriting has happened, but before
12890 the &[local_scan()]& function is run.
12891
12892 .vitem &$received_ip_address$&
12893 .vindex "&$received_ip_address$&"
12894 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12895 variable is set to the address of the local IP interface, and &$received_port$&
12896 is set to the local port number. (The remote IP address and port are in
12897 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12898 the port value is -1 unless it has been set using the &%-oMi%& command line
12899 option.
12900
12901 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12902 could be used, for example, to make the filename for a TLS certificate depend
12903 on which interface and/or port is being used for the incoming connection. The
12904 values of &$received_ip_address$& and &$received_port$& are saved with any
12905 messages that are received, thus making these variables available at delivery
12906 time.
12907 For outbound connections see &$sending_ip_address$&.
12908
12909 .vitem &$received_port$&
12910 .vindex "&$received_port$&"
12911 See &$received_ip_address$&.
12912
12913 .vitem &$received_protocol$&
12914 .vindex "&$received_protocol$&"
12915 When a message is being processed, this variable contains the name of the
12916 protocol by which it was received. Most of the names used by Exim are defined
12917 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12918 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12919 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12920 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12921 connection and the client was successfully authenticated.
12922
12923 Exim uses the protocol name &"smtps"& for the case when encryption is
12924 automatically set up on connection without the use of STARTTLS (see
12925 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12926 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12927 where the client initially uses EHLO, sets up an encrypted connection using
12928 STARTTLS, and then uses HELO afterwards.
12929
12930 The &%-oMr%& option provides a way of specifying a custom protocol name for
12931 messages that are injected locally by trusted callers. This is commonly used to
12932 identify messages that are being re-injected after some kind of scanning.
12933
12934 .vitem &$received_time$&
12935 .vindex "&$received_time$&"
12936 This variable contains the date and time when the current message was received,
12937 as a number of seconds since the start of the Unix epoch.
12938
12939 .vitem &$recipient_data$&
12940 .vindex "&$recipient_data$&"
12941 This variable is set after an indexing lookup success in an ACL &%recipients%&
12942 condition. It contains the data from the lookup, and the value remains set
12943 until the next &%recipients%& test. Thus, you can do things like this:
12944 .display
12945 &`require recipients  = cdb*@;/some/file`&
12946 &`deny    `&&'some further test involving'& &`$recipient_data`&
12947 .endd
12948 &*Warning*&: This variable is set only when a lookup is used as an indexing
12949 method in the address list, using the semicolon syntax as in the example above.
12950 The variable is not set for a lookup that is used as part of the string
12951 expansion that all such lists undergo before being interpreted.
12952
12953 .vitem &$recipient_verify_failure$&
12954 .vindex "&$recipient_verify_failure$&"
12955 In an ACL, when a recipient verification fails, this variable contains
12956 information about the failure. It is set to one of the following words:
12957
12958 .ilist
12959 &"qualify"&: The address was unqualified (no domain), and the message
12960 was neither local nor came from an exempted host.
12961
12962 .next
12963 &"route"&: Routing failed.
12964
12965 .next
12966 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12967 or before the MAIL command (that is, on initial connection, HELO, or
12968 MAIL).
12969
12970 .next
12971 &"recipient"&: The RCPT command in a callout was rejected.
12972 .next
12973
12974 &"postmaster"&: The postmaster check in a callout was rejected.
12975 .endlist
12976
12977 The main use of this variable is expected to be to distinguish between
12978 rejections of MAIL and rejections of RCPT.
12979
12980 .vitem &$recipients$&
12981 .vindex "&$recipients$&"
12982 This variable contains a list of envelope recipients for a message. A comma and
12983 a space separate the addresses in the replacement text. However, the variable
12984 is not generally available, to prevent exposure of Bcc recipients in
12985 unprivileged users' filter files. You can use &$recipients$& only in these
12986 cases:
12987
12988 .olist
12989 In a system filter file.
12990 .next
12991 In the ACLs associated with the DATA command and with non-SMTP messages, that
12992 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12993 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12994 &%acl_not_smtp_mime%&.
12995 .next
12996 From within a &[local_scan()]& function.
12997 .endlist
12998
12999
13000 .vitem &$recipients_count$&
13001 .vindex "&$recipients_count$&"
13002 When a message is being processed, this variable contains the number of
13003 envelope recipients that came with the message. Duplicates are not excluded
13004 from the count. While a message is being received over SMTP, the number
13005 increases for each accepted recipient. It can be referenced in an ACL.
13006
13007
13008 .vitem &$regex_match_string$&
13009 .vindex "&$regex_match_string$&"
13010 This variable is set to contain the matching regular expression after a
13011 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13012
13013 .vitem "&$regex1$&, &$regex2$&, etc"
13014 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13015 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13016 these variables contain the
13017 captured substrings identified by the regular expression.
13018
13019
13020 .vitem &$reply_address$&
13021 .vindex "&$reply_address$&"
13022 When a message is being processed, this variable contains the contents of the
13023 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13024 contents of the &'From:'& header line. Apart from the removal of leading
13025 white space, the value is not processed in any way. In particular, no RFC 2047
13026 decoding or character code translation takes place.
13027
13028 .vitem &$return_path$&
13029 .vindex "&$return_path$&"
13030 When a message is being delivered, this variable contains the return path &--
13031 the sender field that will be sent as part of the envelope. It is not enclosed
13032 in <> characters. At the start of routing an address, &$return_path$& has the
13033 same value as &$sender_address$&, but if, for example, an incoming message to a
13034 mailing list has been expanded by a router which specifies a different address
13035 for bounce messages, &$return_path$& subsequently contains the new bounce
13036 address, whereas &$sender_address$& always contains the original sender address
13037 that was received with the message. In other words, &$sender_address$& contains
13038 the incoming envelope sender, and &$return_path$& contains the outgoing
13039 envelope sender.
13040
13041 .vitem &$return_size_limit$&
13042 .vindex "&$return_size_limit$&"
13043 This is an obsolete name for &$bounce_return_size_limit$&.
13044
13045 .vitem &$router_name$&
13046 .cindex "router" "name"
13047 .cindex "name" "of router"
13048 .vindex "&$router_name$&"
13049 During the running of a router this variable contains its name.
13050
13051 .vitem &$runrc$&
13052 .cindex "return code" "from &%run%& expansion"
13053 .vindex "&$runrc$&"
13054 This variable contains the return code from a command that is run by the
13055 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13056 assume the order in which option values are expanded, except for those
13057 preconditions whose order of testing is documented. Therefore, you cannot
13058 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13059 another.
13060
13061 .vitem &$self_hostname$&
13062 .oindex "&%self%&" "value of host name"
13063 .vindex "&$self_hostname$&"
13064 When an address is routed to a supposedly remote host that turns out to be the
13065 local host, what happens is controlled by the &%self%& generic router option.
13066 One of its values causes the address to be passed to another router. When this
13067 happens, &$self_hostname$& is set to the name of the local host that the
13068 original router encountered. In other circumstances its contents are null.
13069
13070 .vitem &$sender_address$&
13071 .vindex "&$sender_address$&"
13072 When a message is being processed, this variable contains the sender's address
13073 that was received in the message's envelope. The case of letters in the address
13074 is retained, in both the local part and the domain. For bounce messages, the
13075 value of this variable is the empty string. See also &$return_path$&.
13076
13077 .vitem &$sender_address_data$&
13078 .vindex "&$address_data$&"
13079 .vindex "&$sender_address_data$&"
13080 If &$address_data$& is set when the routers are called from an ACL to verify a
13081 sender address, the final value is preserved in &$sender_address_data$&, to
13082 distinguish it from data from a recipient address. The value does not persist
13083 after the end of the current ACL statement. If you want to preserve it for
13084 longer, you can save it in an ACL variable.
13085
13086 .vitem &$sender_address_domain$&
13087 .vindex "&$sender_address_domain$&"
13088 The domain portion of &$sender_address$&.
13089
13090 .vitem &$sender_address_local_part$&
13091 .vindex "&$sender_address_local_part$&"
13092 The local part portion of &$sender_address$&.
13093
13094 .vitem &$sender_data$&
13095 .vindex "&$sender_data$&"
13096 This variable is set after a lookup success in an ACL &%senders%& condition or
13097 in a router &%senders%& option. It contains the data from the lookup, and the
13098 value remains set until the next &%senders%& test. Thus, you can do things like
13099 this:
13100 .display
13101 &`require senders      = cdb*@;/some/file`&
13102 &`deny    `&&'some further test involving'& &`$sender_data`&
13103 .endd
13104 &*Warning*&: This variable is set only when a lookup is used as an indexing
13105 method in the address list, using the semicolon syntax as in the example above.
13106 The variable is not set for a lookup that is used as part of the string
13107 expansion that all such lists undergo before being interpreted.
13108
13109 .vitem &$sender_fullhost$&
13110 .vindex "&$sender_fullhost$&"
13111 When a message is received from a remote host, this variable contains the host
13112 name and IP address in a single string. It ends with the IP address in square
13113 brackets, followed by a colon and a port number if the logging of ports is
13114 enabled. The format of the rest of the string depends on whether the host
13115 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13116 looking up its IP address. (Looking up the IP address can be forced by the
13117 &%host_lookup%& option, independent of verification.) A plain host name at the
13118 start of the string is a verified host name; if this is not present,
13119 verification either failed or was not requested. A host name in parentheses is
13120 the argument of a HELO or EHLO command. This is omitted if it is identical to
13121 the verified host name or to the host's IP address in square brackets.
13122
13123 .vitem &$sender_helo_dnssec$&
13124 .vindex "&$sender_helo_dnssec$&"
13125 This boolean variable is true if a successful HELO verification was
13126 .cindex "DNS" "DNSSEC"
13127 done using DNS information the resolver library stated was authenticated data.
13128
13129 .vitem &$sender_helo_name$&
13130 .vindex "&$sender_helo_name$&"
13131 When a message is received from a remote host that has issued a HELO or EHLO
13132 command, the argument of that command is placed in this variable. It is also
13133 set if HELO or EHLO is used when a message is received using SMTP locally via
13134 the &%-bs%& or &%-bS%& options.
13135
13136 .vitem &$sender_host_address$&
13137 .vindex "&$sender_host_address$&"
13138 When a message is received from a remote host using SMTP,
13139 this variable contains that
13140 host's IP address. For locally non-SMTP submitted messages, it is empty.
13141
13142 .vitem &$sender_host_authenticated$&
13143 .vindex "&$sender_host_authenticated$&"
13144 This variable contains the name (not the public name) of the authenticator
13145 driver that successfully authenticated the client from which the message was
13146 received. It is empty if there was no successful authentication. See also
13147 &$authenticated_id$&.
13148
13149 .vitem &$sender_host_dnssec$&
13150 .vindex "&$sender_host_dnssec$&"
13151 If an attempt to populate &$sender_host_name$& has been made
13152 (by reference, &%hosts_lookup%& or
13153 otherwise) then this boolean will have been set true if, and only if, the
13154 resolver library states that both
13155 the reverse and forward DNS were authenticated data.  At all
13156 other times, this variable is false.
13157
13158 .cindex "DNS" "DNSSEC"
13159 It is likely that you will need to coerce DNSSEC support on in the resolver
13160 library, by setting:
13161 .code
13162 dns_dnssec_ok = 1
13163 .endd
13164
13165 Exim does not perform DNSSEC validation itself, instead leaving that to a
13166 validating resolver (e.g. unbound, or bind with suitable configuration).
13167
13168 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13169 mechanism in the list, then this variable will be false.
13170
13171 This requires that your system resolver library support EDNS0 (and that
13172 DNSSEC flags exist in the system headers).  If the resolver silently drops
13173 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13174 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13175
13176
13177 .vitem &$sender_host_name$&
13178 .vindex "&$sender_host_name$&"
13179 When a message is received from a remote host, this variable contains the
13180 host's name as obtained by looking up its IP address. For messages received by
13181 other means, this variable is empty.
13182
13183 .vindex "&$host_lookup_failed$&"
13184 If the host name has not previously been looked up, a reference to
13185 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13186 A looked up name is accepted only if it leads back to the original IP address
13187 via a forward lookup. If either the reverse or the forward lookup fails to find
13188 any data, or if the forward lookup does not yield the original IP address,
13189 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13190
13191 .vindex "&$host_lookup_deferred$&"
13192 However, if either of the lookups cannot be completed (for example, there is a
13193 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13194 &$host_lookup_failed$& remains set to &"0"&.
13195
13196 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13197 host name again if there is a subsequent reference to &$sender_host_name$&
13198 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13199 is set to &"1"&.
13200
13201 Exim does not automatically look up every calling host's name. If you want
13202 maximum efficiency, you should arrange your configuration so that it avoids
13203 these lookups altogether. The lookup happens only if one or more of the
13204 following are true:
13205
13206 .ilist
13207 A string containing &$sender_host_name$& is expanded.
13208 .next
13209 The calling host matches the list in &%host_lookup%&. In the default
13210 configuration, this option is set to *, so it must be changed if lookups are
13211 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13212 .next
13213 Exim needs the host name in order to test an item in a host list. The items
13214 that require this are described in sections &<<SECThoslispatnam>>& and
13215 &<<SECThoslispatnamsk>>&.
13216 .next
13217 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13218 In this case, the host name is required to compare with the name quoted in any
13219 EHLO or HELO commands that the client issues.
13220 .next
13221 The remote host issues a EHLO or HELO command that quotes one of the
13222 domains in &%helo_lookup_domains%&. The default value of this option is
13223 . ==== As this is a nested list, any displays it contains must be indented
13224 . ==== as otherwise they are too far to the left.
13225 .code
13226   helo_lookup_domains = @ : @[]
13227 .endd
13228 which causes a lookup if a remote host (incorrectly) gives the server's name or
13229 IP address in an EHLO or HELO command.
13230 .endlist
13231
13232
13233 .vitem &$sender_host_port$&
13234 .vindex "&$sender_host_port$&"
13235 When a message is received from a remote host, this variable contains the port
13236 number that was used on the remote host.
13237
13238 .vitem &$sender_ident$&
13239 .vindex "&$sender_ident$&"
13240 When a message is received from a remote host, this variable contains the
13241 identification received in response to an RFC 1413 request. When a message has
13242 been received locally, this variable contains the login name of the user that
13243 called Exim.
13244
13245 .vitem &$sender_rate_$&&'xxx'&
13246 A number of variables whose names begin &$sender_rate_$& are set as part of the
13247 &%ratelimit%& ACL condition. Details are given in section
13248 &<<SECTratelimiting>>&.
13249
13250 .vitem &$sender_rcvhost$&
13251 .cindex "DNS" "reverse lookup"
13252 .cindex "reverse DNS lookup"
13253 .vindex "&$sender_rcvhost$&"
13254 This is provided specifically for use in &'Received:'& headers. It starts with
13255 either the verified host name (as obtained from a reverse DNS lookup) or, if
13256 there is no verified host name, the IP address in square brackets. After that
13257 there may be text in parentheses. When the first item is a verified host name,
13258 the first thing in the parentheses is the IP address in square brackets,
13259 followed by a colon and a port number if port logging is enabled. When the
13260 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13261 the parentheses.
13262
13263 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13264 was used and its argument was not identical to the real host name or IP
13265 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13266 all three items are present in the parentheses, a newline and tab are inserted
13267 into the string, to improve the formatting of the &'Received:'& header.
13268
13269 .vitem &$sender_verify_failure$&
13270 .vindex "&$sender_verify_failure$&"
13271 In an ACL, when a sender verification fails, this variable contains information
13272 about the failure. The details are the same as for
13273 &$recipient_verify_failure$&.
13274
13275 .vitem &$sending_ip_address$&
13276 .vindex "&$sending_ip_address$&"
13277 This variable is set whenever an outgoing SMTP connection to another host has
13278 been set up. It contains the IP address of the local interface that is being
13279 used. This is useful if a host that has more than one IP address wants to take
13280 on different personalities depending on which one is being used. For incoming
13281 connections, see &$received_ip_address$&.
13282
13283 .vitem &$sending_port$&
13284 .vindex "&$sending_port$&"
13285 This variable is set whenever an outgoing SMTP connection to another host has
13286 been set up. It contains the local port that is being used. For incoming
13287 connections, see &$received_port$&.
13288
13289 .vitem &$smtp_active_hostname$&
13290 .vindex "&$smtp_active_hostname$&"
13291 During an incoming SMTP session, this variable contains the value of the active
13292 host name, as specified by the &%smtp_active_hostname%& option. The value of
13293 &$smtp_active_hostname$& is saved with any message that is received, so its
13294 value can be consulted during routing and delivery.
13295
13296 .vitem &$smtp_command$&
13297 .vindex "&$smtp_command$&"
13298 During the processing of an incoming SMTP command, this variable contains the
13299 entire command. This makes it possible to distinguish between HELO and EHLO in
13300 the HELO ACL, and also to distinguish between commands such as these:
13301 .code
13302 MAIL FROM:<>
13303 MAIL FROM: <>
13304 .endd
13305 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13306 command, the address in &$smtp_command$& is the original address before any
13307 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13308 the address after SMTP-time rewriting.
13309
13310 .vitem &$smtp_command_argument$&
13311 .cindex "SMTP" "command, argument for"
13312 .vindex "&$smtp_command_argument$&"
13313 While an ACL is running to check an SMTP command, this variable contains the
13314 argument, that is, the text that follows the command name, with leading white
13315 space removed. Following the introduction of &$smtp_command$&, this variable is
13316 somewhat redundant, but is retained for backwards compatibility.
13317
13318 .vitem &$smtp_command_history$&
13319 .cindex SMTP "command history"
13320 .vindex "&$smtp_command_history$&"
13321 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13322 received, in time-order left to right.  Only a limited number of commands
13323 are remembered.
13324
13325 .vitem &$smtp_count_at_connection_start$&
13326 .vindex "&$smtp_count_at_connection_start$&"
13327 This variable is set greater than zero only in processes spawned by the Exim
13328 daemon for handling incoming SMTP connections. The name is deliberately long,
13329 in order to emphasize what the contents are. When the daemon accepts a new
13330 connection, it increments this variable. A copy of the variable is passed to
13331 the child process that handles the connection, but its value is fixed, and
13332 never changes. It is only an approximation of how many incoming connections
13333 there actually are, because many other connections may come and go while a
13334 single connection is being processed. When a child process terminates, the
13335 daemon decrements its copy of the variable.
13336
13337 .vitem "&$sn0$& &-- &$sn9$&"
13338 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13339 that were current at the end of the system filter file. This allows a system
13340 filter file to set values that can be tested in users' filter files. For
13341 example, a system filter could set a value indicating how likely it is that a
13342 message is junk mail.
13343
13344 .vitem &$spam_$&&'xxx'&
13345 A number of variables whose names start with &$spam$& are available when Exim
13346 is compiled with the content-scanning extension. For details, see section
13347 &<<SECTscanspamass>>&.
13348
13349 .vitem &$spf_header_comment$& &&&
13350        &$spf_received$& &&&
13351        &$spf_result$& &&&
13352        &$spf_result_guessed$& &&&
13353        &$spf_smtp_comment$&
13354 These variables are only available if Exim is built with SPF support.
13355 For details see section &<<SECSPF>>&.
13356
13357 .vitem &$spool_directory$&
13358 .vindex "&$spool_directory$&"
13359 The name of Exim's spool directory.
13360
13361 .vitem &$spool_inodes$&
13362 .vindex "&$spool_inodes$&"
13363 The number of free inodes in the disk partition where Exim's spool files are
13364 being written. The value is recalculated whenever the variable is referenced.
13365 If the relevant file system does not have the concept of inodes, the value of
13366 is -1. See also the &%check_spool_inodes%& option.
13367
13368 .vitem &$spool_space$&
13369 .vindex "&$spool_space$&"
13370 The amount of free space (as a number of kilobytes) in the disk partition where
13371 Exim's spool files are being written. The value is recalculated whenever the
13372 variable is referenced. If the operating system does not have the ability to
13373 find the amount of free space (only true for experimental systems), the space
13374 value is -1. For example, to check in an ACL that there is at least 50
13375 megabytes free on the spool, you could write:
13376 .code
13377 condition = ${if > {$spool_space}{50000}}
13378 .endd
13379 See also the &%check_spool_space%& option.
13380
13381
13382 .vitem &$thisaddress$&
13383 .vindex "&$thisaddress$&"
13384 This variable is set only during the processing of the &%foranyaddress%&
13385 command in a filter file. Its use is explained in the description of that
13386 command, which can be found in the separate document entitled &'Exim's
13387 interfaces to mail filtering'&.
13388
13389 .vitem &$tls_in_bits$&
13390 .vindex "&$tls_in_bits$&"
13391 Contains an approximation of the TLS cipher's bit-strength
13392 on the inbound connection; the meaning of
13393 this depends upon the TLS implementation used.
13394 If TLS has not been negotiated, the value will be 0.
13395 The value of this is automatically fed into the Cyrus SASL authenticator
13396 when acting as a server, to specify the "external SSF" (a SASL term).
13397
13398 The deprecated &$tls_bits$& variable refers to the inbound side
13399 except when used in the context of an outbound SMTP delivery, when it refers to
13400 the outbound.
13401
13402 .vitem &$tls_out_bits$&
13403 .vindex "&$tls_out_bits$&"
13404 Contains an approximation of the TLS cipher's bit-strength
13405 on an outbound SMTP connection; the meaning of
13406 this depends upon the TLS implementation used.
13407 If TLS has not been negotiated, the value will be 0.
13408
13409 .vitem &$tls_in_ourcert$&
13410 .vindex "&$tls_in_ourcert$&"
13411 .cindex certificate variables
13412 This variable refers to the certificate presented to the peer of an
13413 inbound connection when the message was received.
13414 It is only useful as the argument of a
13415 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13416 or a &%def%& condition.
13417
13418 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13419 when a list of more than one
13420 file is used for &%tls_certificate%&, this variable is not reliable.
13421 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13422
13423 .vitem &$tls_in_peercert$&
13424 .vindex "&$tls_in_peercert$&"
13425 This variable refers to the certificate presented by the peer of an
13426 inbound connection when the message was received.
13427 It is only useful as the argument of a
13428 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13429 or a &%def%& condition.
13430 If certificate verification fails it may refer to a failing chain element
13431 which is not the leaf.
13432
13433 .vitem &$tls_out_ourcert$&
13434 .vindex "&$tls_out_ourcert$&"
13435 This variable refers to the certificate presented to the peer of an
13436 outbound connection.  It is only useful as the argument of a
13437 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13438 or a &%def%& condition.
13439
13440 .vitem &$tls_out_peercert$&
13441 .vindex "&$tls_out_peercert$&"
13442 This variable refers to the certificate presented by the peer of an
13443 outbound connection.  It is only useful as the argument of a
13444 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13445 or a &%def%& condition.
13446 If certificate verification fails it may refer to a failing chain element
13447 which is not the leaf.
13448
13449 .vitem &$tls_in_certificate_verified$&
13450 .vindex "&$tls_in_certificate_verified$&"
13451 This variable is set to &"1"& if a TLS certificate was verified when the
13452 message was received, and &"0"& otherwise.
13453
13454 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13455 except when used in the context of an outbound SMTP delivery, when it refers to
13456 the outbound.
13457
13458 .vitem &$tls_out_certificate_verified$&
13459 .vindex "&$tls_out_certificate_verified$&"
13460 This variable is set to &"1"& if a TLS certificate was verified when an
13461 outbound SMTP connection was made,
13462 and &"0"& otherwise.
13463
13464 .vitem &$tls_in_cipher$&
13465 .vindex "&$tls_in_cipher$&"
13466 .vindex "&$tls_cipher$&"
13467 When a message is received from a remote host over an encrypted SMTP
13468 connection, this variable is set to the cipher suite that was negotiated, for
13469 example DES-CBC3-SHA. In other circumstances, in particular, for message
13470 received over unencrypted connections, the variable is empty. Testing
13471 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13472 non-encrypted connections during ACL processing.
13473
13474 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13475 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13476 becomes the same as &$tls_out_cipher$&.
13477
13478 .vitem &$tls_in_cipher_std$&
13479 .vindex "&$tls_in_cipher_std$&"
13480 As above, but returning the RFC standard name for the cipher suite.
13481
13482 .vitem &$tls_out_cipher$&
13483 .vindex "&$tls_out_cipher$&"
13484 This variable is
13485 cleared before any outgoing SMTP connection is made,
13486 and then set to the outgoing cipher suite if one is negotiated. See chapter
13487 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13488 details of the &(smtp)& transport.
13489
13490 .vitem &$tls_out_cipher_std$&
13491 .vindex "&$tls_out_cipher_std$&"
13492 As above, but returning the RFC standard name for the cipher suite.
13493
13494 .vitem &$tls_out_dane$&
13495 .vindex &$tls_out_dane$&
13496 DANE active status.  See section &<<SECDANE>>&.
13497
13498 .vitem &$tls_in_ocsp$&
13499 .vindex "&$tls_in_ocsp$&"
13500 When a message is received from a remote client connection
13501 the result of any OCSP request from the client is encoded in this variable:
13502 .code
13503 0 OCSP proof was not requested (default value)
13504 1 No response to request
13505 2 Response not verified
13506 3 Verification failed
13507 4 Verification succeeded
13508 .endd
13509
13510 .vitem &$tls_out_ocsp$&
13511 .vindex "&$tls_out_ocsp$&"
13512 When a message is sent to a remote host connection
13513 the result of any OCSP request made is encoded in this variable.
13514 See &$tls_in_ocsp$& for values.
13515
13516 .vitem &$tls_in_peerdn$&
13517 .vindex "&$tls_in_peerdn$&"
13518 .vindex "&$tls_peerdn$&"
13519 .cindex certificate "extracting fields"
13520 When a message is received from a remote host over an encrypted SMTP
13521 connection, and Exim is configured to request a certificate from the client,
13522 the value of the Distinguished Name of the certificate is made available in the
13523 &$tls_in_peerdn$& during subsequent processing.
13524 If certificate verification fails it may refer to a failing chain element
13525 which is not the leaf.
13526
13527 The deprecated &$tls_peerdn$& variable refers to the inbound side
13528 except when used in the context of an outbound SMTP delivery, when it refers to
13529 the outbound.
13530
13531 .vitem &$tls_out_peerdn$&
13532 .vindex "&$tls_out_peerdn$&"
13533 When a message is being delivered to a remote host over an encrypted SMTP
13534 connection, and Exim is configured to request a certificate from the server,
13535 the value of the Distinguished Name of the certificate is made available in the
13536 &$tls_out_peerdn$& during subsequent processing.
13537 If certificate verification fails it may refer to a failing chain element
13538 which is not the leaf.
13539
13540 .vitem &$tls_in_sni$&
13541 .vindex "&$tls_in_sni$&"
13542 .vindex "&$tls_sni$&"
13543 .cindex "TLS" "Server Name Indication"
13544 When a TLS session is being established, if the client sends the Server
13545 Name Indication extension, the value will be placed in this variable.
13546 If the variable appears in &%tls_certificate%& then this option and
13547 some others, described in &<<SECTtlssni>>&,
13548 will be re-expanded early in the TLS session, to permit
13549 a different certificate to be presented (and optionally a different key to be
13550 used) to the client, based upon the value of the SNI extension.
13551
13552 The deprecated &$tls_sni$& variable refers to the inbound side
13553 except when used in the context of an outbound SMTP delivery, when it refers to
13554 the outbound.
13555
13556 .vitem &$tls_out_sni$&
13557 .vindex "&$tls_out_sni$&"
13558 .cindex "TLS" "Server Name Indication"
13559 During outbound
13560 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13561 the transport.
13562
13563 .vitem &$tls_out_tlsa_usage$&
13564 .vindex &$tls_out_tlsa_usage$&
13565 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13566
13567 .vitem &$tls_in_ver$&
13568 .vindex "&$tls_in_ver$&"
13569 When a message is received from a remote host over an encrypted SMTP connection
13570 this variable is set to the protocol version, eg &'TLS1.2'&.
13571
13572 .vitem &$tls_out_ver$&
13573 .vindex "&$tls_out_ver$&"
13574 When a message is being delivered to a remote host over an encrypted SMTP connection
13575 this variable is set to the protocol version.
13576
13577
13578 .vitem &$tod_bsdinbox$&
13579 .vindex "&$tod_bsdinbox$&"
13580 The time of day and the date, in the format required for BSD-style mailbox
13581 files, for example: Thu Oct 17 17:14:09 1995.
13582
13583 .vitem &$tod_epoch$&
13584 .vindex "&$tod_epoch$&"
13585 The time and date as a number of seconds since the start of the Unix epoch.
13586
13587 .vitem &$tod_epoch_l$&
13588 .vindex "&$tod_epoch_l$&"
13589 The time and date as a number of microseconds since the start of the Unix epoch.
13590
13591 .vitem &$tod_full$&
13592 .vindex "&$tod_full$&"
13593 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13594 +0100. The timezone is always given as a numerical offset from UTC, with
13595 positive values used for timezones that are ahead (east) of UTC, and negative
13596 values for those that are behind (west).
13597
13598 .vitem &$tod_log$&
13599 .vindex "&$tod_log$&"
13600 The time and date in the format used for writing Exim's log files, for example:
13601 1995-10-12 15:32:29, but without a timezone.
13602
13603 .vitem &$tod_logfile$&
13604 .vindex "&$tod_logfile$&"
13605 This variable contains the date in the format yyyymmdd. This is the format that
13606 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13607 flag.
13608
13609 .vitem &$tod_zone$&
13610 .vindex "&$tod_zone$&"
13611 This variable contains the numerical value of the local timezone, for example:
13612 -0500.
13613
13614 .vitem &$tod_zulu$&
13615 .vindex "&$tod_zulu$&"
13616 This variable contains the UTC date and time in &"Zulu"& format, as specified
13617 by ISO 8601, for example: 20030221154023Z.
13618
13619 .vitem &$transport_name$&
13620 .cindex "transport" "name"
13621 .cindex "name" "of transport"
13622 .vindex "&$transport_name$&"
13623 During the running of a transport, this variable contains its name.
13624
13625 .vitem &$value$&
13626 .vindex "&$value$&"
13627 This variable contains the result of an expansion lookup, extraction operation,
13628 or external command, as described above. It is also used during a
13629 &*reduce*& expansion.
13630
13631 .vitem &$verify_mode$&
13632 .vindex "&$verify_mode$&"
13633 While a router or transport is being run in verify mode or for cutthrough delivery,
13634 contains "S" for sender-verification or "R" for recipient-verification.
13635 Otherwise, empty.
13636
13637 .vitem &$version_number$&
13638 .vindex "&$version_number$&"
13639 The version number of Exim. Same as &$exim_version$&, may be overridden
13640 by the &%exim_version%& main config option.
13641
13642 .vitem &$warn_message_delay$&
13643 .vindex "&$warn_message_delay$&"
13644 This variable is set only during the creation of a message warning about a
13645 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13646
13647 .vitem &$warn_message_recipients$&
13648 .vindex "&$warn_message_recipients$&"
13649 This variable is set only during the creation of a message warning about a
13650 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13651 .endlist
13652 .ecindex IIDstrexp
13653
13654
13655
13656 . ////////////////////////////////////////////////////////////////////////////
13657 . ////////////////////////////////////////////////////////////////////////////
13658
13659 .chapter "Embedded Perl" "CHAPperl"
13660 .scindex IIDperl "Perl" "calling from Exim"
13661 Exim can be built to include an embedded Perl interpreter. When this is done,
13662 Perl subroutines can be called as part of the string expansion process. To make
13663 use of the Perl support, you need version 5.004 or later of Perl installed on
13664 your system. To include the embedded interpreter in the Exim binary, include
13665 the line
13666 .code
13667 EXIM_PERL = perl.o
13668 .endd
13669 in your &_Local/Makefile_& and then build Exim in the normal way.
13670
13671
13672 .section "Setting up so Perl can be used" "SECID85"
13673 .oindex "&%perl_startup%&"
13674 Access to Perl subroutines is via a global configuration option called
13675 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13676 no &%perl_startup%& option in the Exim configuration file then no Perl
13677 interpreter is started and there is almost no overhead for Exim (since none of
13678 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13679 option then the associated value is taken to be Perl code which is executed in
13680 a newly created Perl interpreter.
13681
13682 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13683 need backslashes before any characters to escape special meanings. The option
13684 should usually be something like
13685 .code
13686 perl_startup = do '/etc/exim.pl'
13687 .endd
13688 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13689 use from Exim. Exim can be configured either to start up a Perl interpreter as
13690 soon as it is entered, or to wait until the first time it is needed. Starting
13691 the interpreter at the beginning ensures that it is done while Exim still has
13692 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13693 fact used in a particular run. Also, note that this does not mean that Exim is
13694 necessarily running as root when Perl is called at a later time. By default,
13695 the interpreter is started only when it is needed, but this can be changed in
13696 two ways:
13697
13698 .ilist
13699 .oindex "&%perl_at_start%&"
13700 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13701 a startup when Exim is entered.
13702 .next
13703 The command line option &%-ps%& also requests a startup when Exim is entered,
13704 overriding the setting of &%perl_at_start%&.
13705 .endlist
13706
13707 There is also a command line option &%-pd%& (for delay) which suppresses the
13708 initial startup, even if &%perl_at_start%& is set.
13709
13710 .ilist
13711 .oindex "&%perl_taintmode%&"
13712 .cindex "Perl" "taintmode"
13713 To provide more security executing Perl code via the embedded Perl
13714 interpreter, the &%perl_taintmode%& option can be set. This enables the
13715 taint mode of the Perl interpreter. You are encouraged to set this
13716 option to a true value. To avoid breaking existing installations, it
13717 defaults to false.
13718
13719
13720 .section "Calling Perl subroutines" "SECID86"
13721 When the configuration file includes a &%perl_startup%& option you can make use
13722 of the string expansion item to call the Perl subroutines that are defined
13723 by the &%perl_startup%& code. The operator is used in any of the following
13724 forms:
13725 .code
13726 ${perl{foo}}
13727 ${perl{foo}{argument}}
13728 ${perl{foo}{argument1}{argument2} ... }
13729 .endd
13730 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13731 arguments may be passed. Passing more than this results in an expansion failure
13732 with an error message of the form
13733 .code
13734 Too many arguments passed to Perl subroutine "foo" (max is 8)
13735 .endd
13736 The return value of the Perl subroutine is evaluated in a scalar context before
13737 it is passed back to Exim to be inserted into the expanded string. If the
13738 return value is &'undef'&, the expansion is forced to fail in the same way as
13739 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13740 by obeying Perl's &%die%& function, the expansion fails with the error message
13741 that was passed to &%die%&.
13742
13743
13744 .section "Calling Exim functions from Perl" "SECID87"
13745 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13746 is available to call back into Exim's string expansion function. For example,
13747 the Perl code
13748 .code
13749 my $lp = Exim::expand_string('$local_part');
13750 .endd
13751 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13752 Note those are single quotes and not double quotes to protect against
13753 &$local_part$& being interpolated as a Perl variable.
13754
13755 If the string expansion is forced to fail by a &"fail"& item, the result of
13756 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13757 expansion string, the Perl call from the original expansion string fails with
13758 an appropriate error message, in the same way as if &%die%& were used.
13759
13760 .cindex "debugging" "from embedded Perl"
13761 .cindex "log" "writing from embedded Perl"
13762 Two other Exim functions are available for use from within Perl code.
13763 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13764 debugging is enabled. If you want a newline at the end, you must supply it.
13765 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13766 timestamp. In this case, you should not supply a terminating newline.
13767
13768
13769 .section "Use of standard output and error by Perl" "SECID88"
13770 .cindex "Perl" "standard output and error"
13771 You should not write to the standard error or output streams from within your
13772 Perl code, as it is not defined how these are set up. In versions of Exim
13773 before 4.50, it is possible for the standard output or error to refer to the
13774 SMTP connection during message reception via the daemon. Writing to this stream
13775 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13776 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13777 avoided, but the output is lost.
13778
13779 .cindex "Perl" "use of &%warn%&"
13780 The Perl &%warn%& statement writes to the standard error stream by default.
13781 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13782 you have no control. When Exim starts up the Perl interpreter, it arranges for
13783 output from the &%warn%& statement to be written to the Exim main log. You can
13784 change this by including appropriate Perl magic somewhere in your Perl code.
13785 For example, to discard &%warn%& output completely, you need this:
13786 .code
13787 $SIG{__WARN__} = sub { };
13788 .endd
13789 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13790 example, the code for the subroutine is empty, so it does nothing, but you can
13791 include any Perl code that you like. The text of the &%warn%& message is passed
13792 as the first subroutine argument.
13793 .ecindex IIDperl
13794
13795
13796 . ////////////////////////////////////////////////////////////////////////////
13797 . ////////////////////////////////////////////////////////////////////////////
13798
13799 .chapter "Starting the daemon and the use of network interfaces" &&&
13800          "CHAPinterfaces" &&&
13801          "Starting the daemon"
13802 .cindex "daemon" "starting"
13803 .cindex "interface" "listening"
13804 .cindex "network interface"
13805 .cindex "interface" "network"
13806 .cindex "IP address" "for listening"
13807 .cindex "daemon" "listening IP addresses"
13808 .cindex "TCP/IP" "setting listening interfaces"
13809 .cindex "TCP/IP" "setting listening ports"
13810 A host that is connected to a TCP/IP network may have one or more physical
13811 hardware network interfaces. Each of these interfaces may be configured as one
13812 or more &"logical"& interfaces, which are the entities that a program actually
13813 works with. Each of these logical interfaces is associated with an IP address.
13814 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13815 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13816 knowledge about the host's interfaces for use in three different circumstances:
13817
13818 .olist
13819 When a listening daemon is started, Exim needs to know which interfaces
13820 and ports to listen on.
13821 .next
13822 When Exim is routing an address, it needs to know which IP addresses
13823 are associated with local interfaces. This is required for the correct
13824 processing of MX lists by removing the local host and others with the
13825 same or higher priority values. Also, Exim needs to detect cases
13826 when an address is routed to an IP address that in fact belongs to the
13827 local host. Unless the &%self%& router option or the &%allow_localhost%&
13828 option of the smtp transport is set (as appropriate), this is treated
13829 as an error situation.
13830 .next
13831 When Exim connects to a remote host, it may need to know which interface to use
13832 for the outgoing connection.
13833 .endlist
13834
13835
13836 Exim's default behaviour is likely to be appropriate in the vast majority
13837 of cases. If your host has only one interface, and you want all its IP
13838 addresses to be treated in the same way, and you are using only the
13839 standard SMTP port, you should not need to take any special action. The
13840 rest of this chapter does not apply to you.
13841
13842 In a more complicated situation you may want to listen only on certain
13843 interfaces, or on different ports, and for this reason there are a number of
13844 options that can be used to influence Exim's behaviour. The rest of this
13845 chapter describes how they operate.
13846
13847 When a message is received over TCP/IP, the interface and port that were
13848 actually used are set in &$received_ip_address$& and &$received_port$&.
13849
13850
13851
13852 .section "Starting a listening daemon" "SECID89"
13853 When a listening daemon is started (by means of the &%-bd%& command line
13854 option), the interfaces and ports on which it listens are controlled by the
13855 following options:
13856
13857 .ilist
13858 &%daemon_smtp_ports%& contains a list of default ports
13859 or service names.
13860 (For backward compatibility, this option can also be specified in the singular.)
13861 .next
13862 &%local_interfaces%& contains list of interface IP addresses on which to
13863 listen. Each item may optionally also specify a port.
13864 .endlist
13865
13866 The default list separator in both cases is a colon, but this can be changed as
13867 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13868 it is usually best to change the separator to avoid having to double all the
13869 colons. For example:
13870 .code
13871 local_interfaces = <; 127.0.0.1 ; \
13872                       192.168.23.65 ; \
13873                       ::1 ; \
13874                       3ffe:ffff:836f::fe86:a061
13875 .endd
13876 There are two different formats for specifying a port along with an IP address
13877 in &%local_interfaces%&:
13878
13879 .olist
13880 The port is added onto the address with a dot separator. For example, to listen
13881 on port 1234 on two different IP addresses:
13882 .code
13883 local_interfaces = <; 192.168.23.65.1234 ; \
13884                       3ffe:ffff:836f::fe86:a061.1234
13885 .endd
13886 .next
13887 The IP address is enclosed in square brackets, and the port is added
13888 with a colon separator, for example:
13889 .code
13890 local_interfaces = <; [192.168.23.65]:1234 ; \
13891                       [3ffe:ffff:836f::fe86:a061]:1234
13892 .endd
13893 .endlist
13894
13895 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13896 default setting contains just one port:
13897 .code
13898 daemon_smtp_ports = smtp
13899 .endd
13900 If more than one port is listed, each interface that does not have its own port
13901 specified listens on all of them. Ports that are listed in
13902 &%daemon_smtp_ports%& can be identified either by name (defined in
13903 &_/etc/services_&) or by number. However, when ports are given with individual
13904 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13905
13906
13907
13908 .section "Special IP listening addresses" "SECID90"
13909 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13910 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13911 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13912 instead of setting up separate listening sockets for each interface. The
13913 default value of &%local_interfaces%& is
13914 .code
13915 local_interfaces = 0.0.0.0
13916 .endd
13917 when Exim is built without IPv6 support; otherwise it is:
13918 .code
13919 local_interfaces = <; ::0 ; 0.0.0.0
13920 .endd
13921 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13922
13923
13924
13925 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13926 The &%-oX%& command line option can be used to override the values of
13927 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13928 instance. Another way of doing this would be to use macros and the &%-D%&
13929 option. However, &%-oX%& can be used by any admin user, whereas modification of
13930 the runtime configuration by &%-D%& is allowed only when the caller is root or
13931 exim.
13932
13933 The value of &%-oX%& is a list of items. The default colon separator can be
13934 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13935 If there are any items that do not
13936 contain dots or colons (that is, are not IP addresses), the value of
13937 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13938 items that do contain dots or colons, the value of &%local_interfaces%& is
13939 replaced by those items. Thus, for example,
13940 .code
13941 -oX 1225
13942 .endd
13943 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13944 whereas
13945 .code
13946 -oX 192.168.34.5.1125
13947 .endd
13948 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13949 (However, since &%local_interfaces%& now contains no items without ports, the
13950 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13951
13952
13953
13954 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13955 .cindex "submissions protocol"
13956 .cindex "ssmtp protocol"
13957 .cindex "smtps protocol"
13958 .cindex "SMTP" "ssmtp protocol"
13959 .cindex "SMTP" "smtps protocol"
13960 Exim supports the use of TLS-on-connect, used by mail clients in the
13961 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13962 For some years, IETF Standards Track documents only blessed the
13963 STARTTLS-based Submission service (port 587) while common practice was to support
13964 the same feature set on port 465, but using TLS-on-connect.
13965 If your installation needs to provide service to mail clients
13966 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13967 the 465 TCP ports.
13968
13969 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13970 service names, connections to those ports must first establish TLS, before
13971 proceeding to the application layer use of the SMTP protocol.
13972
13973 The common use of this option is expected to be
13974 .code
13975 tls_on_connect_ports = 465
13976 .endd
13977 per RFC 8314.
13978 There is also a command line option &%-tls-on-connect%&, which forces all ports
13979 to behave in this way when a daemon is started.
13980
13981 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13982 daemon to listen on those ports. You must still specify them in
13983 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13984 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13985 connections via the daemon.)
13986
13987
13988
13989
13990 .section "IPv6 address scopes" "SECID92"
13991 .cindex "IPv6" "address scopes"
13992 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13993 can, in principle, have the same link-local IPv6 address on different
13994 interfaces. Thus, additional information is needed, over and above the IP
13995 address, to distinguish individual interfaces. A convention of using a
13996 percent sign followed by something (often the interface name) has been
13997 adopted in some cases, leading to addresses like this:
13998 .code
13999 fe80::202:b3ff:fe03:45c1%eth0
14000 .endd
14001 To accommodate this usage, a percent sign followed by an arbitrary string is
14002 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14003 to convert a textual IPv6 address for actual use. This function recognizes the
14004 percent convention in operating systems that support it, and it processes the
14005 address appropriately. Unfortunately, some older libraries have problems with
14006 &[getaddrinfo()]&. If
14007 .code
14008 IPV6_USE_INET_PTON=yes
14009 .endd
14010 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14011 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14012 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14013 function.) Of course, this means that the additional functionality of
14014 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14015
14016 .section "Disabling IPv6" "SECID93"
14017 .cindex "IPv6" "disabling"
14018 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14019 run on a host whose kernel does not support IPv6. The binary will fall back to
14020 using IPv4, but it may waste resources looking up AAAA records, and trying to
14021 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14022 .oindex "&%disable_ipv6%&"
14023 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14024 activities take place. AAAA records are never looked up, and any IPv6 addresses
14025 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14026 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14027 to handle IPv6 literal addresses.
14028
14029 On the other hand, when IPv6 is in use, there may be times when you want to
14030 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14031 option to globally suppress the lookup of AAAA records for specified domains,
14032 and you can use the &%ignore_target_hosts%& generic router option to ignore
14033 IPv6 addresses in an individual router.
14034
14035
14036
14037 .section "Examples of starting a listening daemon" "SECID94"
14038 The default case in an IPv6 environment is
14039 .code
14040 daemon_smtp_ports = smtp
14041 local_interfaces = <; ::0 ; 0.0.0.0
14042 .endd
14043 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14044 Either one or two sockets may be used, depending on the characteristics of
14045 the TCP/IP stack. (This is complicated and messy; for more information,
14046 read the comments in the &_daemon.c_& source file.)
14047
14048 To specify listening on ports 25 and 26 on all interfaces:
14049 .code
14050 daemon_smtp_ports = 25 : 26
14051 .endd
14052 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14053 .code
14054 local_interfaces = <; ::0.25     ; ::0.26 \
14055                       0.0.0.0.25 ; 0.0.0.0.26
14056 .endd
14057 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14058 IPv4 loopback address only:
14059 .code
14060 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14061 .endd
14062 To specify listening on the default port on specific interfaces only:
14063 .code
14064 local_interfaces = 10.0.0.67 : 192.168.34.67
14065 .endd
14066 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14067
14068
14069
14070 .section "Recognizing the local host" "SECTreclocipadd"
14071 The &%local_interfaces%& option is also used when Exim needs to determine
14072 whether or not an IP address refers to the local host. That is, the IP
14073 addresses of all the interfaces on which a daemon is listening are always
14074 treated as local.
14075
14076 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14077 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14078 available interfaces from the operating system, and extracts the relevant
14079 (that is, IPv4 or IPv6) addresses to use for checking.
14080
14081 Some systems set up large numbers of virtual interfaces in order to provide
14082 many virtual web servers. In this situation, you may want to listen for
14083 email on only a few of the available interfaces, but nevertheless treat all
14084 interfaces as local when routing. You can do this by setting
14085 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14086 &"all"& wildcard values. These addresses are recognized as local, but are not
14087 used for listening. Consider this example:
14088 .code
14089 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14090                       192.168.53.235 ; \
14091                       3ffe:2101:12:1:a00:20ff:fe86:a061
14092
14093 extra_local_interfaces = <; ::0 ; 0.0.0.0
14094 .endd
14095 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14096 address, but all available interface addresses are treated as local when
14097 Exim is routing.
14098
14099 In some environments the local host name may be in an MX list, but with an IP
14100 address that is not assigned to any local interface. In other cases it may be
14101 desirable to treat other host names as if they referred to the local host. Both
14102 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14103 This contains host names rather than IP addresses. When a host is referenced
14104 during routing, either via an MX record or directly, it is treated as the local
14105 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14106 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14107
14108
14109
14110 .section "Delivering to a remote host" "SECID95"
14111 Delivery to a remote host is handled by the smtp transport. By default, it
14112 allows the system's TCP/IP functions to choose which interface to use (if
14113 there is more than one) when connecting to a remote host. However, the
14114 &%interface%& option can be set to specify which interface is used. See the
14115 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14116 details.
14117
14118
14119
14120
14121 . ////////////////////////////////////////////////////////////////////////////
14122 . ////////////////////////////////////////////////////////////////////////////
14123
14124 .chapter "Main configuration" "CHAPmainconfig"
14125 .scindex IIDconfima "configuration file" "main section"
14126 .scindex IIDmaiconf "main configuration"
14127 The first part of the runtime configuration file contains three types of item:
14128
14129 .ilist
14130 Macro definitions: These lines start with an upper case letter. See section
14131 &<<SECTmacrodefs>>& for details of macro processing.
14132 .next
14133 Named list definitions: These lines start with one of the words &"domainlist"&,
14134 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14135 section &<<SECTnamedlists>>&.
14136 .next
14137 Main configuration settings: Each setting occupies one line of the file
14138 (with possible continuations). If any setting is preceded by the word
14139 &"hide"&, the &%-bP%& command line option displays its value to admin users
14140 only. See section &<<SECTcos>>& for a description of the syntax of these option
14141 settings.
14142 .endlist
14143
14144 This chapter specifies all the main configuration options, along with their
14145 types and default values. For ease of finding a particular option, they appear
14146 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14147 are now so many options, they are first listed briefly in functional groups, as
14148 an aid to finding the name of the option you are looking for. Some options are
14149 listed in more than one group.
14150
14151 .section "Miscellaneous" "SECID96"
14152 .table2
14153 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14154 .row &%debug_store%&                 "do extra internal checks"
14155 .row &%disable_ipv6%&                "do no IPv6 processing"
14156 .row &%keep_malformed%&              "for broken files &-- should not happen"
14157 .row &%localhost_number%&            "for unique message ids in clusters"
14158 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14159 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14160 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14161 .row &%print_topbitchars%&           "top-bit characters are printing"
14162 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14163 .row &%timezone%&                    "force time zone"
14164 .endtable
14165
14166
14167 .section "Exim parameters" "SECID97"
14168 .table2
14169 .row &%exim_group%&                  "override compiled-in value"
14170 .row &%exim_path%&                   "override compiled-in value"
14171 .row &%exim_user%&                   "override compiled-in value"
14172 .row &%primary_hostname%&            "default from &[uname()]&"
14173 .row &%split_spool_directory%&       "use multiple directories"
14174 .row &%spool_directory%&             "override compiled-in value"
14175 .endtable
14176
14177
14178
14179 .section "Privilege controls" "SECID98"
14180 .table2
14181 .row &%admin_groups%&                "groups that are Exim admin users"
14182 .row &%commandline_checks_require_admin%& "require admin for various checks"
14183 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14184 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14185 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14186 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14187 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14188 .row &%never_users%&                 "do not run deliveries as these"
14189 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14190 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14191 .row &%trusted_groups%&              "groups that are trusted"
14192 .row &%trusted_users%&               "users that are trusted"
14193 .endtable
14194
14195
14196
14197 .section "Logging" "SECID99"
14198 .table2
14199 .row &%event_action%&                "custom logging"
14200 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14201 .row &%log_file_path%&               "override compiled-in value"
14202 .row &%log_selector%&                "set/unset optional logging"
14203 .row &%log_timezone%&                "add timezone to log lines"
14204 .row &%message_logs%&                "create per-message logs"
14205 .row &%preserve_message_logs%&       "after message completion"
14206 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14207 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14208 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14209 .row &%syslog_facility%&             "set syslog &""facility""& field"
14210 .row &%syslog_pid%&                  "pid in syslog lines"
14211 .row &%syslog_processname%&          "set syslog &""ident""& field"
14212 .row &%syslog_timestamp%&            "timestamp syslog lines"
14213 .row &%write_rejectlog%&             "control use of message log"
14214 .endtable
14215
14216
14217
14218 .section "Frozen messages" "SECID100"
14219 .table2
14220 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14221 .row &%freeze_tell%&                 "send message when freezing"
14222 .row &%move_frozen_messages%&        "to another directory"
14223 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14224 .endtable
14225
14226
14227
14228 .section "Data lookups" "SECID101"
14229 .table2
14230 .row &%ibase_servers%&               "InterBase servers"
14231 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14232 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14233 .row &%ldap_cert_file%&              "client cert file for LDAP"
14234 .row &%ldap_cert_key%&               "client key file for LDAP"
14235 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14236 .row &%ldap_default_servers%&        "used if no server in query"
14237 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14238 .row &%ldap_start_tls%&              "require TLS within LDAP"
14239 .row &%ldap_version%&                "set protocol version"
14240 .row &%lookup_open_max%&             "lookup files held open"
14241 .row &%mysql_servers%&               "default MySQL servers"
14242 .row &%oracle_servers%&              "Oracle servers"
14243 .row &%pgsql_servers%&               "default PostgreSQL servers"
14244 .row &%sqlite_lock_timeout%&         "as it says"
14245 .endtable
14246
14247
14248
14249 .section "Message ids" "SECID102"
14250 .table2
14251 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14252 .row &%message_id_header_text%&      "ditto"
14253 .endtable
14254
14255
14256
14257 .section "Embedded Perl Startup" "SECID103"
14258 .table2
14259 .row &%perl_at_start%&               "always start the interpreter"
14260 .row &%perl_startup%&                "code to obey when starting Perl"
14261 .row &%perl_taintmode%&              "enable taint mode in Perl"
14262 .endtable
14263
14264
14265
14266 .section "Daemon" "SECID104"
14267 .table2
14268 .row &%daemon_smtp_ports%&           "default ports"
14269 .row &%daemon_startup_retries%&      "number of times to retry"
14270 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14271 .row &%extra_local_interfaces%&      "not necessarily listened on"
14272 .row &%local_interfaces%&            "on which to listen, with optional ports"
14273 .row &%pid_file_path%&               "override compiled-in value"
14274 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14275 .endtable
14276
14277
14278
14279 .section "Resource control" "SECID105"
14280 .table2
14281 .row &%check_log_inodes%&            "before accepting a message"
14282 .row &%check_log_space%&             "before accepting a message"
14283 .row &%check_spool_inodes%&          "before accepting a message"
14284 .row &%check_spool_space%&           "before accepting a message"
14285 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14286 .row &%queue_only_load%&             "queue incoming if load high"
14287 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14288 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14289 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14290 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14291 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14292 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14293 .row &%smtp_accept_max_per_connection%& "messages per connection"
14294 .row &%smtp_accept_max_per_host%&    "connections from one host"
14295 .row &%smtp_accept_queue%&           "queue mail if more connections"
14296 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14297                                            connection"
14298 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14299 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14300 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14301 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14302 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14303 .endtable
14304
14305
14306
14307 .section "Policy controls" "SECID106"
14308 .table2
14309 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14310 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14311 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14312 .row &%acl_smtp_auth%&               "ACL for AUTH"
14313 .row &%acl_smtp_connect%&            "ACL for connection"
14314 .row &%acl_smtp_data%&               "ACL for DATA"
14315 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14316 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14317 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14318 .row &%acl_smtp_expn%&               "ACL for EXPN"
14319 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14320 .row &%acl_smtp_mail%&               "ACL for MAIL"
14321 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14322 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14323 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14324 .row &%acl_smtp_predata%&            "ACL for start of data"
14325 .row &%acl_smtp_quit%&               "ACL for QUIT"
14326 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14327 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14328 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14329 .row &%av_scanner%&                  "specify virus scanner"
14330 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14331                                       words""&"
14332 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14333 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14334 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14335 .row &%header_maxsize%&              "total size of message header"
14336 .row &%header_line_maxsize%&         "individual header line limit"
14337 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14338 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14339 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14340 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14341 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14342 .row &%host_lookup%&                 "host name looked up for these hosts"
14343 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14344 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14345 .row &%host_reject_connection%&      "reject connection from these hosts"
14346 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14347 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14348 .row &%message_size_limit%&          "for all messages"
14349 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14350 .row &%spamd_address%&               "set interface to SpamAssassin"
14351 .row &%strict_acl_vars%&             "object to unset ACL variables"
14352 .endtable
14353
14354
14355
14356 .section "Callout cache" "SECID107"
14357 .table2
14358 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14359                                          item"
14360 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14361                                          item"
14362 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14363 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14364 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14365 .endtable
14366
14367
14368
14369 .section "TLS" "SECID108"
14370 .table2
14371 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14372 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14373 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14374 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14375 .row &%tls_certificate%&             "location of server certificate"
14376 .row &%tls_crl%&                     "certificate revocation list"
14377 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14378 .row &%tls_dhparam%&                 "DH parameters for server"
14379 .row &%tls_eccurve%&                 "EC curve selection for server"
14380 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14381 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14382 .row &%tls_privatekey%&              "location of server private key"
14383 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14384 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14385 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14386 .row &%tls_verify_certificates%&     "expected client certificates"
14387 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14388 .endtable
14389
14390
14391
14392 .section "Local user handling" "SECID109"
14393 .table2
14394 .row &%finduser_retries%&            "useful in NIS environments"
14395 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14396 .row &%gecos_pattern%&               "ditto"
14397 .row &%max_username_length%&         "for systems that truncate"
14398 .row &%unknown_login%&               "used when no login name found"
14399 .row &%unknown_username%&            "ditto"
14400 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14401 .row &%uucp_from_sender%&            "ditto"
14402 .endtable
14403
14404
14405
14406 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14407 .table2
14408 .row &%header_maxsize%&              "total size of message header"
14409 .row &%header_line_maxsize%&         "individual header line limit"
14410 .row &%message_size_limit%&          "applies to all messages"
14411 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14412 .row &%received_header_text%&        "expanded to make &'Received:'&"
14413 .row &%received_headers_max%&        "for mail loop detection"
14414 .row &%recipients_max%&              "limit per message"
14415 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14416 .endtable
14417
14418
14419
14420
14421 .section "Non-SMTP incoming messages" "SECID111"
14422 .table2
14423 .row &%receive_timeout%&             "for non-SMTP messages"
14424 .endtable
14425
14426
14427
14428
14429
14430 .section "Incoming SMTP messages" "SECID112"
14431 See also the &'Policy controls'& section above.
14432
14433 .table2
14434 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14435 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14436 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14437 .row &%host_lookup%&                 "host name looked up for these hosts"
14438 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14439 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14440 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14441 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14442 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14443 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14444 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14445 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14446 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14447 .row &%smtp_accept_max_per_connection%& "messages per connection"
14448 .row &%smtp_accept_max_per_host%&    "connections from one host"
14449 .row &%smtp_accept_queue%&           "queue mail if more connections"
14450 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14451                                            connection"
14452 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14453 .row &%smtp_active_hostname%&        "host name to use in messages"
14454 .row &%smtp_banner%&                 "text for welcome banner"
14455 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14456 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14457 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14458 .row &%smtp_etrn_command%&           "what to run for ETRN"
14459 .row &%smtp_etrn_serialize%&         "only one at once"
14460 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14461 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14462 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14463 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14464 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14465 .row &%smtp_receive_timeout%&        "per command or data line"
14466 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14467 .row &%smtp_return_error_details%&   "give detail on rejections"
14468 .endtable
14469
14470
14471
14472 .section "SMTP extensions" "SECID113"
14473 .table2
14474 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14475 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14476 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14477 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14478 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14479 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14480 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14481 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14482 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14483 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14484 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14485 .endtable
14486
14487
14488
14489 .section "Processing messages" "SECID114"
14490 .table2
14491 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14492 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14493 .row &%allow_utf8_domains%&          "in addresses"
14494 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14495                                       words""&"
14496 .row &%delivery_date_remove%&        "from incoming messages"
14497 .row &%envelope_to_remove%&          "from incoming messages"
14498 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14499 .row &%headers_charset%&             "default for translations"
14500 .row &%qualify_domain%&              "default for senders"
14501 .row &%qualify_recipient%&           "default for recipients"
14502 .row &%return_path_remove%&          "from incoming messages"
14503 .row &%strip_excess_angle_brackets%& "in addresses"
14504 .row &%strip_trailing_dot%&          "at end of addresses"
14505 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14506 .endtable
14507
14508
14509
14510 .section "System filter" "SECID115"
14511 .table2
14512 .row &%system_filter%&               "locate system filter"
14513 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14514                                             directory"
14515 .row &%system_filter_file_transport%& "transport for delivery to a file"
14516 .row &%system_filter_group%&         "group for filter running"
14517 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14518 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14519 .row &%system_filter_user%&          "user for filter running"
14520 .endtable
14521
14522
14523
14524 .section "Routing and delivery" "SECID116"
14525 .table2
14526 .row &%disable_ipv6%&                "do no IPv6 processing"
14527 .row &%dns_again_means_nonexist%&    "for broken domains"
14528 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14529 .row &%dns_dnssec_ok%&               "parameter for resolver"
14530 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14531 .row &%dns_retrans%&                 "parameter for resolver"
14532 .row &%dns_retry%&                   "parameter for resolver"
14533 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14534 .row &%dns_use_edns0%&               "parameter for resolver"
14535 .row &%hold_domains%&                "hold delivery for these domains"
14536 .row &%local_interfaces%&            "for routing checks"
14537 .row &%queue_domains%&               "no immediate delivery for these"
14538 .row &%queue_only%&                  "no immediate delivery at all"
14539 .row &%queue_only_file%&             "no immediate delivery if file exists"
14540 .row &%queue_only_load%&             "no immediate delivery if load is high"
14541 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14542 .row &%queue_only_override%&         "allow command line to override"
14543 .row &%queue_run_in_order%&          "order of arrival"
14544 .row &%queue_run_max%&               "of simultaneous queue runners"
14545 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14546 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14547 .row &%remote_sort_domains%&         "order of remote deliveries"
14548 .row &%retry_data_expire%&           "timeout for retry data"
14549 .row &%retry_interval_max%&          "safety net for retry rules"
14550 .endtable
14551
14552
14553
14554 .section "Bounce and warning messages" "SECID117"
14555 .table2
14556 .row &%bounce_message_file%&         "content of bounce"
14557 .row &%bounce_message_text%&         "content of bounce"
14558 .row &%bounce_return_body%&          "include body if returning message"
14559 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14560 .row &%bounce_return_message%&       "include original message in bounce"
14561 .row &%bounce_return_size_limit%&    "limit on returned message"
14562 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14563 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14564 .row &%errors_copy%&                 "copy bounce messages"
14565 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14566 .row &%delay_warning%&               "time schedule"
14567 .row &%delay_warning_condition%&     "condition for warning messages"
14568 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14569 .row &%smtp_return_error_details%&   "give detail on rejections"
14570 .row &%warn_message_file%&           "content of warning message"
14571 .endtable
14572
14573
14574
14575 .section "Alphabetical list of main options" "SECTalomo"
14576 Those options that undergo string expansion before use are marked with
14577 &dagger;.
14578
14579 .option accept_8bitmime main boolean true
14580 .cindex "8BITMIME"
14581 .cindex "8-bit characters"
14582 .cindex "log" "selectors"
14583 .cindex "log" "8BITMIME"
14584 This option causes Exim to send 8BITMIME in its response to an SMTP
14585 EHLO command, and to accept the BODY= parameter on MAIL commands.
14586 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14587 takes no steps to do anything special with messages received by this route.
14588
14589 Historically Exim kept this option off by default, but the maintainers
14590 feel that in today's Internet, this causes more problems than it solves.
14591 It now defaults to true.
14592 A more detailed analysis of the issues is provided by Dan Bernstein:
14593 .display
14594 &url(https://cr.yp.to/smtp/8bitmime.html)
14595 .endd
14596
14597 To log received 8BITMIME status use
14598 .code
14599 log_selector = +8bitmime
14600 .endd
14601
14602 .option acl_not_smtp main string&!! unset
14603 .cindex "&ACL;" "for non-SMTP messages"
14604 .cindex "non-SMTP messages" "ACLs for"
14605 This option defines the ACL that is run when a non-SMTP message has been
14606 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14607 further details.
14608
14609 .option acl_not_smtp_mime main string&!! unset
14610 This option defines the ACL that is run for individual MIME parts of non-SMTP
14611 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14612 SMTP messages.
14613
14614 .option acl_not_smtp_start main string&!! unset
14615 .cindex "&ACL;" "at start of non-SMTP message"
14616 .cindex "non-SMTP messages" "ACLs for"
14617 This option defines the ACL that is run before Exim starts reading a
14618 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14619
14620 .option acl_smtp_auth main string&!! unset
14621 .cindex "&ACL;" "setting up for SMTP commands"
14622 .cindex "AUTH" "ACL for"
14623 This option defines the ACL that is run when an SMTP AUTH command is
14624 received. See chapter &<<CHAPACL>>& for further details.
14625
14626 .option acl_smtp_connect main string&!! unset
14627 .cindex "&ACL;" "on SMTP connection"
14628 This option defines the ACL that is run when an SMTP connection is received.
14629 See chapter &<<CHAPACL>>& for further details.
14630
14631 .option acl_smtp_data main string&!! unset
14632 .cindex "DATA" "ACL for"
14633 This option defines the ACL that is run after an SMTP DATA command has been
14634 processed and the message itself has been received, but before the final
14635 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14636
14637 .option acl_smtp_data_prdr main string&!! accept
14638 .cindex "PRDR" "ACL for"
14639 .cindex "DATA" "PRDR ACL for"
14640 .cindex "&ACL;" "PRDR-related"
14641 .cindex "&ACL;" "per-user data processing"
14642 This option defines the ACL that,
14643 if the PRDR feature has been negotiated,
14644 is run for each recipient after an SMTP DATA command has been
14645 processed and the message itself has been received, but before the
14646 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14647
14648 .option acl_smtp_dkim main string&!! unset
14649 .cindex DKIM "ACL for"
14650 This option defines the ACL that is run for each DKIM signature
14651 (by default, or as specified in the dkim_verify_signers option)
14652 of a received message.
14653 See section &<<SECDKIMVFY>>& for further details.
14654
14655 .option acl_smtp_etrn main string&!! unset
14656 .cindex "ETRN" "ACL for"
14657 This option defines the ACL that is run when an SMTP ETRN command is
14658 received. See chapter &<<CHAPACL>>& for further details.
14659
14660 .option acl_smtp_expn main string&!! unset
14661 .cindex "EXPN" "ACL for"
14662 This option defines the ACL that is run when an SMTP EXPN command is
14663 received. See chapter &<<CHAPACL>>& for further details.
14664
14665 .option acl_smtp_helo main string&!! unset
14666 .cindex "EHLO" "ACL for"
14667 .cindex "HELO" "ACL for"
14668 This option defines the ACL that is run when an SMTP EHLO or HELO
14669 command is received. See chapter &<<CHAPACL>>& for further details.
14670
14671
14672 .option acl_smtp_mail main string&!! unset
14673 .cindex "MAIL" "ACL for"
14674 This option defines the ACL that is run when an SMTP MAIL command is
14675 received. See chapter &<<CHAPACL>>& for further details.
14676
14677 .option acl_smtp_mailauth main string&!! unset
14678 .cindex "AUTH" "on MAIL command"
14679 This option defines the ACL that is run when there is an AUTH parameter on
14680 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14681 &<<CHAPSMTPAUTH>>& for details of authentication.
14682
14683 .option acl_smtp_mime main string&!! unset
14684 .cindex "MIME content scanning" "ACL for"
14685 This option is available when Exim is built with the content-scanning
14686 extension. It defines the ACL that is run for each MIME part in a message. See
14687 section &<<SECTscanmimepart>>& for details.
14688
14689 .option acl_smtp_notquit main string&!! unset
14690 .cindex "not-QUIT, ACL for"
14691 This option defines the ACL that is run when an SMTP session
14692 ends without a QUIT command being received.
14693 See chapter &<<CHAPACL>>& for further details.
14694
14695 .option acl_smtp_predata main string&!! unset
14696 This option defines the ACL that is run when an SMTP DATA command is
14697 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14698 further details.
14699
14700 .option acl_smtp_quit main string&!! unset
14701 .cindex "QUIT, ACL for"
14702 This option defines the ACL that is run when an SMTP QUIT command is
14703 received. See chapter &<<CHAPACL>>& for further details.
14704
14705 .option acl_smtp_rcpt main string&!! unset
14706 .cindex "RCPT" "ACL for"
14707 This option defines the ACL that is run when an SMTP RCPT command is
14708 received. See chapter &<<CHAPACL>>& for further details.
14709
14710 .option acl_smtp_starttls main string&!! unset
14711 .cindex "STARTTLS, ACL for"
14712 This option defines the ACL that is run when an SMTP STARTTLS command is
14713 received. See chapter &<<CHAPACL>>& for further details.
14714
14715 .option acl_smtp_vrfy main string&!! unset
14716 .cindex "VRFY" "ACL for"
14717 This option defines the ACL that is run when an SMTP VRFY command is
14718 received. See chapter &<<CHAPACL>>& for further details.
14719
14720 .option add_environment main "string list" empty
14721 .cindex "environment" "set values"
14722 This option adds individual environment variables that the
14723 currently linked libraries and programs in child processes may use.
14724 Each list element should be of the form &"name=value"&.
14725
14726 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14727
14728 .option admin_groups main "string list&!!" unset
14729 .cindex "admin user"
14730 This option is expanded just once, at the start of Exim's processing. If the
14731 current group or any of the supplementary groups of an Exim caller is in this
14732 colon-separated list, the caller has admin privileges. If all your system
14733 programmers are in a specific group, for example, you can give them all Exim
14734 admin privileges by putting that group in &%admin_groups%&. However, this does
14735 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14736 To permit this, you have to add individuals to the Exim group.
14737
14738 .option allow_domain_literals main boolean false
14739 .cindex "domain literal"
14740 If this option is set, the RFC 2822 domain literal format is permitted in
14741 email addresses. The option is not set by default, because the domain literal
14742 format is not normally required these days, and few people know about it. It
14743 has, however, been exploited by mail abusers.
14744
14745 Unfortunately, it seems that some DNS black list maintainers are using this
14746 format to report black listing to postmasters. If you want to accept messages
14747 addressed to your hosts by IP address, you need to set
14748 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14749 domains (defined in the named domain list &%local_domains%& in the default
14750 configuration). This &"magic string"& matches the domain literal form of all
14751 the local host's IP addresses.
14752
14753
14754 .option allow_mx_to_ip main boolean false
14755 .cindex "MX record" "pointing to IP address"
14756 It appears that more and more DNS zone administrators are breaking the rules
14757 and putting domain names that look like IP addresses on the right hand side of
14758 MX records. Exim follows the rules and rejects this, giving an error message
14759 that explains the misconfiguration. However, some other MTAs support this
14760 practice, so to avoid &"Why can't Exim do this?"& complaints,
14761 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14762 recommended, except when you have no other choice.
14763
14764 .option allow_utf8_domains main boolean false
14765 .cindex "domain" "UTF-8 characters in"
14766 .cindex "UTF-8" "in domain name"
14767 Lots of discussion is going on about internationalized domain names. One
14768 camp is strongly in favour of just using UTF-8 characters, and it seems
14769 that at least two other MTAs permit this.
14770 This option allows Exim users to experiment if they wish.
14771
14772 If it is set true, Exim's domain parsing function allows valid
14773 UTF-8 multicharacters to appear in domain name components, in addition to
14774 letters, digits, and hyphens.
14775
14776 If Exim is built with internationalization support
14777 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14778 this option can be left as default.
14779 Without that,
14780 if you want to look up such domain names in the DNS, you must also
14781 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14782 suitable setting is:
14783 .code
14784 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14785   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14786 .endd
14787 Alternatively, you can just disable this feature by setting
14788 .code
14789 dns_check_names_pattern =
14790 .endd
14791 That is, set the option to an empty string so that no check is done.
14792
14793
14794 .option auth_advertise_hosts main "host list&!!" *
14795 .cindex "authentication" "advertising"
14796 .cindex "AUTH" "advertising"
14797 If any server authentication mechanisms are configured, Exim advertises them in
14798 response to an EHLO command only if the calling host matches this list.
14799 Otherwise, Exim does not advertise AUTH.
14800 Exim does not accept AUTH commands from clients to which it has not
14801 advertised the availability of AUTH. The advertising of individual
14802 authentication mechanisms can be controlled by the use of the
14803 &%server_advertise_condition%& generic authenticator option on the individual
14804 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14805
14806 Certain mail clients (for example, Netscape) require the user to provide a name
14807 and password for authentication if AUTH is advertised, even though it may
14808 not be needed (the host may accept messages from hosts on its local LAN without
14809 authentication, for example). The &%auth_advertise_hosts%& option can be used
14810 to make these clients more friendly by excluding them from the set of hosts to
14811 which Exim advertises AUTH.
14812
14813 .cindex "AUTH" "advertising when encrypted"
14814 If you want to advertise the availability of AUTH only when the connection
14815 is encrypted using TLS, you can make use of the fact that the value of this
14816 option is expanded, with a setting like this:
14817 .code
14818 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14819 .endd
14820 .vindex "&$tls_in_cipher$&"
14821 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14822 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14823 expansion is *, which matches all hosts.
14824
14825
14826 .option auto_thaw main time 0s
14827 .cindex "thawing messages"
14828 .cindex "unfreezing messages"
14829 If this option is set to a time greater than zero, a queue runner will try a
14830 new delivery attempt on any frozen message, other than a bounce message, if
14831 this much time has passed since it was frozen. This may result in the message
14832 being re-frozen if nothing has changed since the last attempt. It is a way of
14833 saying &"keep on trying, even though there are big problems"&.
14834
14835 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14836 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14837 thought to be very useful any more, and its use should probably be avoided.
14838
14839
14840 .option av_scanner main string "see below"
14841 This option is available if Exim is built with the content-scanning extension.
14842 It specifies which anti-virus scanner to use. The default value is:
14843 .code
14844 sophie:/var/run/sophie
14845 .endd
14846 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14847 before use. See section &<<SECTscanvirus>>& for further details.
14848
14849
14850 .option bi_command main string unset
14851 .oindex "&%-bi%&"
14852 This option supplies the name of a command that is run when Exim is called with
14853 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14854 just the command name, it is not a complete command line. If an argument is
14855 required, it must come from the &%-oA%& command line option.
14856
14857
14858 .option bounce_message_file main string unset
14859 .cindex "bounce message" "customizing"
14860 .cindex "customizing" "bounce message"
14861 This option defines a template file containing paragraphs of text to be used
14862 for constructing bounce messages.  Details of the file's contents are given in
14863 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14864
14865
14866 .option bounce_message_text main string unset
14867 When this option is set, its contents are included in the default bounce
14868 message immediately after &"This message was created automatically by mail
14869 delivery software."& It is not used if &%bounce_message_file%& is set.
14870
14871 .option bounce_return_body main boolean true
14872 .cindex "bounce message" "including body"
14873 This option controls whether the body of an incoming message is included in a
14874 bounce message when &%bounce_return_message%& is true. The default setting
14875 causes the entire message, both header and body, to be returned (subject to the
14876 value of &%bounce_return_size_limit%&). If this option is false, only the
14877 message header is included. In the case of a non-SMTP message containing an
14878 error that is detected during reception, only those header lines preceding the
14879 point at which the error was detected are returned.
14880 .cindex "bounce message" "including original"
14881
14882 .option bounce_return_linesize_limit main integer 998
14883 .cindex "size" "of bounce lines, limit"
14884 .cindex "bounce message" "line length limit"
14885 .cindex "limit" "bounce message line length"
14886 This option sets a limit in bytes on the line length of messages
14887 that are returned to senders due to delivery problems,
14888 when &%bounce_return_message%& is true.
14889 The default value corresponds to RFC limits.
14890 If the message being returned has lines longer than this value it is
14891 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14892
14893 The option also applies to bounces returned when an error is detected
14894 during reception of a message.
14895 In this case lines from the original are truncated.
14896
14897 The option does not apply to messages generated by an &(autoreply)& transport.
14898
14899
14900 .option bounce_return_message main boolean true
14901 If this option is set false, none of the original message is included in
14902 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14903 &%bounce_return_body%&.
14904
14905
14906 .option bounce_return_size_limit main integer 100K
14907 .cindex "size" "of bounce, limit"
14908 .cindex "bounce message" "size limit"
14909 .cindex "limit" "bounce message size"
14910 This option sets a limit in bytes on the size of messages that are returned to
14911 senders as part of bounce messages when &%bounce_return_message%& is true. The
14912 limit should be less than the value of the global &%message_size_limit%& and of
14913 any &%message_size_limit%& settings on transports, to allow for the bounce text
14914 that Exim generates. If this option is set to zero there is no limit.
14915
14916 When the body of any message that is to be included in a bounce message is
14917 greater than the limit, it is truncated, and a comment pointing this out is
14918 added at the top. The actual cutoff may be greater than the value given, owing
14919 to the use of buffering for transferring the message in chunks (typically 8K in
14920 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14921 messages.
14922
14923 .option bounce_sender_authentication main string unset
14924 .cindex "bounce message" "sender authentication"
14925 .cindex "authentication" "bounce message"
14926 .cindex "AUTH" "on bounce message"
14927 This option provides an authenticated sender address that is sent with any
14928 bounce messages generated by Exim that are sent over an authenticated SMTP
14929 connection. A typical setting might be:
14930 .code
14931 bounce_sender_authentication = mailer-daemon@my.domain.example
14932 .endd
14933 which would cause bounce messages to be sent using the SMTP command:
14934 .code
14935 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14936 .endd
14937 The value of &%bounce_sender_authentication%& must always be a complete email
14938 address.
14939
14940 .option callout_domain_negative_expire main time 3h
14941 .cindex "caching" "callout timeouts"
14942 .cindex "callout" "caching timeouts"
14943 This option specifies the expiry time for negative callout cache data for a
14944 domain. See section &<<SECTcallver>>& for details of callout verification, and
14945 section &<<SECTcallvercache>>& for details of the caching.
14946
14947
14948 .option callout_domain_positive_expire main time 7d
14949 This option specifies the expiry time for positive 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_negative_expire main time 2h
14955 This option specifies the expiry time for negative callout cache data for an
14956 address. See section &<<SECTcallver>>& for details of callout verification, and
14957 section &<<SECTcallvercache>>& for details of the caching.
14958
14959
14960 .option callout_positive_expire main time 24h
14961 This option specifies the expiry time for positive 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_random_local_part main string&!! "see below"
14967 This option defines the &"random"& local part that can be used as part of
14968 callout verification. The default value is
14969 .code
14970 $primary_hostname-$tod_epoch-testing
14971 .endd
14972 See section &<<CALLaddparcall>>& for details of how this value is used.
14973
14974
14975 .option check_log_inodes main integer 100
14976 See &%check_spool_space%& below.
14977
14978
14979 .option check_log_space main integer 10M
14980 See &%check_spool_space%& below.
14981
14982 .oindex "&%check_rfc2047_length%&"
14983 .cindex "RFC 2047" "disabling length check"
14984 .option check_rfc2047_length main boolean true
14985 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14986 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14987 word; strings to be encoded that exceed this length are supposed to use
14988 multiple encoded words. By default, Exim does not recognize encoded words that
14989 exceed the maximum length. However, it seems that some software, in violation
14990 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14991 set false, Exim recognizes encoded words of any length.
14992
14993
14994 .option check_spool_inodes main integer 100
14995 See &%check_spool_space%& below.
14996
14997
14998 .option check_spool_space main integer 10M
14999 .cindex "checking disk space"
15000 .cindex "disk space, checking"
15001 .cindex "spool directory" "checking space"
15002 The four &%check_...%& options allow for checking of disk resources before a
15003 message is accepted.
15004
15005 .vindex "&$log_inodes$&"
15006 .vindex "&$log_space$&"
15007 .vindex "&$spool_inodes$&"
15008 .vindex "&$spool_space$&"
15009 When any of these options are nonzero, they apply to all incoming messages. If you
15010 want to apply different checks to different kinds of message, you can do so by
15011 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15012 &$spool_space$& in an ACL with appropriate additional conditions.
15013
15014
15015 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15016 either value is greater than zero, for example:
15017 .code
15018 check_spool_space = 100M
15019 check_spool_inodes = 100
15020 .endd
15021 The spool partition is the one that contains the directory defined by
15022 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15023 transit.
15024
15025 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15026 files are written if either is greater than zero. These should be set only if
15027 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15028
15029 If there is less space or fewer inodes than requested, Exim refuses to accept
15030 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15031 error response to the MAIL command. If ESMTP is in use and there was a
15032 SIZE parameter on the MAIL command, its value is added to the
15033 &%check_spool_space%& value, and the check is performed even if
15034 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15035
15036 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15037 number of kilobytes (though specified in bytes).
15038 If a non-multiple of 1024 is specified, it is rounded up.
15039
15040 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15041 failure a message is written to stderr and Exim exits with a non-zero code, as
15042 it obviously cannot send an error message of any kind.
15043
15044 There is a slight performance penalty for these checks.
15045 Versions of Exim preceding 4.88 had these disabled by default;
15046 high-rate installations confident they will never run out of resources
15047 may wish to deliberately disable them.
15048
15049 .option chunking_advertise_hosts main "host list&!!" *
15050 .cindex CHUNKING advertisement
15051 .cindex "RFC 3030" "CHUNKING"
15052 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15053 these hosts.
15054 Hosts may use the BDAT command as an alternate to DATA.
15055
15056 .option commandline_checks_require_admin main boolean &`false`&
15057 .cindex "restricting access to features"
15058 This option restricts various basic checking features to require an
15059 administrative user.
15060 This affects most of the &%-b*%& options, such as &%-be%&.
15061
15062 .option debug_store main boolean &`false`&
15063 .cindex debugging "memory corruption"
15064 .cindex memory debugging
15065 This option, when true, enables extra checking in Exim's internal memory
15066 management.  For use when a memory corruption issue is being investigated,
15067 it should normally be left as default.
15068
15069 .option daemon_smtp_ports main string &`smtp`&
15070 .cindex "port" "for daemon"
15071 .cindex "TCP/IP" "setting listening ports"
15072 This option specifies one or more default SMTP ports on which the Exim daemon
15073 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15074 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15075
15076 .option daemon_startup_retries main integer 9
15077 .cindex "daemon startup, retrying"
15078 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15079 the daemon at startup when it cannot immediately bind a listening socket
15080 (typically because the socket is already in use): &%daemon_startup_retries%&
15081 defines the number of retries after the first failure, and
15082 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15083
15084 .option daemon_startup_sleep main time 30s
15085 See &%daemon_startup_retries%&.
15086
15087 .option delay_warning main "time list" 24h
15088 .cindex "warning of delay"
15089 .cindex "delay warning, specifying"
15090 .cindex "queue" "delay warning"
15091 When a message is delayed, Exim sends a warning message to the sender at
15092 intervals specified by this option. The data is a colon-separated list of times
15093 after which to send warning messages. If the value of the option is an empty
15094 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15095 message has been in the queue for longer than the last time, the last interval
15096 between the times is used to compute subsequent warning times. For example,
15097 with
15098 .code
15099 delay_warning = 4h:8h:24h
15100 .endd
15101 the first message is sent after 4 hours, the second after 8 hours, and
15102 the third one after 24 hours. After that, messages are sent every 16 hours,
15103 because that is the interval between the last two times on the list. If you set
15104 just one time, it specifies the repeat interval. For example, with:
15105 .code
15106 delay_warning = 6h
15107 .endd
15108 messages are repeated every six hours. To stop warnings after a given time, set
15109 a very large time at the end of the list. For example:
15110 .code
15111 delay_warning = 2h:12h:99d
15112 .endd
15113 Note that the option is only evaluated at the time a delivery attempt fails,
15114 which depends on retry and queue-runner configuration.
15115 Typically retries will be configured more frequently than warning messages.
15116
15117 .option delay_warning_condition main string&!! "see below"
15118 .vindex "&$domain$&"
15119 The string is expanded at the time a warning message might be sent. If all the
15120 deferred addresses have the same domain, it is set in &$domain$& during the
15121 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15122 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15123 &"false"& (the comparison being done caselessly) then the warning message is
15124 not sent. The default is:
15125 .code
15126 delay_warning_condition = ${if or {\
15127   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15128   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15129   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15130   } {no}{yes}}
15131 .endd
15132 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15133 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15134 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15135 &"auto-replied"& in an &'Auto-Submitted:'& header.
15136
15137 .option deliver_drop_privilege main boolean false
15138 .cindex "unprivileged delivery"
15139 .cindex "delivery" "unprivileged"
15140 If this option is set true, Exim drops its root privilege at the start of a
15141 delivery process, and runs as the Exim user throughout. This severely restricts
15142 the kinds of local delivery that are possible, but is viable in certain types
15143 of configuration. There is a discussion about the use of root privilege in
15144 chapter &<<CHAPsecurity>>&.
15145
15146 .option deliver_queue_load_max main fixed-point unset
15147 .cindex "load average"
15148 .cindex "queue runner" "abandoning"
15149 When this option is set, a queue run is abandoned if the system load average
15150 becomes greater than the value of the option. The option has no effect on
15151 ancient operating systems on which Exim cannot determine the load average.
15152 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15153
15154
15155 .option delivery_date_remove main boolean true
15156 .cindex "&'Delivery-date:'& header line"
15157 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15158 message when it is delivered, in exactly the same way as &'Return-path:'& is
15159 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15160 should not be present in incoming messages, and this option causes them to be
15161 removed at the time the message is received, to avoid any problems that might
15162 occur when a delivered message is subsequently sent on to some other recipient.
15163
15164 .option disable_fsync main boolean false
15165 .cindex "&[fsync()]&, disabling"
15166 This option is available only if Exim was built with the compile-time option
15167 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15168 a runtime configuration generates an &"unknown option"& error. You should not
15169 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15170 really, really, really understand what you are doing. &'No pre-compiled
15171 distributions of Exim should ever make this option available.'&
15172
15173 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15174 updated files' data to be written to disc before continuing. Unexpected events
15175 such as crashes and power outages may cause data to be lost or scrambled.
15176 Here be Dragons. &*Beware.*&
15177
15178
15179 .option disable_ipv6 main boolean false
15180 .cindex "IPv6" "disabling"
15181 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15182 activities take place. AAAA records are never looked up, and any IPv6 addresses
15183 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15184 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15185 to handle IPv6 literal addresses.
15186
15187
15188 .new
15189 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15190 .cindex DKIM "selecting signature algorithms"
15191 This option gives a list of hash types which are acceptable in signatures,
15192 .wen
15193 and an order of processing.
15194 Signatures with algorithms not in the list will be ignored.
15195
15196 Acceptable values include:
15197 .code
15198 sha1
15199 sha256
15200 sha512
15201 .endd
15202
15203 Note that the acceptance of sha1 violates RFC 8301.
15204
15205 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15206 This option gives a list of key types which are acceptable in signatures,
15207 and an order of processing.
15208 Signatures with algorithms not in the list will be ignored.
15209
15210 .option dkim_verify_minimal main boolean false
15211 If set to true, verification of signatures will terminate after the
15212 first success.
15213
15214 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15215 .cindex DKIM "controlling calls to the ACL"
15216 This option gives a list of DKIM domains for which the DKIM ACL is run.
15217 It is expanded after the message is received; by default it runs
15218 the ACL once for each signature in the message.
15219 See section &<<SECDKIMVFY>>&.
15220
15221
15222 .option dns_again_means_nonexist main "domain list&!!" unset
15223 .cindex "DNS" "&""try again""& response; overriding"
15224 DNS lookups give a &"try again"& response for the DNS errors
15225 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15226 keep trying to deliver a message, or to give repeated temporary errors to
15227 incoming mail. Sometimes the effect is caused by a badly set up name server and
15228 may persist for a long time. If a domain which exhibits this problem matches
15229 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15230 This option should be used with care. You can make it apply to reverse lookups
15231 by a setting such as this:
15232 .code
15233 dns_again_means_nonexist = *.in-addr.arpa
15234 .endd
15235 This option applies to all DNS lookups that Exim does. It also applies when the
15236 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15237 since these are most likely to be caused by DNS lookup problems. The
15238 &(dnslookup)& router has some options of its own for controlling what happens
15239 when lookups for MX or SRV records give temporary errors. These more specific
15240 options are applied after this global option.
15241
15242 .option dns_check_names_pattern main string "see below"
15243 .cindex "DNS" "pre-check of name syntax"
15244 When this option is set to a non-empty string, it causes Exim to check domain
15245 names for characters that are not allowed in host names before handing them to
15246 the DNS resolver, because some resolvers give temporary errors for names that
15247 contain unusual characters. If a domain name contains any unwanted characters,
15248 a &"not found"& result is forced, and the resolver is not called. The check is
15249 done by matching the domain name against a regular expression, which is the
15250 value of this option. The default pattern is
15251 .code
15252 dns_check_names_pattern = \
15253   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15254 .endd
15255 which permits only letters, digits, slashes, and hyphens in components, but
15256 they must start and end with a letter or digit. Slashes are not, in fact,
15257 permitted in host names, but they are found in certain NS records (which can be
15258 accessed in Exim by using a &%dnsdb%& lookup). If you set
15259 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15260 empty string.
15261
15262 .option dns_csa_search_limit main integer 5
15263 This option controls the depth of parental searching for CSA SRV records in the
15264 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15265
15266 .option dns_csa_use_reverse main boolean true
15267 This option controls whether or not an IP address, given as a CSA domain, is
15268 reversed and looked up in the reverse DNS, as described in more detail in
15269 section &<<SECTverifyCSA>>&.
15270
15271 .option dns_cname_loops main integer 1
15272 .cindex DNS "CNAME following"
15273 This option controls the following of CNAME chains, needed if the resolver does
15274 not do it internally.
15275 As of 2018 most should, and the default can be left.
15276 If you have an ancient one, a value of 10 is likely needed.
15277
15278 The default value of one CNAME-follow is needed
15279 thanks to the observed return for an MX request,
15280 given no MX presence but a CNAME to an A, of the CNAME.
15281
15282
15283 .option dns_dnssec_ok main integer -1
15284 .cindex "DNS" "resolver options"
15285 .cindex "DNS" "DNSSEC"
15286 If this option is set to a non-negative number then Exim will initialise the
15287 DNS resolver library to either use or not use DNSSEC, overriding the system
15288 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15289
15290 If the resolver library does not support DNSSEC then this option has no effect.
15291
15292
15293 .option dns_ipv4_lookup main "domain list&!!" unset
15294 .cindex "IPv6" "DNS lookup for AAAA records"
15295 .cindex "DNS" "IPv6 lookup for AAAA records"
15296 .cindex DNS "IPv6 disabling"
15297 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15298 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15299 (A records) when trying to find IP addresses for hosts, unless the host's
15300 domain matches this list.
15301
15302 This is a fudge to help with name servers that give big delays or otherwise do
15303 not work for the AAAA record type. In due course, when the world's name
15304 servers have all been upgraded, there should be no need for this option.
15305 Note that all lookups, including those done for verification, are affected;
15306 this will result in verify failure for IPv6 connections or ones using names
15307 only valid for IPv6 addresses.
15308
15309
15310 .option dns_retrans main time 0s
15311 .cindex "DNS" "resolver options"
15312 .cindex timeout "dns lookup"
15313 .cindex "DNS" timeout
15314 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15315 retransmission and retry parameters for DNS lookups. Values of zero (the
15316 defaults) leave the system default settings unchanged. The first value is the
15317 time between retries, and the second is the number of retries. It isn't
15318 totally clear exactly how these settings affect the total time a DNS lookup may
15319 take. I haven't found any documentation about timeouts on DNS lookups; these
15320 parameter values are available in the external resolver interface structure,
15321 but nowhere does it seem to describe how they are used or what you might want
15322 to set in them.
15323 See also the &%slow_lookup_log%& option.
15324
15325
15326 .option dns_retry main integer 0
15327 See &%dns_retrans%& above.
15328
15329
15330 .option dns_trust_aa main "domain list&!!" unset
15331 .cindex "DNS" "resolver options"
15332 .cindex "DNS" "DNSSEC"
15333 If this option is set then lookup results marked with the AA bit
15334 (Authoritative Answer) are trusted the same way as if they were
15335 DNSSEC-verified. The authority section's name of the answer must
15336 match with this expanded domain list.
15337
15338 Use this option only if you talk directly to a resolver that is
15339 authoritative for some zones and does not set the AD (Authentic Data)
15340 bit in the answer. Some DNS servers may have an configuration option to
15341 mark the answers from their own zones as verified (they set the AD bit).
15342 Others do not have this option. It is considered as poor practice using
15343 a resolver that is an authoritative server for some zones.
15344
15345 Use this option only if you really have to (e.g. if you want
15346 to use DANE for remote delivery to a server that is listed in the DNS
15347 zones that your resolver is authoritative for).
15348
15349 If the DNS answer packet has the AA bit set and contains resource record
15350 in the answer section, the name of the first NS record appearing in the
15351 authority section is compared against the list. If the answer packet is
15352 authoritative but the answer section is empty, the name of the first SOA
15353 record in the authoritative section is used instead.
15354
15355 .cindex "DNS" "resolver options"
15356 .option dns_use_edns0 main integer -1
15357 .cindex "DNS" "resolver options"
15358 .cindex "DNS" "EDNS0"
15359 .cindex "DNS" "OpenBSD
15360 If this option is set to a non-negative number then Exim will initialise the
15361 DNS resolver library to either use or not use EDNS0 extensions, overriding
15362 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15363 on.
15364
15365 If the resolver library does not support EDNS0 then this option has no effect.
15366
15367 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15368 means that DNSSEC will not work with Exim on that platform either, unless Exim
15369 is linked against an alternative DNS client library.
15370
15371
15372 .option drop_cr main boolean false
15373 This is an obsolete option that is now a no-op. It used to affect the way Exim
15374 handled CR and LF characters in incoming messages. What happens now is
15375 described in section &<<SECTlineendings>>&.
15376
15377 .option dsn_advertise_hosts main "host list&!!" unset
15378 .cindex "bounce messages" "success"
15379 .cindex "DSN" "success"
15380 .cindex "Delivery Status Notification" "success"
15381 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15382 and accepted from, these hosts.
15383 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15384 and RET and ORCPT options on MAIL FROM commands.
15385 A NOTIFY=SUCCESS option requests success-DSN messages.
15386 A NOTIFY= option with no argument requests that no delay or failure DSNs
15387 are sent.
15388
15389 .option dsn_from main "string&!!" "see below"
15390 .cindex "&'From:'& header line" "in bounces"
15391 .cindex "bounce messages" "&'From:'& line, specifying"
15392 This option can be used to vary the contents of &'From:'& header lines in
15393 bounces and other automatically generated messages (&"Delivery Status
15394 Notifications"& &-- hence the name of the option). The default setting is:
15395 .code
15396 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15397 .endd
15398 The value is expanded every time it is needed. If the expansion fails, a
15399 panic is logged, and the default value is used.
15400
15401 .option envelope_to_remove main boolean true
15402 .cindex "&'Envelope-to:'& header line"
15403 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15404 message when it is delivered, in exactly the same way as &'Return-path:'& is
15405 handled. &'Envelope-to:'& records the original recipient address from the
15406 message's envelope that caused the delivery to happen. Such headers should not
15407 be present in incoming messages, and this option causes them to be removed at
15408 the time the message is received, to avoid any problems that might occur when a
15409 delivered message is subsequently sent on to some other recipient.
15410
15411
15412 .option errors_copy main "string list&!!" unset
15413 .cindex "bounce message" "copy to other address"
15414 .cindex "copy of bounce message"
15415 Setting this option causes Exim to send bcc copies of bounce messages that it
15416 generates to other addresses. &*Note*&: This does not apply to bounce messages
15417 coming from elsewhere. The value of the option is a colon-separated list of
15418 items. Each item consists of a pattern, terminated by white space, followed by
15419 a comma-separated list of email addresses. If a pattern contains spaces, it
15420 must be enclosed in double quotes.
15421
15422 Each pattern is processed in the same way as a single item in an address list
15423 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15424 the bounce message, the message is copied to the addresses on the list. The
15425 items are scanned in order, and once a matching one is found, no further items
15426 are examined. For example:
15427 .code
15428 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15429               rqps@mydomain   hostmaster@mydomain.example,\
15430                               postmaster@mydomain.example
15431 .endd
15432 .vindex "&$domain$&"
15433 .vindex "&$local_part$&"
15434 The address list is expanded before use. The expansion variables &$local_part$&
15435 and &$domain$& are set from the original recipient of the error message, and if
15436 there was any wildcard matching in the pattern, the expansion
15437 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15438 variables &$0$&, &$1$&, etc. are set in the normal way.
15439
15440
15441 .option errors_reply_to main string unset
15442 .cindex "bounce message" "&'Reply-to:'& in"
15443 By default, Exim's bounce and delivery warning messages contain the header line
15444 .display
15445 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15446 .endd
15447 .oindex &%quota_warn_message%&
15448 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15449 A warning message that is generated by the &%quota_warn_message%& option in an
15450 &(appendfile)& transport may contain its own &'From:'& header line that
15451 overrides the default.
15452
15453 Experience shows that people reply to bounce messages. If the
15454 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15455 and warning messages. For example:
15456 .code
15457 errors_reply_to = postmaster@my.domain.example
15458 .endd
15459 The value of the option is not expanded. It must specify a valid RFC 2822
15460 address. However, if a warning message that is generated by the
15461 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15462 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15463 not used.
15464
15465
15466 .option event_action main string&!! unset
15467 .cindex events
15468 This option declares a string to be expanded for Exim's events mechanism.
15469 For details see chapter &<<CHAPevents>>&.
15470
15471
15472 .option exim_group main string "compile-time configured"
15473 .cindex "gid (group id)" "Exim's own"
15474 .cindex "Exim group"
15475 This option changes the gid under which Exim runs when it gives up root
15476 privilege. The default value is compiled into the binary. The value of this
15477 option is used only when &%exim_user%& is also set. Unless it consists entirely
15478 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15479 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15480 security issues.
15481
15482
15483 .option exim_path main string "see below"
15484 .cindex "Exim binary, path name"
15485 This option specifies the path name of the Exim binary, which is used when Exim
15486 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15487 the directory configured at compile time by the BIN_DIRECTORY setting. It
15488 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15489 other place.
15490 &*Warning*&: Do not use a macro to define the value of this option, because
15491 you will break those Exim utilities that scan the configuration file to find
15492 where the binary is. (They then use the &%-bP%& option to extract option
15493 settings such as the value of &%spool_directory%&.)
15494
15495
15496 .option exim_user main string "compile-time configured"
15497 .cindex "uid (user id)" "Exim's own"
15498 .cindex "Exim user"
15499 This option changes the uid under which Exim runs when it gives up root
15500 privilege. The default value is compiled into the binary. Ownership of the run
15501 time configuration file and the use of the &%-C%& and &%-D%& command line
15502 options is checked against the values in the binary, not what is set here.
15503
15504 Unless it consists entirely of digits, the string is looked up using
15505 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15506 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15507 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15508
15509
15510 .option exim_version main string "current version"
15511 .cindex "Exim version"
15512 .cindex customizing "version number"
15513 .cindex "version number of Exim" override
15514 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15515 various places.  Use with care; this may fool stupid security scanners.
15516
15517
15518 .option extra_local_interfaces main "string list" unset
15519 This option defines network interfaces that are to be considered local when
15520 routing, but which are not used for listening by the daemon. See section
15521 &<<SECTreclocipadd>>& for details.
15522
15523
15524 . Allow this long option name to split; give it unsplit as a fifth argument
15525 . for the automatic .oindex that is generated by .option.
15526
15527 .option "extract_addresses_remove_arguments" main boolean true &&&
15528          extract_addresses_remove_arguments
15529 .oindex "&%-t%&"
15530 .cindex "command line" "addresses with &%-t%&"
15531 .cindex "Sendmail compatibility" "&%-t%& option"
15532 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15533 are present on the command line when the &%-t%& option is used to build an
15534 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15535 line addresses are removed from the recipients list. This is also how Smail
15536 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15537 command line addresses are added to those obtained from the header lines. When
15538 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15539 argument headers. If it is set false, Exim adds rather than removes argument
15540 addresses.
15541
15542
15543 .option finduser_retries main integer 0
15544 .cindex "NIS, retrying user lookups"
15545 On systems running NIS or other schemes in which user and group information is
15546 distributed from a remote system, there can be times when &[getpwnam()]& and
15547 related functions fail, even when given valid data, because things time out.
15548 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15549 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15550 many extra times to find a user or a group, waiting for one second between
15551 retries.
15552
15553 .cindex "&_/etc/passwd_&" "multiple reading of"
15554 You should not set this option greater than zero if your user information is in
15555 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15556 search the file multiple times for non-existent users, and also cause delay.
15557
15558
15559
15560 .option freeze_tell main "string list, comma separated" unset
15561 .cindex "freezing messages" "sending a message when freezing"
15562 On encountering certain errors, or when configured to do so in a system filter,
15563 ACL, or special router, Exim freezes a message. This means that no further
15564 delivery attempts take place until an administrator thaws the message, or the
15565 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15566 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15567 warning message whenever it freezes something, unless the message it is
15568 freezing is a locally-generated bounce message. (Without this exception there
15569 is the possibility of looping.) The warning message is sent to the addresses
15570 supplied as the comma-separated value of this option. If several of the
15571 message's addresses cause freezing, only a single message is sent. If the
15572 freezing was automatic, the reason(s) for freezing can be found in the message
15573 log. If you configure freezing in a filter or ACL, you must arrange for any
15574 logging that you require.
15575
15576
15577 .option gecos_name main string&!! unset
15578 .cindex "HP-UX"
15579 .cindex "&""gecos""& field, parsing"
15580 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15581 password file to hold other information in addition to users' real names. Exim
15582 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15583 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15584 of the field are used unchanged, except that, if an ampersand is encountered,
15585 it is replaced by the user's login name with the first character forced to
15586 upper case, since this is a convention that is observed on many systems.
15587
15588 When these options are set, &%gecos_pattern%& is treated as a regular
15589 expression that is to be applied to the field (again with && replaced by the
15590 login name), and if it matches, &%gecos_name%& is expanded and used as the
15591 user's name.
15592
15593 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15594 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15595 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15596 name terminates at the first comma, the following can be used:
15597 .code
15598 gecos_pattern = ([^,]*)
15599 gecos_name = $1
15600 .endd
15601
15602 .option gecos_pattern main string unset
15603 See &%gecos_name%& above.
15604
15605
15606 .option gnutls_compat_mode main boolean unset
15607 This option controls whether GnuTLS is used in compatibility mode in an Exim
15608 server. This reduces security slightly, but improves interworking with older
15609 implementations of TLS.
15610
15611
15612 .option gnutls_allow_auto_pkcs11 main boolean unset
15613 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15614 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15615
15616 See
15617 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15618 for documentation.
15619
15620
15621
15622 .option headers_charset main string "see below"
15623 This option sets a default character set for translating from encoded MIME
15624 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15625 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15626 ultimate default is ISO-8859-1. For more details see the description of header
15627 insertions in section &<<SECTexpansionitems>>&.
15628
15629
15630
15631 .option header_maxsize main integer "see below"
15632 .cindex "header section" "maximum size of"
15633 .cindex "limit" "size of message header section"
15634 This option controls the overall maximum size of a message's header
15635 section. The default is the value of HEADER_MAXSIZE in
15636 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15637 sections are rejected.
15638
15639
15640 .option header_line_maxsize main integer 0
15641 .cindex "header lines" "maximum size of"
15642 .cindex "limit" "size of one header line"
15643 This option limits the length of any individual header line in a message, after
15644 all the continuations have been joined together. Messages with individual
15645 header lines that are longer than the limit are rejected. The default value of
15646 zero means &"no limit"&.
15647
15648
15649
15650
15651 .option helo_accept_junk_hosts main "host list&!!" unset
15652 .cindex "HELO" "accepting junk data"
15653 .cindex "EHLO" "accepting junk data"
15654 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15655 mail, and gives an error response for invalid data. Unfortunately, there are
15656 some SMTP clients that send syntactic junk. They can be accommodated by setting
15657 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15658 if you want to do semantic checking.
15659 See also &%helo_allow_chars%& for a way of extending the permitted character
15660 set.
15661
15662
15663 .option helo_allow_chars main string unset
15664 .cindex "HELO" "underscores in"
15665 .cindex "EHLO" "underscores in"
15666 .cindex "underscore in EHLO/HELO"
15667 This option can be set to a string of rogue characters that are permitted in
15668 all EHLO and HELO names in addition to the standard letters, digits,
15669 hyphens, and dots. If you really must allow underscores, you can set
15670 .code
15671 helo_allow_chars = _
15672 .endd
15673 Note that the value is one string, not a list.
15674
15675
15676 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15677 .cindex "HELO" "forcing reverse lookup"
15678 .cindex "EHLO" "forcing reverse lookup"
15679 If the domain given by a client in a HELO or EHLO command matches this
15680 list, a reverse lookup is done in order to establish the host's true name. The
15681 default forces a lookup if the client host gives the server's name or any of
15682 its IP addresses (in brackets), something that broken clients have been seen to
15683 do.
15684
15685
15686 .option helo_try_verify_hosts main "host list&!!" unset
15687 .cindex "HELO verifying" "optional"
15688 .cindex "EHLO" "verifying, optional"
15689 By default, Exim just checks the syntax of HELO and EHLO commands (see
15690 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15691 to do more extensive checking of the data supplied by these commands. The ACL
15692 condition &`verify = helo`& is provided to make this possible.
15693 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15694 to force the check to occur. From release 4.53 onwards, this is no longer
15695 necessary. If the check has not been done before &`verify = helo`& is
15696 encountered, it is done at that time. Consequently, this option is obsolete.
15697 Its specification is retained here for backwards compatibility.
15698
15699 When an EHLO or HELO command is received, if the calling host matches
15700 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15701 EHLO command either:
15702
15703 .ilist
15704 is an IP literal matching the calling address of the host, or
15705 .next
15706 .cindex "DNS" "reverse lookup"
15707 .cindex "reverse DNS lookup"
15708 matches the host name that Exim obtains by doing a reverse lookup of the
15709 calling host address, or
15710 .next
15711 when looked up in DNS yields the calling host address.
15712 .endlist
15713
15714 However, the EHLO or HELO command is not rejected if any of the checks
15715 fail. Processing continues, but the result of the check is remembered, and can
15716 be detected later in an ACL by the &`verify = helo`& condition.
15717
15718 If DNS was used for successful verification, the variable
15719 .cindex "DNS" "DNSSEC"
15720 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15721
15722 .option helo_verify_hosts main "host list&!!" unset
15723 .cindex "HELO verifying" "mandatory"
15724 .cindex "EHLO" "verifying, mandatory"
15725 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15726 backwards compatibility. For hosts that match this option, Exim checks the host
15727 name given in the HELO or EHLO in the same way as for
15728 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15729 rejected with a 550 error, and entries are written to the main and reject logs.
15730 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15731 error.
15732
15733 .option hold_domains main "domain list&!!" unset
15734 .cindex "domain" "delaying delivery"
15735 .cindex "delivery" "delaying certain domains"
15736 This option allows mail for particular domains to be held in the queue
15737 manually. The option is overridden if a message delivery is forced with the
15738 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15739 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15740 item in &%hold_domains%&, no routing or delivery for that address is done, and
15741 it is deferred every time the message is looked at.
15742
15743 This option is intended as a temporary operational measure for delaying the
15744 delivery of mail while some problem is being sorted out, or some new
15745 configuration tested. If you just want to delay the processing of some
15746 domains until a queue run occurs, you should use &%queue_domains%& or
15747 &%queue_smtp_domains%&, not &%hold_domains%&.
15748
15749 A setting of &%hold_domains%& does not override Exim's code for removing
15750 messages from the queue if they have been there longer than the longest retry
15751 time in any retry rule. If you want to hold messages for longer than the normal
15752 retry times, insert a dummy retry rule with a long retry time.
15753
15754
15755 .option host_lookup main "host list&!!" unset
15756 .cindex "host name" "lookup, forcing"
15757 Exim does not look up the name of a calling host from its IP address unless it
15758 is required to compare against some host list, or the host matches
15759 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15760 option (which normally contains IP addresses rather than host names). The
15761 default configuration file contains
15762 .code
15763 host_lookup = *
15764 .endd
15765 which causes a lookup to happen for all hosts. If the expense of these lookups
15766 is felt to be too great, the setting can be changed or removed.
15767
15768 After a successful reverse lookup, Exim does a forward lookup on the name it
15769 has obtained, to verify that it yields the IP address that it started with. If
15770 this check fails, Exim behaves as if the name lookup failed.
15771
15772 .vindex "&$host_lookup_failed$&"
15773 .vindex "&$sender_host_name$&"
15774 After any kind of failure, the host name (in &$sender_host_name$&) remains
15775 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15776 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15777 &`verify = reverse_host_lookup`& in ACLs.
15778
15779
15780 .option host_lookup_order main "string list" &`bydns:byaddr`&
15781 This option specifies the order of different lookup methods when Exim is trying
15782 to find a host name from an IP address. The default is to do a DNS lookup
15783 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15784 if that fails. You can change the order of these lookups, or omit one entirely,
15785 if you want.
15786
15787 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15788 multiple PTR records in the DNS and the IP address is not listed in
15789 &_/etc/hosts_&. Different operating systems give different results in this
15790 case. That is why the default tries a DNS lookup first.
15791
15792
15793
15794 .option host_reject_connection main "host list&!!" unset
15795 .cindex "host" "rejecting connections from"
15796 If this option is set, incoming SMTP calls from the hosts listed are rejected
15797 as soon as the connection is made.
15798 This option is obsolete, and retained only for backward compatibility, because
15799 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15800 connections immediately.
15801
15802 The ability to give an immediate rejection (either by this option or using an
15803 ACL) is provided for use in unusual cases. Many hosts will just try again,
15804 sometimes without much delay. Normally, it is better to use an ACL to reject
15805 incoming messages at a later stage, such as after RCPT commands. See
15806 chapter &<<CHAPACL>>&.
15807
15808
15809 .option hosts_connection_nolog main "host list&!!" unset
15810 .cindex "host" "not logging connections from"
15811 This option defines a list of hosts for which connection logging does not
15812 happen, even though the &%smtp_connection%& log selector is set. For example,
15813 you might want not to log SMTP connections from local processes, or from
15814 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15815 the daemon; you should therefore strive to restrict its value to a short inline
15816 list of IP addresses and networks. To disable logging SMTP connections from
15817 local processes, you must create a host list with an empty item. For example:
15818 .code
15819 hosts_connection_nolog = :
15820 .endd
15821 If the &%smtp_connection%& log selector is not set, this option has no effect.
15822
15823
15824
15825 .option hosts_proxy main "host list&!!" unset
15826 .cindex proxy "proxy protocol"
15827 This option enables use of Proxy Protocol proxies for incoming
15828 connections.  For details see section &<<SECTproxyInbound>>&.
15829
15830
15831 .option hosts_treat_as_local main "domain list&!!" unset
15832 .cindex "local host" "domains treated as"
15833 .cindex "host" "treated as local"
15834 If this option is set, any host names that match the domain list are treated as
15835 if they were the local host when Exim is scanning host lists obtained from MX
15836 records
15837 or other sources. Note that the value of this option is a domain list, not a
15838 host list, because it is always used to check host names, not IP addresses.
15839
15840 This option also applies when Exim is matching the special items
15841 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15842 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15843 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15844 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15845 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15846 interfaces and recognizing the local host.
15847
15848
15849 .option ibase_servers main "string list" unset
15850 .cindex "InterBase" "server list"
15851 This option provides a list of InterBase servers and associated connection data,
15852 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15853 The option is available only if Exim has been built with InterBase support.
15854
15855
15856
15857 .option ignore_bounce_errors_after main time 10w
15858 .cindex "bounce message" "discarding"
15859 .cindex "discarding bounce message"
15860 This option affects the processing of bounce messages that cannot be delivered,
15861 that is, those that suffer a permanent delivery failure. (Bounce messages that
15862 suffer temporary delivery failures are of course retried in the usual way.)
15863
15864 After a permanent delivery failure, bounce messages are frozen,
15865 because there is no sender to whom they can be returned. When a frozen bounce
15866 message has been in the queue for more than the given time, it is unfrozen at
15867 the next queue run, and a further delivery is attempted. If delivery fails
15868 again, the bounce message is discarded. This makes it possible to keep failed
15869 bounce messages around for a shorter time than the normal maximum retry time
15870 for frozen messages. For example,
15871 .code
15872 ignore_bounce_errors_after = 12h
15873 .endd
15874 retries failed bounce message deliveries after 12 hours, discarding any further
15875 failures. If the value of this option is set to a zero time period, bounce
15876 failures are discarded immediately. Setting a very long time (as in the default
15877 value) has the effect of disabling this option. For ways of automatically
15878 dealing with other kinds of frozen message, see &%auto_thaw%& and
15879 &%timeout_frozen_after%&.
15880
15881
15882 .option ignore_fromline_hosts main "host list&!!" unset
15883 .cindex "&""From""& line"
15884 .cindex "UUCP" "&""From""& line"
15885 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15886 the headers of a message. By default this is treated as the start of the
15887 message's body, which means that any following headers are not recognized as
15888 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15889 match those hosts that insist on sending it. If the sender is actually a local
15890 process rather than a remote host, and is using &%-bs%& to inject the messages,
15891 &%ignore_fromline_local%& must be set to achieve this effect.
15892
15893
15894 .option ignore_fromline_local main boolean false
15895 See &%ignore_fromline_hosts%& above.
15896
15897 .option keep_environment main "string list" unset
15898 .cindex "environment" "values from"
15899 This option contains a string list of environment variables to keep.
15900 You have to trust these variables or you have to be sure that
15901 these variables do not impose any security risk. Keep in mind that
15902 during the startup phase Exim is running with an effective UID 0 in most
15903 installations. As the default value is an empty list, the default
15904 environment for using libraries, running embedded Perl code, or running
15905 external binaries is empty, and does not not even contain PATH or HOME.
15906
15907 Actually the list is interpreted as a list of patterns
15908 (&<<SECTlistexpand>>&), except that it is not expanded first.
15909
15910 WARNING: Macro substitution is still done first, so having a macro
15911 FOO and having FOO_HOME in your &%keep_environment%& option may have
15912 unexpected results. You may work around this using a regular expression
15913 that does not match the macro name: ^[F]OO_HOME$.
15914
15915 Current versions of Exim issue a warning during startup if you do not mention
15916 &%keep_environment%& in your runtime configuration file and if your
15917 current environment is not empty. Future versions may not issue that warning
15918 anymore.
15919
15920 See the &%add_environment%& main config option for a way to set
15921 environment variables to a fixed value.  The environment for &(pipe)&
15922 transports is handled separately, see section &<<SECTpipeenv>>& for
15923 details.
15924
15925
15926 .option keep_malformed main time 4d
15927 This option specifies the length of time to keep messages whose spool files
15928 have been corrupted in some way. This should, of course, never happen. At the
15929 next attempt to deliver such a message, it gets removed. The incident is
15930 logged.
15931
15932
15933 .option ldap_ca_cert_dir main string unset
15934 .cindex "LDAP", "TLS CA certificate directory"
15935 .cindex certificate "directory for LDAP"
15936 This option indicates which directory contains CA certificates for verifying
15937 a TLS certificate presented by an LDAP server.
15938 While Exim does not provide a default value, your SSL library may.
15939 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15940 and constrained to be a directory.
15941
15942
15943 .option ldap_ca_cert_file main string unset
15944 .cindex "LDAP", "TLS CA certificate file"
15945 .cindex certificate "file for LDAP"
15946 This option indicates which file contains CA certificates for verifying
15947 a TLS certificate presented by an LDAP server.
15948 While Exim does not provide a default value, your SSL library may.
15949 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15950 and constrained to be a file.
15951
15952
15953 .option ldap_cert_file main string unset
15954 .cindex "LDAP" "TLS client certificate file"
15955 .cindex certificate "file for LDAP"
15956 This option indicates which file contains an TLS client certificate which
15957 Exim should present to the LDAP server during TLS negotiation.
15958 Should be used together with &%ldap_cert_key%&.
15959
15960
15961 .option ldap_cert_key main string unset
15962 .cindex "LDAP" "TLS client key file"
15963 .cindex certificate "key for LDAP"
15964 This option indicates which file contains the secret/private key to use
15965 to prove identity to the LDAP server during TLS negotiation.
15966 Should be used together with &%ldap_cert_file%&, which contains the
15967 identity to be proven.
15968
15969
15970 .option ldap_cipher_suite main string unset
15971 .cindex "LDAP" "TLS cipher suite"
15972 This controls the TLS cipher-suite negotiation during TLS negotiation with
15973 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15974 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15975
15976
15977 .option ldap_default_servers main "string list" unset
15978 .cindex "LDAP" "default servers"
15979 This option provides a list of LDAP servers which are tried in turn when an
15980 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15981 details of LDAP queries. This option is available only when Exim has been built
15982 with LDAP support.
15983
15984
15985 .option ldap_require_cert main string unset.
15986 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15987 This should be one of the values "hard", "demand", "allow", "try" or "never".
15988 A value other than one of these is interpreted as "never".
15989 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15990 Although Exim does not set a default, the LDAP library probably defaults
15991 to hard/demand.
15992
15993
15994 .option ldap_start_tls main boolean false
15995 .cindex "LDAP" "whether or not to negotiate TLS"
15996 If set, Exim will attempt to negotiate TLS with the LDAP server when
15997 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15998 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15999 of SSL-on-connect.
16000 In the event of failure to negotiate TLS, the action taken is controlled
16001 by &%ldap_require_cert%&.
16002 This option is ignored for &`ldapi`& connections.
16003
16004
16005 .option ldap_version main integer unset
16006 .cindex "LDAP" "protocol version, forcing"
16007 This option can be used to force Exim to set a specific protocol version for
16008 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16009 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16010 the LDAP headers; otherwise it is 2. This option is available only when Exim
16011 has been built with LDAP support.
16012
16013
16014
16015 .option local_from_check main boolean true
16016 .cindex "&'Sender:'& header line" "disabling addition of"
16017 .cindex "&'From:'& header line" "disabling checking of"
16018 When a message is submitted locally (that is, not over a TCP/IP connection) by
16019 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16020 checks that the &'From:'& header line matches the login of the calling user and
16021 the domain specified by &%qualify_domain%&.
16022
16023 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16024 locally submitted message is automatically qualified by Exim, unless the
16025 &%-bnq%& command line option is used.
16026
16027 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16028 on the local part. If the &'From:'& header line does not match, Exim adds a
16029 &'Sender:'& header with an address constructed from the calling user's login
16030 and the default qualify domain.
16031
16032 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16033 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16034 &'Sender:'& header lines supplied by untrusted users, you must also set
16035 &%local_sender_retain%& to be true.
16036
16037 .cindex "envelope from"
16038 .cindex "envelope sender"
16039 These options affect only the header lines in the message. The envelope sender
16040 is still forced to be the login id at the qualify domain unless
16041 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16042
16043 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16044 request similar header line checking. See section &<<SECTthesenhea>>&, which
16045 has more details about &'Sender:'& processing.
16046
16047
16048
16049
16050 .option local_from_prefix main string unset
16051 When Exim checks the &'From:'& header line of locally submitted messages for
16052 matching the login id (see &%local_from_check%& above), it can be configured to
16053 ignore certain prefixes and suffixes in the local part of the address. This is
16054 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16055 appropriate lists, in the same form as the &%local_part_prefix%& and
16056 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16057 example, if
16058 .code
16059 local_from_prefix = *-
16060 .endd
16061 is set, a &'From:'& line containing
16062 .code
16063 From: anything-user@your.domain.example
16064 .endd
16065 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16066 matches the actual sender address that is constructed from the login name and
16067 qualify domain.
16068
16069
16070 .option local_from_suffix main string unset
16071 See &%local_from_prefix%& above.
16072
16073
16074 .option local_interfaces main "string list" "see below"
16075 This option controls which network interfaces are used by the daemon for
16076 listening; they are also used to identify the local host when routing. Chapter
16077 &<<CHAPinterfaces>>& contains a full description of this option and the related
16078 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16079 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16080 &%local_interfaces%& is
16081 .code
16082 local_interfaces = 0.0.0.0
16083 .endd
16084 when Exim is built without IPv6 support; otherwise it is
16085 .code
16086 local_interfaces = <; ::0 ; 0.0.0.0
16087 .endd
16088
16089 .option local_scan_timeout main time 5m
16090 .cindex "timeout" "for &[local_scan()]& function"
16091 .cindex "&[local_scan()]& function" "timeout"
16092 This timeout applies to the &[local_scan()]& function (see chapter
16093 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16094 the incoming message is rejected with a temporary error if it is an SMTP
16095 message. For a non-SMTP message, the message is dropped and Exim ends with a
16096 non-zero code. The incident is logged on the main and reject logs.
16097
16098
16099
16100 .option local_sender_retain main boolean false
16101 .cindex "&'Sender:'& header line" "retaining from local submission"
16102 When a message is submitted locally (that is, not over a TCP/IP connection) by
16103 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16104 do not want this to happen, you must set &%local_sender_retain%&, and you must
16105 also set &%local_from_check%& to be false (Exim will complain if you do not).
16106 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16107 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16108
16109
16110
16111
16112 .option localhost_number main string&!! unset
16113 .cindex "host" "locally unique number for"
16114 .cindex "message ids" "with multiple hosts"
16115 .vindex "&$localhost_number$&"
16116 Exim's message ids are normally unique only within the local host. If
16117 uniqueness among a set of hosts is required, each host must set a different
16118 value for the &%localhost_number%& option. The string is expanded immediately
16119 after reading the configuration file (so that a number can be computed from the
16120 host name, for example) and the result of the expansion must be a number in the
16121 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16122 systems). This is available in subsequent string expansions via the variable
16123 &$localhost_number$&. When &%localhost_number is set%&, the final two
16124 characters of the message id, instead of just being a fractional part of the
16125 time, are computed from the time and the local host number as described in
16126 section &<<SECTmessiden>>&.
16127
16128
16129
16130 .option log_file_path main "string list&!!" "set at compile time"
16131 .cindex "log" "file path for"
16132 This option sets the path which is used to determine the names of Exim's log
16133 files, or indicates that logging is to be to syslog, or both. It is expanded
16134 when Exim is entered, so it can, for example, contain a reference to the host
16135 name. If no specific path is set for the log files at compile or runtime,
16136 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16137 they are written in a sub-directory called &_log_& in Exim's spool directory.
16138 A path must start with a slash.
16139 To send to syslog, use the word &"syslog"&.
16140 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16141 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16142 used. If this string is fixed at your installation (contains no expansion
16143 variables) it is recommended that you do not set this option in the
16144 configuration file, but instead supply the path using LOG_FILE_PATH in
16145 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16146 early on &-- in particular, failure to read the configuration file.
16147
16148
16149 .option log_selector main string unset
16150 .cindex "log" "selectors"
16151 This option can be used to reduce or increase the number of things that Exim
16152 writes to its log files. Its argument is made up of names preceded by plus or
16153 minus characters. For example:
16154 .code
16155 log_selector = +arguments -retry_defer
16156 .endd
16157 A list of possible names and what they control is given in the chapter on
16158 logging, in section &<<SECTlogselector>>&.
16159
16160
16161 .option log_timezone main boolean false
16162 .cindex "log" "timezone for entries"
16163 .vindex "&$tod_log$&"
16164 .vindex "&$tod_zone$&"
16165 By default, the timestamps on log lines are in local time without the
16166 timezone. This means that if your timezone changes twice a year, the timestamps
16167 in log lines are ambiguous for an hour when the clocks go back. One way of
16168 avoiding this problem is to set the timezone to UTC. An alternative is to set
16169 &%log_timezone%& true. This turns on the addition of the timezone offset to
16170 timestamps in log lines. Turning on this option can add quite a lot to the size
16171 of log files because each line is extended by 6 characters. Note that the
16172 &$tod_log$& variable contains the log timestamp without the zone, but there is
16173 another variable called &$tod_zone$& that contains just the timezone offset.
16174
16175
16176 .option lookup_open_max main integer 25
16177 .cindex "too many open files"
16178 .cindex "open files, too many"
16179 .cindex "file" "too many open"
16180 .cindex "lookup" "maximum open files"
16181 .cindex "limit" "open files for lookups"
16182 This option limits the number of simultaneously open files for single-key
16183 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16184 Exim normally keeps these files open during routing, because often the same
16185 file is required several times. If the limit is reached, Exim closes the least
16186 recently used file. Note that if you are using the &'ndbm'& library, it
16187 actually opens two files for each logical DBM database, though it still counts
16188 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16189 open files"& errors with NDBM, you need to reduce the value of
16190 &%lookup_open_max%&.
16191
16192
16193 .option max_username_length main integer 0
16194 .cindex "length of login name"
16195 .cindex "user name" "maximum length"
16196 .cindex "limit" "user name length"
16197 Some operating systems are broken in that they truncate long arguments to
16198 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16199 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16200 an argument that is longer behaves as if &[getpwnam()]& failed.
16201
16202
16203 .option message_body_newlines main bool false
16204 .cindex "message body" "newlines in variables"
16205 .cindex "newline" "in message body variables"
16206 .vindex "&$message_body$&"
16207 .vindex "&$message_body_end$&"
16208 By default, newlines in the message body are replaced by spaces when setting
16209 the &$message_body$& and &$message_body_end$& expansion variables. If this
16210 option is set true, this no longer happens.
16211
16212
16213 .option message_body_visible main integer 500
16214 .cindex "body of message" "visible size"
16215 .cindex "message body" "visible size"
16216 .vindex "&$message_body$&"
16217 .vindex "&$message_body_end$&"
16218 This option specifies how much of a message's body is to be included in the
16219 &$message_body$& and &$message_body_end$& expansion variables.
16220
16221
16222 .option message_id_header_domain main string&!! unset
16223 .cindex "&'Message-ID:'& header line"
16224 If this option is set, the string is expanded and used as the right hand side
16225 (domain) of the &'Message-ID:'& header that Exim creates if a
16226 locally-originated incoming message does not have one. &"Locally-originated"&
16227 means &"not received over TCP/IP."&
16228 Otherwise, the primary host name is used.
16229 Only letters, digits, dot and hyphen are accepted; any other characters are
16230 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16231 empty string, the option is ignored.
16232
16233
16234 .option message_id_header_text main string&!! unset
16235 If this variable is set, the string is expanded and used to augment the text of
16236 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16237 message does not have one. The text of this header is required by RFC 2822 to
16238 take the form of an address. By default, Exim uses its internal message id as
16239 the local part, and the primary host name as the domain. If this option is set,
16240 it is expanded, and provided the expansion is not forced to fail, and does not
16241 yield an empty string, the result is inserted into the header immediately
16242 before the @, separated from the internal message id by a dot. Any characters
16243 that are illegal in an address are automatically converted into hyphens. This
16244 means that variables such as &$tod_log$& can be used, because the spaces and
16245 colons will become hyphens.
16246
16247
16248 .option message_logs main boolean true
16249 .cindex "message logs" "disabling"
16250 .cindex "log" "message log; disabling"
16251 If this option is turned off, per-message log files are not created in the
16252 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16253 Exim, by reducing the number of files involved in handling a message from a
16254 minimum of four (header spool file, body spool file, delivery journal, and
16255 per-message log) to three. The other major I/O activity is Exim's main log,
16256 which is not affected by this option.
16257
16258
16259 .option message_size_limit main string&!! 50M
16260 .cindex "message" "size limit"
16261 .cindex "limit" "message size"
16262 .cindex "size" "of message, limit"
16263 This option limits the maximum size of message that Exim will process. The
16264 value is expanded for each incoming connection so, for example, it can be made
16265 to depend on the IP address of the remote host for messages arriving via
16266 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16267 optionally followed by K or M.
16268
16269 &*Note*&: This limit cannot be made to depend on a message's sender or any
16270 other properties of an individual message, because it has to be advertised in
16271 the server's response to EHLO. String expansion failure causes a temporary
16272 error. A value of zero means no limit, but its use is not recommended. See also
16273 &%bounce_return_size_limit%&.
16274
16275 Incoming SMTP messages are failed with a 552 error if the limit is
16276 exceeded; locally-generated messages either get a stderr message or a delivery
16277 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16278 an oversized message is logged in both the main and the reject logs. See also
16279 the generic transport option &%message_size_limit%&, which limits the size of
16280 message that an individual transport can process.
16281
16282 If you use a virus-scanner and set this option to to a value larger than the
16283 maximum size that your virus-scanner is configured to support, you may get
16284 failures triggered by large mails.  The right size to configure for the
16285 virus-scanner depends upon what data is passed and the options in use but it's
16286 probably safest to just set it to a little larger than this value.  E.g., with a
16287 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16288 some problems may result.
16289
16290 A value of 0 will disable size limit checking; Exim will still advertise the
16291 SIZE extension in an EHLO response, but without a limit, so as to permit
16292 SMTP clients to still indicate the message size along with the MAIL verb.
16293
16294
16295 .option move_frozen_messages main boolean false
16296 .cindex "frozen messages" "moving"
16297 This option, which is available only if Exim has been built with the setting
16298 .code
16299 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16300 .endd
16301 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16302 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16303 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16304 standard utilities for handling such moved messages, and they do not show up in
16305 lists generated by &%-bp%& or by the Exim monitor.
16306
16307
16308 .option mua_wrapper main boolean false
16309 Setting this option true causes Exim to run in a very restrictive mode in which
16310 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16311 contains a full description of this facility.
16312
16313
16314
16315 .option mysql_servers main "string list" unset
16316 .cindex "MySQL" "server list"
16317 This option provides a list of MySQL servers and associated connection data, to
16318 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16319 option is available only if Exim has been built with MySQL support.
16320
16321
16322 .option never_users main "string list&!!" unset
16323 This option is expanded just once, at the start of Exim's processing. Local
16324 message deliveries are normally run in processes that are setuid to the
16325 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16326 It is usually desirable to prevent any deliveries from running as root, as a
16327 safety precaution.
16328
16329 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16330 list of users that must not be used for local deliveries. This list is fixed in
16331 the binary and cannot be overridden by the configuration file. By default, it
16332 contains just the single user name &"root"&. The &%never_users%& runtime option
16333 can be used to add more users to the fixed list.
16334
16335 If a message is to be delivered as one of the users on the fixed list or the
16336 &%never_users%& list, an error occurs, and delivery is deferred. A common
16337 example is
16338 .code
16339 never_users = root:daemon:bin
16340 .endd
16341 Including root is redundant if it is also on the fixed list, but it does no
16342 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16343 transport driver.
16344
16345
16346 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16347 .cindex "OpenSSL "compatibility options"
16348 This option allows an administrator to adjust the SSL options applied
16349 by OpenSSL to connections.  It is given as a space-separated list of items,
16350 each one to be +added or -subtracted from the current value.
16351
16352 This option is only available if Exim is built against OpenSSL.  The values
16353 available for this option vary according to the age of your OpenSSL install.
16354 The &"all"& value controls a subset of flags which are available, typically
16355 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16356 list the values known on your system and Exim should support all the
16357 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16358 names lose the leading &"SSL_OP_"& and are lower-cased.
16359
16360 Note that adjusting the options can have severe impact upon the security of
16361 SSL as used by Exim.  It is possible to disable safety checks and shoot
16362 yourself in the foot in various unpleasant ways.  This option should not be
16363 adjusted lightly.  An unrecognised item will be detected at startup, by
16364 invoking Exim with the &%-bV%& flag.
16365
16366 The option affects Exim operating both as a server and as a client.
16367
16368 Historical note: prior to release 4.80, Exim defaulted this value to
16369 "+dont_insert_empty_fragments", which may still be needed for compatibility
16370 with some clients, but which lowers security by increasing exposure to
16371 some now infamous attacks.
16372
16373 Examples:
16374 .code
16375 # Make both old MS and old Eudora happy:
16376 openssl_options = -all +microsoft_big_sslv3_buffer \
16377                        +dont_insert_empty_fragments
16378
16379 # Disable older protocol versions:
16380 openssl_options = +no_sslv2 +no_sslv3
16381 .endd
16382
16383 Possible options may include:
16384 .ilist
16385 &`all`&
16386 .next
16387 &`allow_unsafe_legacy_renegotiation`&
16388 .next
16389 &`cipher_server_preference`&
16390 .next
16391 &`dont_insert_empty_fragments`&
16392 .next
16393 &`ephemeral_rsa`&
16394 .next
16395 &`legacy_server_connect`&
16396 .next
16397 &`microsoft_big_sslv3_buffer`&
16398 .next
16399 &`microsoft_sess_id_bug`&
16400 .next
16401 &`msie_sslv2_rsa_padding`&
16402 .next
16403 &`netscape_challenge_bug`&
16404 .next
16405 &`netscape_reuse_cipher_change_bug`&
16406 .next
16407 &`no_compression`&
16408 .next
16409 &`no_session_resumption_on_renegotiation`&
16410 .next
16411 &`no_sslv2`&
16412 .next
16413 &`no_sslv3`&
16414 .next
16415 &`no_ticket`&
16416 .next
16417 &`no_tlsv1`&
16418 .next
16419 &`no_tlsv1_1`&
16420 .next
16421 &`no_tlsv1_2`&
16422 .next
16423 &`safari_ecdhe_ecdsa_bug`&
16424 .next
16425 &`single_dh_use`&
16426 .next
16427 &`single_ecdh_use`&
16428 .next
16429 &`ssleay_080_client_dh_bug`&
16430 .next
16431 &`sslref2_reuse_cert_type_bug`&
16432 .next
16433 &`tls_block_padding_bug`&
16434 .next
16435 &`tls_d5_bug`&
16436 .next
16437 &`tls_rollback_bug`&
16438 .endlist
16439
16440 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16441 all clients connecting using the MacOS SecureTransport TLS facility prior
16442 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16443 to negotiate TLS then this option value might help, provided that your OpenSSL
16444 release is new enough to contain this work-around.  This may be a situation
16445 where you have to upgrade OpenSSL to get buggy clients working.
16446
16447
16448 .option oracle_servers main "string list" unset
16449 .cindex "Oracle" "server list"
16450 This option provides a list of Oracle servers and associated connection data,
16451 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16452 The option is available only if Exim has been built with Oracle support.
16453
16454
16455 .option percent_hack_domains main "domain list&!!" unset
16456 .cindex "&""percent hack""&"
16457 .cindex "source routing" "in email address"
16458 .cindex "address" "source-routed"
16459 The &"percent hack"& is the convention whereby a local part containing a
16460 percent sign is re-interpreted as a new email address, with the percent
16461 replaced by @. This is sometimes called &"source routing"&, though that term is
16462 also applied to RFC 2822 addresses that begin with an @ character. If this
16463 option is set, Exim implements the percent facility for those domains listed,
16464 but no others. This happens before an incoming SMTP address is tested against
16465 an ACL.
16466
16467 &*Warning*&: The &"percent hack"& has often been abused by people who are
16468 trying to get round relaying restrictions. For this reason, it is best avoided
16469 if at all possible. Unfortunately, a number of less security-conscious MTAs
16470 implement it unconditionally. If you are running Exim on a gateway host, and
16471 routing mail through to internal MTAs without processing the local parts, it is
16472 a good idea to reject recipient addresses with percent characters in their
16473 local parts. Exim's default configuration does this.
16474
16475
16476 .option perl_at_start main boolean false
16477 .cindex "Perl"
16478 This option is available only when Exim is built with an embedded Perl
16479 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16480
16481
16482 .option perl_startup main string unset
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 .option perl_taintmode main boolean false
16488 .cindex "Perl"
16489 This option enables the taint mode of the embedded Perl interpreter.
16490
16491
16492 .option pgsql_servers main "string list" unset
16493 .cindex "PostgreSQL lookup type" "server list"
16494 This option provides a list of PostgreSQL servers and associated connection
16495 data, to be used in conjunction with &(pgsql)& lookups (see section
16496 &<<SECID72>>&). The option is available only if Exim has been built with
16497 PostgreSQL support.
16498
16499
16500 .option pid_file_path main string&!! "set at compile time"
16501 .cindex "daemon" "pid file path"
16502 .cindex "pid file, path for"
16503 This option sets the name of the file to which the Exim daemon writes its
16504 process id. The string is expanded, so it can contain, for example, references
16505 to the host name:
16506 .code
16507 pid_file_path = /var/log/$primary_hostname/exim.pid
16508 .endd
16509 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16510 spool directory.
16511 The value set by the option can be overridden by the &%-oP%& command line
16512 option. A pid file is not written if a &"non-standard"& daemon is run by means
16513 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16514
16515
16516 .option pipelining_advertise_hosts main "host list&!!" *
16517 .cindex "PIPELINING" "suppressing advertising"
16518 This option can be used to suppress the advertisement of the SMTP
16519 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16520 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16521 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16522 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16523 that clients will use it; &"out of order"& commands that are &"expected"& do
16524 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16525
16526 .option pipelining_connect_advertise_hosts main "host list&!!" *
16527 .cindex "pipelining" "early connection"
16528 .cindex "pipelining" PIPE_CONNECT
16529 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16530 this option controls which hosts the facility is advertised to
16531 and from which pipeline early-connection (before MAIL) SMTP
16532 commands are acceptable.
16533 When used, the pipelining saves on roundtrip times.
16534
16535 See also the &%hosts_pipe_connect%& smtp transport option.
16536
16537 Currently the option name &"X_PIPE_CONNECT"& is used.
16538
16539
16540 .option prdr_enable main boolean false
16541 .cindex "PRDR" "enabling on server"
16542 This option can be used to enable the Per-Recipient Data Response extension
16543 to SMTP, defined by Eric Hall.
16544 If the option is set, PRDR is advertised by Exim when operating as a server.
16545 If the client requests PRDR, and more than one recipient, for a message
16546 an additional ACL is called for each recipient after the message content
16547 is received.  See section &<<SECTPRDRACL>>&.
16548
16549 .option preserve_message_logs main boolean false
16550 .cindex "message logs" "preserving"
16551 If this option is set, message log files are not deleted when messages are
16552 completed. Instead, they are moved to a sub-directory of the spool directory
16553 called &_msglog.OLD_&, where they remain available for statistical or debugging
16554 purposes. This is a dangerous option to set on systems with any appreciable
16555 volume of mail. Use with care!
16556
16557
16558 .option primary_hostname main string "see below"
16559 .cindex "name" "of local host"
16560 .cindex "host" "name of local"
16561 .cindex "local host" "name of"
16562 .vindex "&$primary_hostname$&"
16563 This specifies the name of the current host. It is used in the default EHLO or
16564 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16565 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16566 The value is also used by default in some SMTP response messages from an Exim
16567 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16568
16569 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16570 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16571 contains only one component, Exim passes it to &[gethostbyname()]& (or
16572 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16573 version. The variable &$primary_hostname$& contains the host name, whether set
16574 explicitly by this option, or defaulted.
16575
16576
16577 .option print_topbitchars main boolean false
16578 .cindex "printing characters"
16579 .cindex "8-bit characters"
16580 By default, Exim considers only those characters whose codes lie in the range
16581 32&--126 to be printing characters. In a number of circumstances (for example,
16582 when writing log entries) non-printing characters are converted into escape
16583 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16584 is set, code values of 128 and above are also considered to be printing
16585 characters.
16586
16587 This option also affects the header syntax checks performed by the
16588 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16589 the user's full name when constructing From: and Sender: addresses (as
16590 described in section &<<SECTconstr>>&). Setting this option can cause
16591 Exim to generate eight bit message headers that do not conform to the
16592 standards.
16593
16594
16595 .option process_log_path main string unset
16596 .cindex "process log path"
16597 .cindex "log" "process log"
16598 .cindex "&'exiwhat'&"
16599 This option sets the name of the file to which an Exim process writes its
16600 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16601 utility script. If this option is unset, the file called &_exim-process.info_&
16602 in Exim's spool directory is used. The ability to specify the name explicitly
16603 can be useful in environments where two different Exims are running, using
16604 different spool directories.
16605
16606
16607 .option prod_requires_admin main boolean true
16608 .cindex "restricting access to features"
16609 .oindex "&%-M%&"
16610 .oindex "&%-R%&"
16611 .oindex "&%-q%&"
16612 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16613 admin user unless &%prod_requires_admin%& is set false. See also
16614 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16615
16616
16617 .option qualify_domain main string "see below"
16618 .cindex "domain" "for qualifying addresses"
16619 .cindex "address" "qualification"
16620 This option specifies the domain name that is added to any envelope sender
16621 addresses that do not have a domain qualification. It also applies to
16622 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16623 are accepted by default only for locally-generated messages. Qualification is
16624 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16625 locally-generated messages, unless the &%-bnq%& command line option is used.
16626
16627 Messages from external sources must always contain fully qualified addresses,
16628 unless the sending host matches &%sender_unqualified_hosts%& or
16629 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16630 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16631 necessary. Internally, Exim always works with fully qualified envelope
16632 addresses. If &%qualify_domain%& is not set, it defaults to the
16633 &%primary_hostname%& value.
16634
16635
16636 .option qualify_recipient main string "see below"
16637 This option allows you to specify a different domain for qualifying recipient
16638 addresses to the one that is used for senders. See &%qualify_domain%& above.
16639
16640
16641
16642 .option queue_domains main "domain list&!!" unset
16643 .cindex "domain" "specifying non-immediate delivery"
16644 .cindex "queueing incoming messages"
16645 .cindex "message" "queueing certain domains"
16646 This option lists domains for which immediate delivery is not required.
16647 A delivery process is started whenever a message is received, but only those
16648 domains that do not match are processed. All other deliveries wait until the
16649 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16650
16651
16652 .option queue_list_requires_admin main boolean true
16653 .cindex "restricting access to features"
16654 .oindex "&%-bp%&"
16655 The &%-bp%& command-line option, which lists the messages that are on the
16656 queue, requires the caller to be an admin user unless
16657 &%queue_list_requires_admin%& is set false.
16658 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16659
16660
16661 .option queue_only main boolean false
16662 .cindex "queueing incoming messages"
16663 .cindex "message" "queueing unconditionally"
16664 If &%queue_only%& is set, a delivery process is not automatically started
16665 whenever a message is received. Instead, the message waits in the queue for the
16666 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16667 delivered immediately when certain conditions (such as heavy load) occur.
16668
16669 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16670 and &%-odi%& command line options override &%queue_only%& unless
16671 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16672 &%queue_only_load%&, and &%smtp_accept_queue%&.
16673
16674
16675 .option queue_only_file main string unset
16676 .cindex "queueing incoming messages"
16677 .cindex "message" "queueing by file existence"
16678 This option can be set to a colon-separated list of absolute path names, each
16679 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16680 it tests for the existence of each listed path using a call to &[stat()]&. For
16681 each path that exists, the corresponding queueing option is set.
16682 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16683 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16684 .code
16685 queue_only_file = smtp/some/file
16686 .endd
16687 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16688 &_/some/file_& exists.
16689
16690
16691 .option queue_only_load main fixed-point unset
16692 .cindex "load average"
16693 .cindex "queueing incoming messages"
16694 .cindex "message" "queueing by load"
16695 If the system load average is higher than this value, incoming messages from
16696 all sources are queued, and no automatic deliveries are started. If this
16697 happens during local or remote SMTP input, all subsequent messages received on
16698 the same SMTP connection are queued by default, whatever happens to the load in
16699 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16700 false.
16701
16702 Deliveries will subsequently be performed by queue runner processes. This
16703 option has no effect on ancient operating systems on which Exim cannot
16704 determine the load average. See also &%deliver_queue_load_max%& and
16705 &%smtp_load_reserve%&.
16706
16707
16708 .option queue_only_load_latch main boolean true
16709 .cindex "load average" "re-evaluating per message"
16710 When this option is true (the default), once one message has been queued
16711 because the load average is higher than the value set by &%queue_only_load%&,
16712 all subsequent messages received on the same SMTP connection are also queued.
16713 This is a deliberate choice; even though the load average may fall below the
16714 threshold, it doesn't seem right to deliver later messages on the same
16715 connection when not delivering earlier ones. However, there are special
16716 circumstances such as very long-lived connections from scanning appliances
16717 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16718 should be set false. This causes the value of the load average to be
16719 re-evaluated for each message.
16720
16721
16722 .option queue_only_override main boolean true
16723 .cindex "queueing incoming messages"
16724 When this option is true, the &%-od%&&'x'& command line options override the
16725 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16726 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16727 to override; they are accepted, but ignored.
16728
16729
16730 .option queue_run_in_order main boolean false
16731 .cindex "queue runner" "processing messages in order"
16732 If this option is set, queue runs happen in order of message arrival instead of
16733 in an arbitrary order. For this to happen, a complete list of the entire queue
16734 must be set up before the deliveries start. When the queue is all held in a
16735 single directory (the default), a single list is created for both the ordered
16736 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16737 single list is not created when &%queue_run_in_order%& is false. In this case,
16738 the sub-directories are processed one at a time (in a random order), and this
16739 avoids setting up one huge list for the whole queue. Thus, setting
16740 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16741 when the queue is large, because of the extra work in setting up the single,
16742 large list. In most situations, &%queue_run_in_order%& should not be set.
16743
16744
16745
16746 .option queue_run_max main integer&!! 5
16747 .cindex "queue runner" "maximum number of"
16748 This controls the maximum number of queue runner processes that an Exim daemon
16749 can run simultaneously. This does not mean that it starts them all at once,
16750 but rather that if the maximum number are still running when the time comes to
16751 start another one, it refrains from starting another one. This can happen with
16752 very large queues and/or very sluggish deliveries. This option does not,
16753 however, interlock with other processes, so additional queue runners can be
16754 started by other means, or by killing and restarting the daemon.
16755
16756 Setting this option to zero does not suppress queue runs; rather, it disables
16757 the limit, allowing any number of simultaneous queue runner processes to be
16758 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16759 the daemon's command line.
16760
16761 .cindex queues named
16762 .cindex "named queues"
16763 To set limits for different named queues use
16764 an expansion depending on the &$queue_name$& variable.
16765
16766 .option queue_smtp_domains main "domain list&!!" unset
16767 .cindex "queueing incoming messages"
16768 .cindex "message" "queueing remote deliveries"
16769 When this option is set, a delivery process is started whenever a message is
16770 received, routing is performed, and local deliveries take place.
16771 However, if any SMTP deliveries are required for domains that match
16772 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16773 message waits in the queue for the next queue run. Since routing of the message
16774 has taken place, Exim knows to which remote hosts it must be delivered, and so
16775 when the queue run happens, multiple messages for the same host are delivered
16776 over a single SMTP connection. The &%-odqs%& command line option causes all
16777 SMTP deliveries to be queued in this way, and is equivalent to setting
16778 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16779 &%queue_domains%&.
16780
16781
16782 .option receive_timeout main time 0s
16783 .cindex "timeout" "for non-SMTP input"
16784 This option sets the timeout for accepting a non-SMTP message, that is, the
16785 maximum time that Exim waits when reading a message on the standard input. If
16786 the value is zero, it will wait forever. This setting is overridden by the
16787 &%-or%& command line option. The timeout for incoming SMTP messages is
16788 controlled by &%smtp_receive_timeout%&.
16789
16790 .option received_header_text main string&!! "see below"
16791 .cindex "customizing" "&'Received:'& header"
16792 .cindex "&'Received:'& header line" "customizing"
16793 This string defines the contents of the &'Received:'& message header that is
16794 added to each message, except for the timestamp, which is automatically added
16795 on at the end (preceded by a semicolon). The string is expanded each time it is
16796 used. If the expansion yields an empty string, no &'Received:'& header line is
16797 added to the message. Otherwise, the string should start with the text
16798 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16799 header lines.
16800 The default setting is:
16801
16802 .code
16803 received_header_text = Received: \
16804   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16805     {${if def:sender_ident \
16806       {from ${quote_local_part:$sender_ident} }}\
16807         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16808   by $primary_hostname \
16809   ${if def:received_protocol {with $received_protocol }}\
16810   ${if def:tls_ver           { ($tls_ver)}}\
16811   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16812   (Exim $version_number)\n\t\
16813   ${if def:sender_address \
16814   {(envelope-from <$sender_address>)\n\t}}\
16815   id $message_exim_id\
16816   ${if def:received_for {\n\tfor $received_for}}
16817 .endd
16818
16819 The reference to the TLS cipher is omitted when Exim is built without TLS
16820 support. The use of conditional expansions ensures that this works for both
16821 locally generated messages and messages received from remote hosts, giving
16822 header lines such as the following:
16823 .code
16824 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16825 by marley.carol.example with esmtp (Exim 4.00)
16826 (envelope-from <bob@carol.example>)
16827 id 16IOWa-00019l-00
16828 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16829 Received: by scrooge.carol.example with local (Exim 4.00)
16830 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16831 .endd
16832 Until the body of the message has been received, the timestamp is the time when
16833 the message started to be received. Once the body has arrived, and all policy
16834 checks have taken place, the timestamp is updated to the time at which the
16835 message was accepted.
16836
16837
16838 .option received_headers_max main integer 30
16839 .cindex "loop" "prevention"
16840 .cindex "mail loop prevention"
16841 .cindex "&'Received:'& header line" "counting"
16842 When a message is to be delivered, the number of &'Received:'& headers is
16843 counted, and if it is greater than this parameter, a mail loop is assumed to
16844 have occurred, the delivery is abandoned, and an error message is generated.
16845 This applies to both local and remote deliveries.
16846
16847
16848 .option recipient_unqualified_hosts main "host list&!!" unset
16849 .cindex "unqualified addresses"
16850 .cindex "host" "unqualified addresses from"
16851 This option lists those hosts from which Exim is prepared to accept unqualified
16852 recipient addresses in message envelopes. The addresses are made fully
16853 qualified by the addition of the &%qualify_recipient%& value. This option also
16854 affects message header lines. Exim does not reject unqualified recipient
16855 addresses in headers, but it qualifies them only if the message came from a
16856 host that matches &%recipient_unqualified_hosts%&,
16857 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16858 option was not set.
16859
16860
16861 .option recipients_max main integer 0
16862 .cindex "limit" "number of recipients"
16863 .cindex "recipient" "maximum number"
16864 If this option is set greater than zero, it specifies the maximum number of
16865 original recipients for any message. Additional recipients that are generated
16866 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16867 all recipients over the limit; earlier recipients are delivered as normal.
16868 Non-SMTP messages with too many recipients are failed, and no deliveries are
16869 done.
16870
16871 .cindex "RCPT" "maximum number of incoming"
16872 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16873 RCPT commands in a single message.
16874
16875
16876 .option recipients_max_reject main boolean false
16877 If this option is set true, Exim rejects SMTP messages containing too many
16878 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16879 error to the eventual DATA command. Otherwise (the default) it gives a 452
16880 error to the surplus RCPT commands and accepts the message on behalf of the
16881 initial set of recipients. The remote server should then re-send the message
16882 for the remaining recipients at a later time.
16883
16884
16885 .option remote_max_parallel main integer 2
16886 .cindex "delivery" "parallelism for remote"
16887 This option controls parallel delivery of one message to a number of remote
16888 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16889 does all the remote deliveries for a message one by one. Otherwise, if a single
16890 message has to be delivered to more than one remote host, or if several copies
16891 have to be sent to the same remote host, up to &%remote_max_parallel%&
16892 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16893 deliveries are required, the maximum number of processes are started, and as
16894 each one finishes, another is begun. The order of starting processes is the
16895 same as if sequential delivery were being done, and can be controlled by the
16896 &%remote_sort_domains%& option. If parallel delivery takes place while running
16897 with debugging turned on, the debugging output from each delivery process is
16898 tagged with its process id.
16899
16900 This option controls only the maximum number of parallel deliveries for one
16901 message in one Exim delivery process. Because Exim has no central queue
16902 manager, there is no way of controlling the total number of simultaneous
16903 deliveries if the configuration allows a delivery attempt as soon as a message
16904 is received.
16905
16906 .cindex "number of deliveries"
16907 .cindex "delivery" "maximum number of"
16908 If you want to control the total number of deliveries on the system, you
16909 need to set the &%queue_only%& option. This ensures that all incoming messages
16910 are added to the queue without starting a delivery process. Then set up an Exim
16911 daemon to start queue runner processes at appropriate intervals (probably
16912 fairly often, for example, every minute), and limit the total number of queue
16913 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16914 delivers only one message at a time, the maximum number of deliveries that can
16915 then take place at once is &%queue_run_max%& multiplied by
16916 &%remote_max_parallel%&.
16917
16918 If it is purely remote deliveries you want to control, use
16919 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16920 doing the SMTP routing before queueing, so that several messages for the same
16921 host will eventually get delivered down the same connection.
16922
16923
16924 .option remote_sort_domains main "domain list&!!" unset
16925 .cindex "sorting remote deliveries"
16926 .cindex "delivery" "sorting remote"
16927 When there are a number of remote deliveries for a message, they are sorted by
16928 domain into the order given by this list. For example,
16929 .code
16930 remote_sort_domains = *.cam.ac.uk:*.uk
16931 .endd
16932 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16933 then to those in the &%uk%& domain, then to any others.
16934
16935
16936 .option retry_data_expire main time 7d
16937 .cindex "hints database" "data expiry"
16938 This option sets a &"use before"& time on retry information in Exim's hints
16939 database. Any older retry data is ignored. This means that, for example, once a
16940 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16941 past failures.
16942
16943
16944 .option retry_interval_max main time 24h
16945 .cindex "retry" "limit on interval"
16946 .cindex "limit" "on retry interval"
16947 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16948 intervals between delivery attempts for messages that cannot be delivered
16949 straight away. This option sets an overall limit to the length of time between
16950 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16951 the default value.
16952
16953
16954 .option return_path_remove main boolean true
16955 .cindex "&'Return-path:'& header line" "removing"
16956 RFC 2821, section 4.4, states that an SMTP server must insert a
16957 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16958 The &'Return-path:'& header preserves the sender address as received in the
16959 MAIL command. This description implies that this header should not be present
16960 in an incoming message. If &%return_path_remove%& is true, any existing
16961 &'Return-path:'& headers are removed from messages at the time they are
16962 received. Exim's transports have options for adding &'Return-path:'& headers at
16963 the time of delivery. They are normally used only for final local deliveries.
16964
16965
16966 .option return_size_limit main integer 100K
16967 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16968
16969
16970 .option rfc1413_hosts main "host list&!!" @[]
16971 .cindex "RFC 1413"
16972 .cindex "host" "for RFC 1413 calls"
16973 RFC 1413 identification calls are made to any client host which matches
16974 an item in the list.
16975 The default value specifies just this host, being any local interface
16976 for the system.
16977
16978 .option rfc1413_query_timeout main time 0s
16979 .cindex "RFC 1413" "query timeout"
16980 .cindex "timeout" "for RFC 1413 call"
16981 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16982 no RFC 1413 calls are ever made.
16983
16984
16985 .option sender_unqualified_hosts main "host list&!!" unset
16986 .cindex "unqualified addresses"
16987 .cindex "host" "unqualified addresses from"
16988 This option lists those hosts from which Exim is prepared to accept unqualified
16989 sender addresses. The addresses are made fully qualified by the addition of
16990 &%qualify_domain%&. This option also affects message header lines. Exim does
16991 not reject unqualified addresses in headers that contain sender addresses, but
16992 it qualifies them only if the message came from a host that matches
16993 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16994 using TCP/IP), and the &%-bnq%& option was not set.
16995
16996
16997 .option slow_lookup_log main integer 0
16998 .cindex "logging" "slow lookups"
16999 .cindex "dns" "logging slow lookups"
17000 This option controls logging of slow lookups.
17001 If the value is nonzero it is taken as a number of milliseconds
17002 and lookups taking longer than this are logged.
17003 Currently this applies only to DNS lookups.
17004
17005
17006
17007 .option smtp_accept_keepalive main boolean true
17008 .cindex "keepalive" "on incoming connection"
17009 This option controls the setting of the SO_KEEPALIVE option on incoming
17010 TCP/IP socket connections. When set, it causes the kernel to probe idle
17011 connections periodically, by sending packets with &"old"& sequence numbers. The
17012 other end of the connection should send an acknowledgment if the connection is
17013 still okay or a reset if the connection has been aborted. The reason for doing
17014 this is that it has the beneficial effect of freeing up certain types of
17015 connection that can get stuck when the remote host is disconnected without
17016 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17017 hours to detect unreachable hosts.
17018
17019
17020
17021 .option smtp_accept_max main integer 20
17022 .cindex "limit" "incoming SMTP connections"
17023 .cindex "SMTP" "incoming connection count"
17024 .cindex "inetd"
17025 This option specifies the maximum number of simultaneous incoming SMTP calls
17026 that Exim will accept. It applies only to the listening daemon; there is no
17027 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17028 value is set to zero, no limit is applied. However, it is required to be
17029 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17030 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17031
17032 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17033 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17034 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17035 and &%smtp_load_reserve%& are then checked before accepting the connection.
17036
17037
17038 .option smtp_accept_max_nonmail main integer 10
17039 .cindex "limit" "non-mail SMTP commands"
17040 .cindex "SMTP" "limiting non-mail commands"
17041 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17042 the connection if there are too many. This option defines &"too many"&. The
17043 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17044 client looping sending EHLO, for example. The check is applied only if the
17045 client host matches &%smtp_accept_max_nonmail_hosts%&.
17046
17047 When a new message is expected, one occurrence of RSET is not counted. This
17048 allows a client to send one RSET between messages (this is not necessary,
17049 but some clients do it). Exim also allows one uncounted occurrence of HELO
17050 or EHLO, and one occurrence of STARTTLS between messages. After
17051 starting up a TLS session, another EHLO is expected, and so it too is not
17052 counted. The first occurrence of AUTH in a connection, or immediately
17053 following STARTTLS is not counted. Otherwise, all commands other than
17054 MAIL, RCPT, DATA, and QUIT are counted.
17055
17056
17057 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17058 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17059 check by setting this option. The default value makes it apply to all hosts. By
17060 changing the value, you can exclude any badly-behaved hosts that you have to
17061 live with.
17062
17063
17064 . Allow this long option name to split; give it unsplit as a fifth argument
17065 . for the automatic .oindex that is generated by .option.
17066 . We insert " &~&~" which is both pretty nasty visually and results in
17067 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17068 . zero-width-space, which would be nicer visually and results in (at least)
17069 . html that Firefox will split on when it's forced to reflow (rather than
17070 . inserting a horizontal scrollbar).  However, the text is still not
17071 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17072 . the option name to split.
17073
17074 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17075          smtp_accept_max_per_connection
17076 .cindex "SMTP" "limiting incoming message count"
17077 .cindex "limit" "messages per SMTP connection"
17078 The value of this option limits the number of MAIL commands that Exim is
17079 prepared to accept over a single SMTP connection, whether or not each command
17080 results in the transfer of a message. After the limit is reached, a 421
17081 response is given to subsequent MAIL commands. This limit is a safety
17082 precaution against a client that goes mad (incidents of this type have been
17083 seen).
17084
17085
17086 .option smtp_accept_max_per_host main string&!! unset
17087 .cindex "limit" "SMTP connections from one host"
17088 .cindex "host" "limiting SMTP connections from"
17089 This option restricts the number of simultaneous IP connections from a single
17090 host (strictly, from a single IP address) to the Exim daemon. The option is
17091 expanded, to enable different limits to be applied to different hosts by
17092 reference to &$sender_host_address$&. Once the limit is reached, additional
17093 connection attempts from the same host are rejected with error code 421. This
17094 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17095 of zero imposes no limit. If this option is set greater than zero, it is
17096 required that &%smtp_accept_max%& be non-zero.
17097
17098 &*Warning*&: When setting this option you should not use any expansion
17099 constructions that take an appreciable amount of time. The expansion and test
17100 happen in the main daemon loop, in order to reject additional connections
17101 without forking additional processes (otherwise a denial-of-service attack
17102 could cause a vast number or processes to be created). While the daemon is
17103 doing this processing, it cannot accept any other incoming connections.
17104
17105
17106
17107 .option smtp_accept_queue main integer 0
17108 .cindex "SMTP" "incoming connection count"
17109 .cindex "queueing incoming messages"
17110 .cindex "message" "queueing by SMTP connection count"
17111 If the number of simultaneous incoming SMTP connections being handled via the
17112 listening daemon exceeds this value, messages received by SMTP are just placed
17113 in the queue; no delivery processes are started automatically. The count is
17114 fixed at the start of an SMTP connection. It cannot be updated in the
17115 subprocess that receives messages, and so the queueing or not queueing applies
17116 to all messages received in the same connection.
17117
17118 A value of zero implies no limit, and clearly any non-zero value is useful only
17119 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17120 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17121 various &%-od%&&'x'& command line options.
17122
17123
17124 . See the comment on smtp_accept_max_per_connection
17125
17126 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17127          smtp_accept_queue_per_connection
17128 .cindex "queueing incoming messages"
17129 .cindex "message" "queueing by message count"
17130 This option limits the number of delivery processes that Exim starts
17131 automatically when receiving messages via SMTP, whether via the daemon or by
17132 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17133 and the number of messages received in a single SMTP session exceeds this
17134 number, subsequent messages are placed in the queue, but no delivery processes
17135 are started. This helps to limit the number of Exim processes when a server
17136 restarts after downtime and there is a lot of mail waiting for it on other
17137 systems. On large systems, the default should probably be increased, and on
17138 dial-in client systems it should probably be set to zero (that is, disabled).
17139
17140
17141 .option smtp_accept_reserve main integer 0
17142 .cindex "SMTP" "incoming call count"
17143 .cindex "host" "reserved"
17144 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17145 number of SMTP connections that are reserved for connections from the hosts
17146 that are specified in &%smtp_reserve_hosts%&. The value set in
17147 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17148 restricted to this number of connections; the option specifies a minimum number
17149 of connection slots for them, not a maximum. It is a guarantee that this group
17150 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17151 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17152 individual host.
17153
17154 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17155 set to 5, once there are 45 active connections (from any hosts), new
17156 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17157 provided the other criteria for acceptance are met.
17158
17159
17160 .option smtp_active_hostname main string&!! unset
17161 .cindex "host" "name in SMTP responses"
17162 .cindex "SMTP" "host name in responses"
17163 .vindex "&$primary_hostname$&"
17164 This option is provided for multi-homed servers that want to masquerade as
17165 several different hosts. At the start of an incoming SMTP connection, its value
17166 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17167 responses. For example, it is used as domain name in the response to an
17168 incoming HELO or EHLO command.
17169
17170 .vindex "&$smtp_active_hostname$&"
17171 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17172 is saved with any messages that are received. It is therefore available for use
17173 in routers and transports when the message is later delivered.
17174
17175 If this option is unset, or if its expansion is forced to fail, or if the
17176 expansion results in an empty string, the value of &$primary_hostname$& is
17177 used. Other expansion failures cause a message to be written to the main and
17178 panic logs, and the SMTP command receives a temporary error. Typically, the
17179 value of &%smtp_active_hostname%& depends on the incoming interface address.
17180 For example:
17181 .code
17182 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17183   {cox.mydomain}{box.mydomain}}
17184 .endd
17185
17186 Although &$smtp_active_hostname$& is primarily concerned with incoming
17187 messages, it is also used as the default for HELO commands in callout
17188 verification if there is no remote transport from which to obtain a
17189 &%helo_data%& value.
17190
17191 .option smtp_banner main string&!! "see below"
17192 .cindex "SMTP" "welcome banner"
17193 .cindex "banner for SMTP"
17194 .cindex "welcome banner for SMTP"
17195 .cindex "customizing" "SMTP banner"
17196 This string, which is expanded every time it is used, is output as the initial
17197 positive response to an SMTP connection. The default setting is:
17198 .code
17199 smtp_banner = $smtp_active_hostname ESMTP Exim \
17200   $version_number $tod_full
17201 .endd
17202 Failure to expand the string causes a panic error. If you want to create a
17203 multiline response to the initial SMTP connection, use &"\n"& in the string at
17204 appropriate points, but not at the end. Note that the 220 code is not included
17205 in this string. Exim adds it automatically (several times in the case of a
17206 multiline response).
17207
17208
17209 .option smtp_check_spool_space main boolean true
17210 .cindex "checking disk space"
17211 .cindex "disk space, checking"
17212 .cindex "spool directory" "checking space"
17213 When this option is set, if an incoming SMTP session encounters the SIZE
17214 option on a MAIL command, it checks that there is enough space in the
17215 spool directory's partition to accept a message of that size, while still
17216 leaving free the amount specified by &%check_spool_space%& (even if that value
17217 is zero). If there isn't enough space, a temporary error code is returned.
17218
17219
17220 .option smtp_connect_backlog main integer 20
17221 .cindex "connection backlog"
17222 .cindex "SMTP" "connection backlog"
17223 .cindex "backlog of connections"
17224 This option specifies a maximum number of waiting SMTP connections. Exim passes
17225 this value to the TCP/IP system when it sets up its listener. Once this number
17226 of connections are waiting for the daemon's attention, subsequent connection
17227 attempts are refused at the TCP/IP level. At least, that is what the manuals
17228 say; in some circumstances such connection attempts have been observed to time
17229 out instead. For large systems it is probably a good idea to increase the
17230 value (to 50, say). It also gives some protection against denial-of-service
17231 attacks by SYN flooding.
17232
17233
17234 .option smtp_enforce_sync main boolean true
17235 .cindex "SMTP" "synchronization checking"
17236 .cindex "synchronization checking in SMTP"
17237 The SMTP protocol specification requires the client to wait for a response from
17238 the server at certain points in the dialogue. Without PIPELINING these
17239 synchronization points are after every command; with PIPELINING they are
17240 fewer, but they still exist.
17241
17242 Some spamming sites send out a complete set of SMTP commands without waiting
17243 for any response. Exim protects against this by rejecting a message if the
17244 client has sent further input when it should not have. The error response &"554
17245 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17246 for this error cannot be perfect because of transmission delays (unexpected
17247 input may be on its way but not yet received when Exim checks). However, it
17248 does detect many instances.
17249
17250 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17251 If you want to disable the check selectively (for example, only for certain
17252 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17253 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17254
17255
17256
17257 .option smtp_etrn_command main string&!! unset
17258 .cindex "ETRN" "command to be run"
17259 .vindex "&$domain$&"
17260 If this option is set, the given command is run whenever an SMTP ETRN
17261 command is received from a host that is permitted to issue such commands (see
17262 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17263 are independently expanded. The expansion variable &$domain$& is set to the
17264 argument of the ETRN command, and no syntax checking is done on it. For
17265 example:
17266 .code
17267 smtp_etrn_command = /etc/etrn_command $domain \
17268                     $sender_host_address
17269 .endd
17270 A new process is created to run the command, but Exim does not wait for it to
17271 complete. Consequently, its status cannot be checked. If the command cannot be
17272 run, a line is written to the panic log, but the ETRN caller still receives
17273 a 250 success response. Exim is normally running under its own uid when
17274 receiving SMTP, so it is not possible for it to change the uid before running
17275 the command.
17276
17277
17278 .option smtp_etrn_serialize main boolean true
17279 .cindex "ETRN" "serializing"
17280 When this option is set, it prevents the simultaneous execution of more than
17281 one identical command as a result of ETRN in an SMTP connection. See
17282 section &<<SECTETRN>>& for details.
17283
17284
17285 .option smtp_load_reserve main fixed-point unset
17286 .cindex "load average"
17287 If the system load average ever gets higher than this, incoming SMTP calls are
17288 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17289 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17290 the load is over the limit. The option has no effect on ancient operating
17291 systems on which Exim cannot determine the load average. See also
17292 &%deliver_queue_load_max%& and &%queue_only_load%&.
17293
17294
17295
17296 .option smtp_max_synprot_errors main integer 3
17297 .cindex "SMTP" "limiting syntax and protocol errors"
17298 .cindex "limit" "SMTP syntax and protocol errors"
17299 Exim rejects SMTP commands that contain syntax or protocol errors. In
17300 particular, a syntactically invalid email address, as in this command:
17301 .code
17302 RCPT TO:<abc xyz@a.b.c>
17303 .endd
17304 causes immediate rejection of the command, before any other tests are done.
17305 (The ACL cannot be run if there is no valid address to set up for it.) An
17306 example of a protocol error is receiving RCPT before MAIL. If there are
17307 too many syntax or protocol errors in one SMTP session, the connection is
17308 dropped. The limit is set by this option.
17309
17310 .cindex "PIPELINING" "expected errors"
17311 When the PIPELINING extension to SMTP is in use, some protocol errors are
17312 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17313 Exim assumes that PIPELINING will be used if it advertises it (see
17314 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17315 not count towards the limit.
17316
17317
17318
17319 .option smtp_max_unknown_commands main integer 3
17320 .cindex "SMTP" "limiting unknown commands"
17321 .cindex "limit" "unknown SMTP commands"
17322 If there are too many unrecognized commands in an incoming SMTP session, an
17323 Exim server drops the connection. This is a defence against some kinds of abuse
17324 that subvert web
17325 clients
17326 into making connections to SMTP ports; in these circumstances, a number of
17327 non-SMTP command lines are sent first.
17328
17329
17330
17331 .option smtp_ratelimit_hosts main "host list&!!" unset
17332 .cindex "SMTP" "rate limiting"
17333 .cindex "limit" "rate of message arrival"
17334 .cindex "RCPT" "rate limiting"
17335 Some sites find it helpful to be able to limit the rate at which certain hosts
17336 can send them messages, and the rate at which an individual message can specify
17337 recipients.
17338
17339 Exim has two rate-limiting facilities. This section describes the older
17340 facility, which can limit rates within a single connection. The newer
17341 &%ratelimit%& ACL condition can limit rates across all connections. See section
17342 &<<SECTratelimiting>>& for details of the newer facility.
17343
17344 When a host matches &%smtp_ratelimit_hosts%&, the values of
17345 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17346 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17347 respectively. Each option, if set, must contain a set of four comma-separated
17348 values:
17349
17350 .ilist
17351 A threshold, before which there is no rate limiting.
17352 .next
17353 An initial time delay. Unlike other times in Exim, numbers with decimal
17354 fractional parts are allowed here.
17355 .next
17356 A factor by which to increase the delay each time.
17357 .next
17358 A maximum value for the delay. This should normally be less than 5 minutes,
17359 because after that time, the client is liable to timeout the SMTP command.
17360 .endlist
17361
17362 For example, these settings have been used successfully at the site which
17363 first suggested this feature, for controlling mail from their customers:
17364 .code
17365 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17366 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17367 .endd
17368 The first setting specifies delays that are applied to MAIL commands after
17369 two have been received over a single connection. The initial delay is 0.5
17370 seconds, increasing by a factor of 1.05 each time. The second setting applies
17371 delays to RCPT commands when more than four occur in a single message.
17372
17373
17374 .option smtp_ratelimit_mail main string unset
17375 See &%smtp_ratelimit_hosts%& above.
17376
17377
17378 .option smtp_ratelimit_rcpt main string unset
17379 See &%smtp_ratelimit_hosts%& above.
17380
17381
17382 .option smtp_receive_timeout main time&!! 5m
17383 .cindex "timeout" "for SMTP input"
17384 .cindex "SMTP" "input timeout"
17385 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17386 input, including batch SMTP. If a line of input (either an SMTP command or a
17387 data line) is not received within this time, the SMTP connection is dropped and
17388 the message is abandoned.
17389 A line is written to the log containing one of the following messages:
17390 .code
17391 SMTP command timeout on connection from...
17392 SMTP data timeout on connection from...
17393 .endd
17394 The former means that Exim was expecting to read an SMTP command; the latter
17395 means that it was in the DATA phase, reading the contents of a message.
17396
17397 If the first character of the option is a &"$"& the option is
17398 expanded before use and may depend on
17399 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17400
17401
17402 .oindex "&%-os%&"
17403 The value set by this option can be overridden by the
17404 &%-os%& command-line option. A setting of zero time disables the timeout, but
17405 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17406 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17407 timeout is controlled by &%receive_timeout%& and &%-or%&.
17408
17409
17410 .option smtp_reserve_hosts main "host list&!!" unset
17411 This option defines hosts for which SMTP connections are reserved; see
17412 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17413
17414
17415 .option smtp_return_error_details main boolean false
17416 .cindex "SMTP" "details policy failures"
17417 .cindex "policy control" "rejection, returning details"
17418 In the default state, Exim uses bland messages such as
17419 &"Administrative prohibition"& when it rejects SMTP commands for policy
17420 reasons. Many sysadmins like this because it gives away little information
17421 to spammers. However, some other sysadmins who are applying strict checking
17422 policies want to give out much fuller information about failures. Setting
17423 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17424 example, instead of &"Administrative prohibition"&, it might give:
17425 .code
17426 550-Rejected after DATA: '>' missing at end of address:
17427 550 failing address in "From" header is: <user@dom.ain
17428 .endd
17429
17430
17431 .option smtputf8_advertise_hosts main "host list&!!" *
17432 .cindex "SMTPUTF8" "advertising"
17433 When Exim is built with support for internationalised mail names,
17434 the availability thereof is advertised in
17435 response to EHLO only to those client hosts that match this option. See
17436 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17437
17438
17439 .option spamd_address main string "127.0.0.1 783"
17440 This option is available when Exim is compiled with the content-scanning
17441 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17442 See section &<<SECTscanspamass>>& for more details.
17443
17444
17445
17446 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17447 This option is available when Exim is compiled with SPF support.
17448 See section &<<SECSPF>>& for more details.
17449
17450
17451
17452 .option split_spool_directory main boolean false
17453 .cindex "multiple spool directories"
17454 .cindex "spool directory" "split"
17455 .cindex "directories, multiple"
17456 If this option is set, it causes Exim to split its input directory into 62
17457 subdirectories, each with a single alphanumeric character as its name. The
17458 sixth character of the message id is used to allocate messages to
17459 subdirectories; this is the least significant base-62 digit of the time of
17460 arrival of the message.
17461
17462 Splitting up the spool in this way may provide better performance on systems
17463 where there are long mail queues, by reducing the number of files in any one
17464 directory. The msglog directory is also split up in a similar way to the input
17465 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17466 are still placed in the single directory &_msglog.OLD_&.
17467
17468 It is not necessary to take any special action for existing messages when
17469 changing &%split_spool_directory%&. Exim notices messages that are in the
17470 &"wrong"& place, and continues to process them. If the option is turned off
17471 after a period of being on, the subdirectories will eventually empty and be
17472 automatically deleted.
17473
17474 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17475 changes. Instead of creating a list of all messages in the queue, and then
17476 trying to deliver each one, in turn, it constructs a list of those in one
17477 sub-directory and tries to deliver them, before moving on to the next
17478 sub-directory. The sub-directories are processed in a random order. This
17479 spreads out the scanning of the input directories, and uses less memory. It is
17480 particularly beneficial when there are lots of messages in the queue. However,
17481 if &%queue_run_in_order%& is set, none of this new processing happens. The
17482 entire queue has to be scanned and sorted before any deliveries can start.
17483
17484
17485 .option spool_directory main string&!! "set at compile time"
17486 .cindex "spool directory" "path to"
17487 This defines the directory in which Exim keeps its spool, that is, the messages
17488 it is waiting to deliver. The default value is taken from the compile-time
17489 configuration setting, if there is one. If not, this option must be set. The
17490 string is expanded, so it can contain, for example, a reference to
17491 &$primary_hostname$&.
17492
17493 If the spool directory name is fixed on your installation, it is recommended
17494 that you set it at build time rather than from this option, particularly if the
17495 log files are being written to the spool directory (see &%log_file_path%&).
17496 Otherwise log files cannot be used for errors that are detected early on, such
17497 as failures in the configuration file.
17498
17499 By using this option to override the compiled-in path, it is possible to run
17500 tests of Exim without using the standard spool.
17501
17502 .option spool_wireformat main boolean false
17503 .cindex "spool directory" "file formats"
17504 If this option is set, Exim may for some messages use an alternative format
17505 for data-files in the spool which matches the wire format.
17506 Doing this permits more efficient message reception and transmission.
17507 Currently it is only done for messages received using the ESMTP CHUNKING
17508 option.
17509
17510 The following variables will not have useful values:
17511 .code
17512 $max_received_linelength
17513 $body_linecount
17514 $body_zerocount
17515 .endd
17516
17517 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17518 and any external programs which are passed a reference to a message data file
17519 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17520 will need to be aware of the different formats potentially available.
17521
17522 Using any of the ACL conditions noted will negate the reception benefit
17523 (as a Unix-mbox-format file is constructed for them).
17524 The transmission benefit is maintained.
17525
17526 .option sqlite_lock_timeout main time 5s
17527 .cindex "sqlite lookup type" "lock timeout"
17528 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17529 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17530
17531 .option strict_acl_vars main boolean false
17532 .cindex "&ACL;" "variables, handling unset"
17533 This option controls what happens if a syntactically valid but undefined ACL
17534 variable is referenced. If it is false (the default), an empty string
17535 is substituted; if it is true, an error is generated. See section
17536 &<<SECTaclvariables>>& for details of ACL variables.
17537
17538 .option strip_excess_angle_brackets main boolean false
17539 .cindex "angle brackets, excess"
17540 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17541 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17542 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17543 passed on to another MTA, the excess angle brackets are not passed on. If this
17544 option is not set, multiple pairs of angle brackets cause a syntax error.
17545
17546
17547 .option strip_trailing_dot main boolean false
17548 .cindex "trailing dot on domain"
17549 .cindex "dot" "trailing on domain"
17550 If this option is set, a trailing dot at the end of a domain in an address is
17551 ignored. If this is in the envelope and the message is passed on to another
17552 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17553 domain causes a syntax error.
17554 However, addresses in header lines are checked only when an ACL requests header
17555 syntax checking.
17556
17557
17558 .option syslog_duplication main boolean true
17559 .cindex "syslog" "duplicate log lines; suppressing"
17560 When Exim is logging to syslog, it writes the log lines for its three
17561 separate logs at different syslog priorities so that they can in principle
17562 be separated on the logging hosts. Some installations do not require this
17563 separation, and in those cases, the duplication of certain log lines is a
17564 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17565 particular log line is written to syslog. For lines that normally go to
17566 both the main log and the reject log, the reject log version (possibly
17567 containing message header lines) is written, at LOG_NOTICE priority.
17568 Lines that normally go to both the main and the panic log are written at
17569 the LOG_ALERT priority.
17570
17571
17572 .option syslog_facility main string unset
17573 .cindex "syslog" "facility; setting"
17574 This option sets the syslog &"facility"& name, used when Exim is logging to
17575 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17576 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17577 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17578 details of Exim's logging.
17579
17580
17581 .option syslog_pid main boolean true
17582 .cindex "syslog" "pid"
17583 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17584 omitted when these lines are sent to syslog. (Syslog normally prefixes
17585 the log lines with the PID of the logging process automatically.) You need
17586 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17587 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17588
17589
17590
17591 .option syslog_processname main string &`exim`&
17592 .cindex "syslog" "process name; setting"
17593 This option sets the syslog &"ident"& name, used when Exim is logging to
17594 syslog. The value must be no longer than 32 characters. See chapter
17595 &<<CHAPlog>>& for details of Exim's logging.
17596
17597
17598
17599 .option syslog_timestamp main boolean true
17600 .cindex "syslog" "timestamps"
17601 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17602 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17603 details of Exim's logging.
17604
17605
17606 .option system_filter main string&!! unset
17607 .cindex "filter" "system filter"
17608 .cindex "system filter" "specifying"
17609 .cindex "Sieve filter" "not available for system filter"
17610 This option specifies an Exim filter file that is applied to all messages at
17611 the start of each delivery attempt, before any routing is done. System filters
17612 must be Exim filters; they cannot be Sieve filters. If the system filter
17613 generates any deliveries to files or pipes, or any new mail messages, the
17614 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17615 which transports are to be used. Details of this facility are given in chapter
17616 &<<CHAPsystemfilter>>&.
17617 A forced expansion failure results in no filter operation.
17618
17619
17620 .option system_filter_directory_transport main string&!! unset
17621 .vindex "&$address_file$&"
17622 This sets the name of the transport driver that is to be used when the
17623 &%save%& command in a system message filter specifies a path ending in &"/"&,
17624 implying delivery of each message into a separate file in some directory.
17625 During the delivery, the variable &$address_file$& contains the path name.
17626
17627
17628 .option system_filter_file_transport main string&!! unset
17629 .cindex "file" "transport for system filter"
17630 This sets the name of the transport driver that is to be used when the &%save%&
17631 command in a system message filter specifies a path not ending in &"/"&. During
17632 the delivery, the variable &$address_file$& contains the path name.
17633
17634 .option system_filter_group main string unset
17635 .cindex "gid (group id)" "system filter"
17636 This option is used only when &%system_filter_user%& is also set. It sets the
17637 gid under which the system filter is run, overriding any gid that is associated
17638 with the user. The value may be numerical or symbolic.
17639
17640 .option system_filter_pipe_transport main string&!! unset
17641 .cindex "&(pipe)& transport" "for system filter"
17642 .vindex "&$address_pipe$&"
17643 This specifies the transport driver that is to be used when a &%pipe%& command
17644 is used in a system filter. During the delivery, the variable &$address_pipe$&
17645 contains the pipe command.
17646
17647
17648 .option system_filter_reply_transport main string&!! unset
17649 .cindex "&(autoreply)& transport" "for system filter"
17650 This specifies the transport driver that is to be used when a &%mail%& command
17651 is used in a system filter.
17652
17653
17654 .option system_filter_user main string unset
17655 .cindex "uid (user id)" "system filter"
17656 If this option is set to root, the system filter is run in the main Exim
17657 delivery process, as root.  Otherwise, the system filter runs in a separate
17658 process, as the given user, defaulting to the Exim run-time user.
17659 Unless the string consists entirely of digits, it
17660 is looked up in the password data. Failure to find the named user causes a
17661 configuration error. The gid is either taken from the password data, or
17662 specified by &%system_filter_group%&. When the uid is specified numerically,
17663 &%system_filter_group%& is required to be set.
17664
17665 If the system filter generates any pipe, file, or reply deliveries, the uid
17666 under which the filter is run is used when transporting them, unless a
17667 transport option overrides.
17668
17669
17670 .option tcp_nodelay main boolean true
17671 .cindex "daemon" "TCP_NODELAY on sockets"
17672 .cindex "Nagle algorithm"
17673 .cindex "TCP_NODELAY on listening sockets"
17674 If this option is set false, it stops the Exim daemon setting the
17675 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17676 turns off the &"Nagle algorithm"&, which is a way of improving network
17677 performance in interactive (character-by-character) situations. Turning it off
17678 should improve Exim's performance a bit, so that is what happens by default.
17679 However, it appears that some broken clients cannot cope, and time out. Hence
17680 this option. It affects only those sockets that are set up for listening by the
17681 daemon. Sockets created by the smtp transport for delivering mail always set
17682 TCP_NODELAY.
17683
17684
17685 .option timeout_frozen_after main time 0s
17686 .cindex "frozen messages" "timing out"
17687 .cindex "timeout" "frozen messages"
17688 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17689 message of any kind that has been in the queue for longer than the given time
17690 is automatically cancelled at the next queue run. If the frozen message is a
17691 bounce message, it is just discarded; otherwise, a bounce is sent to the
17692 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17693 If you want to timeout frozen bounce messages earlier than other kinds of
17694 frozen message, see &%ignore_bounce_errors_after%&.
17695
17696 &*Note:*& the default value of zero means no timeouts; with this setting,
17697 frozen messages remain in the queue forever (except for any frozen bounce
17698 messages that are released by &%ignore_bounce_errors_after%&).
17699
17700
17701 .option timezone main string unset
17702 .cindex "timezone, setting"
17703 .cindex "environment" "values from"
17704 The value of &%timezone%& is used to set the environment variable TZ while
17705 running Exim (if it is different on entry). This ensures that all timestamps
17706 created by Exim are in the required timezone. If you want all your timestamps
17707 to be in UTC (aka GMT) you should set
17708 .code
17709 timezone = UTC
17710 .endd
17711 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17712 or, if that is not set, from the value of the TZ environment variable when Exim
17713 is built. If &%timezone%& is set to the empty string, either at build or run
17714 time, any existing TZ variable is removed from the environment when Exim
17715 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17716 unfortunately not all, operating systems.
17717
17718
17719 .option tls_advertise_hosts main "host list&!!" *
17720 .cindex "TLS" "advertising"
17721 .cindex "encryption" "on SMTP connection"
17722 .cindex "SMTP" "encrypted connection"
17723 When Exim is built with support for TLS encrypted connections, the availability
17724 of the STARTTLS command to set up an encrypted session is advertised in
17725 response to EHLO only to those client hosts that match this option. See
17726 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17727 Note that the default value requires that a certificate be supplied
17728 using the &%tls_certificate%& option.  If TLS support for incoming connections
17729 is not required the &%tls_advertise_hosts%& option should be set empty.
17730
17731
17732 .option tls_certificate main string list&!! unset
17733 .cindex "TLS" "server certificate; location of"
17734 .cindex "certificate" "server, location of"
17735 The value of this option is expanded, and must then be a list of absolute paths to
17736 files which contain the server's certificates (in PEM format).
17737 Commonly only one file is needed.
17738 The server's private key is also
17739 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17740 &<<CHAPTLS>>& for further details.
17741
17742 &*Note*&: The certificates defined by this option are used only when Exim is
17743 receiving incoming messages as a server. If you want to supply certificates for
17744 use when sending messages as a client, you must set the &%tls_certificate%&
17745 option in the relevant &(smtp)& transport.
17746
17747 &*Note*&: If you use filenames based on IP addresses, change the list
17748 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17749
17750 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17751 when a list of more than one
17752 file is used, the &$tls_in_ourcert$& variable is unreliable.
17753 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17754
17755 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17756 if the OpenSSL build supports TLS extensions and the TLS client sends the
17757 Server Name Indication extension, then this option and others documented in
17758 &<<SECTtlssni>>& will be re-expanded.
17759
17760 If this option is unset or empty a fresh self-signed certificate will be
17761 generated for every connection.
17762
17763 .option tls_crl main string&!! unset
17764 .cindex "TLS" "server certificate revocation list"
17765 .cindex "certificate" "revocation list for server"
17766 This option specifies a certificate revocation list. The expanded value must
17767 be the name of a file that contains CRLs in PEM format.
17768
17769 Under OpenSSL the option can specify a directory with CRL files.
17770
17771 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17772 for each signing element of the certificate chain (i.e. all but the leaf).
17773 For the file variant this can be multiple PEM blocks in the one file.
17774
17775 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17776
17777
17778 .option tls_dh_max_bits main integer 2236
17779 .cindex "TLS" "D-H bit count"
17780 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17781 the chosen TLS library.  That value might prove to be too high for
17782 interoperability.  This option provides a maximum clamp on the value
17783 suggested, trading off security for interoperability.
17784
17785 The value must be at least 1024.
17786
17787 The value 2236 was chosen because, at time of adding the option, it was the
17788 hard-coded maximum value supported by the NSS cryptographic library, as used
17789 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17790
17791 If you prefer more security and are willing to break some clients, raise this
17792 number.
17793
17794 Note that the value passed to GnuTLS for *generating* a new prime may be a
17795 little less than this figure, because GnuTLS is inexact and may produce a
17796 larger prime than requested.
17797
17798
17799 .option tls_dhparam main string&!! unset
17800 .cindex "TLS" "D-H parameters for server"
17801 The value of this option is expanded and indicates the source of DH parameters
17802 to be used by Exim.
17803
17804 This option is ignored for GnuTLS version 3.6.0 and later.
17805 The library manages parameter negotiation internally.
17806
17807 &*Note: The Exim Maintainers strongly recommend,
17808 for other TLS library versions,
17809 using a filename with site-generated
17810 local DH parameters*&, which has been supported across all versions of Exim.  The
17811 other specific constants available are a fallback so that even when
17812 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17813
17814 If &%tls_dhparam%& is a filename starting with a &`/`&,
17815 then it names a file from which DH
17816 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17817 PKCS#3 representation of the DH prime.  If the file does not exist, for
17818 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17819 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17820 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17821 and treated as though the &%tls_dhparam%& were set to "none".
17822
17823 If this option expands to the string "none", then no DH parameters will be
17824 loaded by Exim.
17825
17826 If this option expands to the string "historic" and Exim is using GnuTLS, then
17827 Exim will attempt to load a file from inside the spool directory.  If the file
17828 does not exist, Exim will attempt to create it.
17829 See section &<<SECTgnutlsparam>>& for further details.
17830
17831 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17832 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17833
17834 In older versions of Exim the default was the 2048 bit prime described in section
17835 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17836 in IKE is assigned number 23.
17837
17838 Otherwise, the option must expand to the name used by Exim for any of a number
17839 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17840 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17841 the number used by IKE, or "default" which corresponds to
17842 &`exim.dev.20160529.3`&.
17843
17844 The available standard primes are:
17845 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17846 &`ike1`&, &`ike2`&, &`ike5`&,
17847 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17848 &`ike22`&, &`ike23`& and &`ike24`&.
17849
17850 The available additional primes are:
17851 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17852
17853 Some of these will be too small to be accepted by clients.
17854 Some may be too large to be accepted by clients.
17855 The open cryptographic community has suspicions about the integrity of some
17856 of the later IKE values, which led into RFC7919 providing new fixed constants
17857 (the "ffdhe" identifiers).
17858
17859 At this point, all of the "ike" values should be considered obsolete;
17860 they're still in Exim to avoid breaking unusual configurations, but are
17861 candidates for removal the next time we have backwards-incompatible changes.
17862
17863 The TLS protocol does not negotiate an acceptable size for this; clients tend
17864 to hard-drop connections if what is offered by the server is unacceptable,
17865 whether too large or too small, and there's no provision for the client to
17866 tell the server what these constraints are.  Thus, as a server operator, you
17867 need to make an educated guess as to what is most likely to work for your
17868 userbase.
17869
17870 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17871 is most likely to maximise interoperability.  The upper bound comes from
17872 applications using the Mozilla Network Security Services (NSS) library, which
17873 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17874 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17875 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17876 acceptable bound from 1024 to 2048.
17877
17878
17879 .option tls_eccurve main string&!! &`auto`&
17880 .cindex TLS "EC cryptography"
17881 This option selects a EC curve for use by Exim when used with OpenSSL.
17882 It has no effect when Exim is used with GnuTLS.
17883
17884 After expansion it must contain a valid EC curve parameter, such as
17885 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17886 for valid selections.
17887
17888 For OpenSSL versions before (and not including) 1.0.2, the string
17889 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17890 &`auto`& tells the library to choose.
17891
17892 If the option expands to an empty string, no EC curves will be enabled.
17893
17894
17895 .option tls_ocsp_file main string&!! unset
17896 .cindex TLS "certificate status"
17897 .cindex TLS "OCSP proof file"
17898 This option
17899 must if set expand to the absolute path to a file which contains a current
17900 status proof for the server's certificate, as obtained from the
17901 Certificate Authority.
17902
17903 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17904 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17905
17906 For OpenSSL 1.1.0 or later, and
17907 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17908 of files, to match a list given for the &%tls_certificate%& option.
17909 The ordering of the two lists must match.
17910 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17911
17912 The file(s) should be in DER format,
17913 except for GnuTLS 3.6.3 or later
17914 or for OpenSSL,
17915 when an optional filetype prefix can be used.
17916 The prefix must be one of "DER" or "PEM", followed by
17917 a single space.  If one is used it sets the format for subsequent
17918 files in the list; the initial format is DER.
17919 If multiple proofs are wanted, for multiple chain elements
17920 (this only works under TLS1.3)
17921 they must be coded as a combined OCSP response.
17922
17923 Although GnuTLS will accept PEM files with multiple separate
17924 PEM blobs (ie. separate OCSP responses), it sends them in the
17925 TLS Certificate record interleaved with the certificates of the chain;
17926 although a GnuTLS client is happy with that, an OpenSSL client is not.
17927
17928 .option tls_on_connect_ports main "string list" unset
17929 .cindex SSMTP
17930 .cindex SMTPS
17931 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17932 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17933 set up without waiting for the client to issue a STARTTLS command. For
17934 further details, see section &<<SECTsupobssmt>>&.
17935
17936
17937
17938 .option tls_privatekey main string list&!! unset
17939 .cindex "TLS" "server private key; location of"
17940 The value of this option is expanded, and must then be a list of absolute paths to
17941 files which contains the server's private keys.
17942 If this option is unset, or if
17943 the expansion is forced to fail, or the result is an empty string, the private
17944 key is assumed to be in the same file as the server's certificates. See chapter
17945 &<<CHAPTLS>>& for further details.
17946
17947 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17948
17949
17950 .option tls_remember_esmtp main boolean false
17951 .cindex "TLS" "esmtp state; remembering"
17952 .cindex "TLS" "broken clients"
17953 If this option is set true, Exim violates the RFCs by remembering that it is in
17954 &"esmtp"& state after successfully negotiating a TLS session. This provides
17955 support for broken clients that fail to send a new EHLO after starting a
17956 TLS session.
17957
17958
17959 .option tls_require_ciphers main string&!! unset
17960 .cindex "TLS" "requiring specific ciphers"
17961 .cindex "cipher" "requiring specific"
17962 This option controls which ciphers can be used for incoming TLS connections.
17963 The &(smtp)& transport has an option of the same name for controlling outgoing
17964 connections. This option is expanded for each connection, so can be varied for
17965 different clients if required. The value of this option must be a list of
17966 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17967 in somewhat different ways. If GnuTLS is being used, the client controls the
17968 preference order of the available ciphers. Details are given in sections
17969 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17970
17971
17972 .option tls_try_verify_hosts main "host list&!!" unset
17973 .cindex "TLS" "client certificate verification"
17974 .cindex "certificate" "verification of client"
17975 See &%tls_verify_hosts%& below.
17976
17977
17978 .option tls_verify_certificates main string&!! system
17979 .cindex "TLS" "client certificate verification"
17980 .cindex "certificate" "verification of client"
17981 The value of this option is expanded, and must then be either the
17982 word "system"
17983 or the absolute path to
17984 a file or directory containing permitted certificates for clients that
17985 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17986
17987 The "system" value for the option will use a
17988 system default location compiled into the SSL library.
17989 This is not available for GnuTLS versions preceding 3.0.20,
17990 and will be taken as empty; an explicit location
17991 must be specified.
17992
17993 The use of a directory for the option value is not available for GnuTLS versions
17994 preceding 3.3.6 and a single file must be used.
17995
17996 With OpenSSL the certificates specified
17997 explicitly
17998 either by file or directory
17999 are added to those given by the system default location.
18000
18001 These certificates should be for the certificate authorities trusted, rather
18002 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18003 the value is a file then the certificates are sent by Exim as a server to
18004 connecting clients, defining the list of accepted certificate authorities.
18005 Thus the values defined should be considered public data.  To avoid this,
18006 use the explicit directory version.
18007
18008 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18009
18010 A forced expansion failure or setting to an empty string is equivalent to
18011 being unset.
18012
18013
18014 .option tls_verify_hosts main "host list&!!" unset
18015 .cindex "TLS" "client certificate verification"
18016 .cindex "certificate" "verification of client"
18017 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18018 certificates from clients. The expected certificates are defined by
18019 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18020 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18021 &%tls_verify_certificates%& is not set.
18022
18023 Any client that matches &%tls_verify_hosts%& is constrained by
18024 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18025 present one of the listed certificates. If it does not, the connection is
18026 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18027 the host to use TLS. It can still send SMTP commands through unencrypted
18028 connections. Forcing a client to use TLS has to be done separately using an
18029 ACL to reject inappropriate commands when the connection is not encrypted.
18030
18031 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18032 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18033 certificate and checks it against &%tls_verify_certificates%&, but does not
18034 abort the connection if there is no certificate or if it does not match. This
18035 state can be detected in an ACL, which makes it possible to implement policies
18036 such as &"accept for relay only if a verified certificate has been received,
18037 but accept for local delivery if encrypted, even without a verified
18038 certificate"&.
18039
18040 Client hosts that match neither of these lists are not asked to present
18041 certificates.
18042
18043
18044 .option trusted_groups main "string list&!!" unset
18045 .cindex "trusted groups"
18046 .cindex "groups" "trusted"
18047 This option is expanded just once, at the start of Exim's processing. If this
18048 option is set, any process that is running in one of the listed groups, or
18049 which has one of them as a supplementary group, is trusted. The groups can be
18050 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18051 details of what trusted callers are permitted to do. If neither
18052 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18053 are trusted.
18054
18055 .option trusted_users main "string list&!!" unset
18056 .cindex "trusted users"
18057 .cindex "user" "trusted"
18058 This option is expanded just once, at the start of Exim's processing. If this
18059 option is set, any process that is running as one of the listed users is
18060 trusted. The users can be specified numerically or by name. See section
18061 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18062 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18063 Exim user are trusted.
18064
18065 .option unknown_login main string&!! unset
18066 .cindex "uid (user id)" "unknown caller"
18067 .vindex "&$caller_uid$&"
18068 This is a specialized feature for use in unusual configurations. By default, if
18069 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18070 gives up. The &%unknown_login%& option can be used to set a login name to be
18071 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18072 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18073 is used for the user's real name (gecos field), unless this has been set by the
18074 &%-F%& option.
18075
18076 .option unknown_username main string unset
18077 See &%unknown_login%&.
18078
18079 .option untrusted_set_sender main "address list&!!" unset
18080 .cindex "trusted users"
18081 .cindex "sender" "setting by untrusted user"
18082 .cindex "untrusted user setting sender"
18083 .cindex "user" "untrusted setting sender"
18084 .cindex "envelope from"
18085 .cindex "envelope sender"
18086 When an untrusted user submits a message to Exim using the standard input, Exim
18087 normally creates an envelope sender address from the user's login and the
18088 default qualification domain. Data from the &%-f%& option (for setting envelope
18089 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18090 is used) is ignored.
18091
18092 However, untrusted users are permitted to set an empty envelope sender address,
18093 to declare that a message should never generate any bounces. For example:
18094 .code
18095 exim -f '<>' user@domain.example
18096 .endd
18097 .vindex "&$sender_ident$&"
18098 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18099 other envelope sender addresses in a controlled way. When it is set, untrusted
18100 users are allowed to set envelope sender addresses that match any of the
18101 patterns in the list. Like all address lists, the string is expanded. The
18102 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18103 users to setting senders that start with their login ids
18104 followed by a hyphen
18105 by a setting like this:
18106 .code
18107 untrusted_set_sender = ^$sender_ident-
18108 .endd
18109 If you want to allow untrusted users to set envelope sender addresses without
18110 restriction, you can use
18111 .code
18112 untrusted_set_sender = *
18113 .endd
18114 The &%untrusted_set_sender%& option applies to all forms of local input, but
18115 only to the setting of the envelope sender. It does not permit untrusted users
18116 to use the other options which trusted user can use to override message
18117 parameters. Furthermore, it does not stop Exim from removing an existing
18118 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18119 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18120 overriding these actions. The handling of the &'Sender:'& header is also
18121 described in section &<<SECTthesenhea>>&.
18122
18123 The log line for a message's arrival shows the envelope sender following
18124 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18125 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18126 envelope sender address, the user's login is shown in parentheses after the
18127 sender address.
18128
18129
18130 .option uucp_from_pattern main string "see below"
18131 .cindex "&""From""& line"
18132 .cindex "UUCP" "&""From""& line"
18133 Some applications that pass messages to an MTA via a command line interface use
18134 an initial line starting with &"From&~"& to pass the envelope sender. In
18135 particular, this is used by UUCP software. Exim recognizes such a line by means
18136 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18137 matches, the sender address is constructed by expanding the contents of
18138 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18139 default pattern recognizes lines in the following two forms:
18140 .code
18141 From ph10 Fri Jan  5 12:35 GMT 1996
18142 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18143 .endd
18144 The pattern can be seen by running
18145 .code
18146 exim -bP uucp_from_pattern
18147 .endd
18148 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18149 year in the second case. The first word after &"From&~"& is matched in the
18150 regular expression by a parenthesized subpattern. The default value for
18151 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18152 (&"ph10"& in the example above) as the message's sender. See also
18153 &%ignore_fromline_hosts%&.
18154
18155
18156 .option uucp_from_sender main string&!! &`$1`&
18157 See &%uucp_from_pattern%& above.
18158
18159
18160 .option warn_message_file main string unset
18161 .cindex "warning of delay" "customizing the message"
18162 .cindex "customizing" "warning message"
18163 This option defines a template file containing paragraphs of text to be used
18164 for constructing the warning message which is sent by Exim when a message has
18165 been in the queue for a specified amount of time, as specified by
18166 &%delay_warning%&. Details of the file's contents are given in chapter
18167 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18168
18169
18170 .option write_rejectlog main boolean true
18171 .cindex "reject log" "disabling"
18172 If this option is set false, Exim no longer writes anything to the reject log.
18173 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18174 .ecindex IIDconfima
18175 .ecindex IIDmaiconf
18176
18177
18178
18179
18180 . ////////////////////////////////////////////////////////////////////////////
18181 . ////////////////////////////////////////////////////////////////////////////
18182
18183 .chapter "Generic options for routers" "CHAProutergeneric"
18184 .scindex IIDgenoprou1 "options" "generic; for routers"
18185 .scindex IIDgenoprou2 "generic options" "router"
18186 This chapter describes the generic options that apply to all routers.
18187 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18188
18189 For a general description of how a router operates, see sections
18190 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18191 which the preconditions are tested. The order of expansion of the options that
18192 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18193 &%headers_remove%&, &%transport%&.
18194
18195
18196
18197 .option address_data routers string&!! unset
18198 .cindex "router" "data attached to address"
18199 The string is expanded just before the router is run, that is, after all the
18200 precondition tests have succeeded. If the expansion is forced to fail, the
18201 router declines, the value of &%address_data%& remains unchanged, and the
18202 &%more%& option controls what happens next. Other expansion failures cause
18203 delivery of the address to be deferred.
18204
18205 .vindex "&$address_data$&"
18206 When the expansion succeeds, the value is retained with the address, and can be
18207 accessed using the variable &$address_data$& in the current router, subsequent
18208 routers, and the eventual transport.
18209
18210 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18211 that runs a user's filter file, the contents of &$address_data$& are accessible
18212 in the filter. This is not normally a problem, because such data is usually
18213 either not confidential or it &"belongs"& to the current user, but if you do
18214 put confidential data into &$address_data$& you need to remember this point.
18215
18216 Even if the router declines or passes, the value of &$address_data$& remains
18217 with the address, though it can be changed by another &%address_data%& setting
18218 on a subsequent router. If a router generates child addresses, the value of
18219 &$address_data$& propagates to them. This also applies to the special kind of
18220 &"child"& that is generated by a router with the &%unseen%& option.
18221
18222 The idea of &%address_data%& is that you can use it to look up a lot of data
18223 for the address once, and then pick out parts of the data later. For example,
18224 you could use a single LDAP lookup to return a string of the form
18225 .code
18226 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18227 .endd
18228 In the transport you could pick out the mailbox by a setting such as
18229 .code
18230 file = ${extract{mailbox}{$address_data}}
18231 .endd
18232 This makes the configuration file less messy, and also reduces the number of
18233 lookups (though Exim does cache lookups).
18234
18235 See also the &%set%& option below.
18236
18237 .vindex "&$sender_address_data$&"
18238 .vindex "&$address_data$&"
18239 The &%address_data%& facility is also useful as a means of passing information
18240 from one router to another, and from a router to a transport. In addition, if
18241 &$address_data$& is set by a router when verifying a recipient address from an
18242 ACL, it remains available for use in the rest of the ACL statement. After
18243 verifying a sender, the value is transferred to &$sender_address_data$&.
18244
18245
18246
18247 .option address_test routers&!? boolean true
18248 .oindex "&%-bt%&"
18249 .cindex "router" "skipping when address testing"
18250 If this option is set false, the router is skipped when routing is being tested
18251 by means of the &%-bt%& command line option. This can be a convenience when
18252 your first router sends messages to an external scanner, because it saves you
18253 having to set the &"already scanned"& indicator when testing real address
18254 routing.
18255
18256
18257
18258 .option cannot_route_message routers string&!! unset
18259 .cindex "router" "customizing &""cannot route""& message"
18260 .cindex "customizing" "&""cannot route""& message"
18261 This option specifies a text message that is used when an address cannot be
18262 routed because Exim has run out of routers. The default message is
18263 &"Unrouteable address"&. This option is useful only on routers that have
18264 &%more%& set false, or on the very last router in a configuration, because the
18265 value that is used is taken from the last router that is considered. This
18266 includes a router that is skipped because its preconditions are not met, as
18267 well as a router that declines. For example, using the default configuration,
18268 you could put:
18269 .code
18270 cannot_route_message = Remote domain not found in DNS
18271 .endd
18272 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18273 and
18274 .code
18275 cannot_route_message = Unknown local user
18276 .endd
18277 on the final router that checks for local users. If string expansion fails for
18278 this option, the default message is used. Unless the expansion failure was
18279 explicitly forced, a message about the failure is written to the main and panic
18280 logs, in addition to the normal message about the routing failure.
18281
18282
18283 .option caseful_local_part routers boolean false
18284 .cindex "case of local parts"
18285 .cindex "router" "case of local parts"
18286 By default, routers handle the local parts of addresses in a case-insensitive
18287 manner, though the actual case is preserved for transmission with the message.
18288 If you want the case of letters to be significant in a router, you must set
18289 this option true. For individual router options that contain address or local
18290 part lists (for example, &%local_parts%&), case-sensitive matching can be
18291 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18292 more details.
18293
18294 .vindex "&$local_part$&"
18295 .vindex "&$original_local_part$&"
18296 .vindex "&$parent_local_part$&"
18297 The value of the &$local_part$& variable is forced to lower case while a
18298 router is running unless &%caseful_local_part%& is set. When a router assigns
18299 an address to a transport, the value of &$local_part$& when the transport runs
18300 is the same as it was in the router. Similarly, when a router generates child
18301 addresses by aliasing or forwarding, the values of &$original_local_part$&
18302 and &$parent_local_part$& are those that were used by the redirecting router.
18303
18304 This option applies to the processing of an address by a router. When a
18305 recipient address is being processed in an ACL, there is a separate &%control%&
18306 modifier that can be used to specify case-sensitive processing within the ACL
18307 (see section &<<SECTcontrols>>&).
18308
18309
18310
18311 .option check_local_user routers&!? boolean false
18312 .cindex "local user, checking in router"
18313 .cindex "router" "checking for local user"
18314 .cindex "&_/etc/passwd_&"
18315 .vindex "&$home$&"
18316 When this option is true, Exim checks that the local part of the recipient
18317 address (with affixes removed if relevant) is the name of an account on the
18318 local system. The check is done by calling the &[getpwnam()]& function rather
18319 than trying to read &_/etc/passwd_& directly. This means that other methods of
18320 holding password data (such as NIS) are supported. If the local part is a local
18321 user, &$home$& is set from the password data, and can be tested in other
18322 preconditions that are evaluated after this one (the order of evaluation is
18323 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18324 overridden by &%router_home_directory%&. If the local part is not a local user,
18325 the router is skipped.
18326
18327 If you want to check that the local part is either the name of a local user
18328 or matches something else, you cannot combine &%check_local_user%& with a
18329 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18330 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18331 setting to achieve this. For example:
18332 .code
18333 local_parts = passwd;$local_part : lsearch;/etc/other/users
18334 .endd
18335 Note, however, that the side effects of &%check_local_user%& (such as setting
18336 up a home directory) do not occur when a &(passwd)& lookup is used in a
18337 &%local_parts%& (or any other) precondition.
18338
18339
18340
18341 .option condition routers&!? string&!! unset
18342 .cindex "router" "customized precondition"
18343 This option specifies a general precondition test that has to succeed for the
18344 router to be called. The &%condition%& option is the last precondition to be
18345 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18346 result is a forced failure, or an empty string, or one of the strings &"0"& or
18347 &"no"& or &"false"& (checked without regard to the case of the letters), the
18348 router is skipped, and the address is offered to the next one.
18349
18350 If the result is any other value, the router is run (as this is the last
18351 precondition to be evaluated, all the other preconditions must be true).
18352
18353 This option is unusual in that multiple &%condition%& options may be present.
18354 All &%condition%& options must succeed.
18355
18356 The &%condition%& option provides a means of applying custom conditions to the
18357 running of routers. Note that in the case of a simple conditional expansion,
18358 the default expansion values are exactly what is wanted. For example:
18359 .code
18360 condition = ${if >{$message_age}{600}}
18361 .endd
18362 Because of the default behaviour of the string expansion, this is equivalent to
18363 .code
18364 condition = ${if >{$message_age}{600}{true}{}}
18365 .endd
18366
18367 A multiple condition example, which succeeds:
18368 .code
18369 condition = ${if >{$message_age}{600}}
18370 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18371 condition = foobar
18372 .endd
18373
18374 If the expansion fails (other than forced failure) delivery is deferred. Some
18375 of the other precondition options are common special cases that could in fact
18376 be specified using &%condition%&.
18377
18378 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18379 are far older, and use one set of semantics.  ACLs are newer and when
18380 they were created, the ACL &%condition%& process was given far stricter
18381 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18382 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18383 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18384 Router rules processing behavior.
18385
18386 This is best illustrated in an example:
18387 .code
18388 # If used in an ACL condition will fail with a syntax error, but
18389 # in a router condition any extra characters are treated as a string
18390
18391 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18392 true {yes} {no}}
18393
18394 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18395  {yes} {no}}
18396 .endd
18397 In each example above, the &%if%& statement actually ends after
18398 &"{google.com}}"&.  Since no true or false braces were defined, the
18399 default &%if%& behavior is to return a boolean true or a null answer
18400 (which evaluates to false). The rest of the line is then treated as a
18401 string. So the first example resulted in the boolean answer &"true"&
18402 with the string &" {yes} {no}}"& appended to it. The second example
18403 resulted in the null output (indicating false) with the string
18404 &" {yes} {no}}"& appended to it.
18405
18406 In fact you can put excess forward braces in too.  In the router
18407 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18408 mean something, like after a &"$"& or when required as part of a
18409 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18410 string characters.
18411
18412 Thus, in a Router, the above expansion strings will both always evaluate
18413 true, as the result of expansion is a non-empty string which doesn't
18414 match an explicit false value.  This can be tricky to debug.  By
18415 contrast, in an ACL either of those strings will always result in an
18416 expansion error because the result doesn't look sufficiently boolean.
18417
18418
18419 .option debug_print routers string&!! unset
18420 .cindex "testing" "variables in drivers"
18421 If this option is set and debugging is enabled (see the &%-d%& command line
18422 option) or in address-testing mode (see the &%-bt%& command line option),
18423 the string is expanded and included in the debugging output.
18424 If expansion of the string fails, the error message is written to the debugging
18425 output, and Exim carries on processing.
18426 This option is provided to help with checking out the values of variables and
18427 so on when debugging router configurations. For example, if a &%condition%&
18428 option appears not to be working, &%debug_print%& can be used to output the
18429 variables it references. The output happens after checks for &%domains%&,
18430 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18431 are tested. A newline is added to the text if it does not end with one.
18432 The variable &$router_name$& contains the name of the router.
18433
18434
18435
18436 .option disable_logging routers boolean false
18437 If this option is set true, nothing is logged for any routing errors
18438 or for any deliveries caused by this router. You should not set this option
18439 unless you really, really know what you are doing. See also the generic
18440 transport option of the same name.
18441
18442 .option dnssec_request_domains routers "domain list&!!" *
18443 .cindex "MX record" "security"
18444 .cindex "DNSSEC" "MX lookup"
18445 .cindex "security" "MX lookup"
18446 .cindex "DNS" "DNSSEC"
18447 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18448 the dnssec request bit set.
18449 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18450
18451 .option dnssec_require_domains routers "domain list&!!" unset
18452 .cindex "MX record" "security"
18453 .cindex "DNSSEC" "MX lookup"
18454 .cindex "security" "MX lookup"
18455 .cindex "DNS" "DNSSEC"
18456 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18457 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18458 (AD bit) set will be ignored and logged as a host-lookup failure.
18459 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18460
18461
18462 .option domains routers&!? "domain list&!!" unset
18463 .cindex "router" "restricting to specific domains"
18464 .vindex "&$domain_data$&"
18465 If this option is set, the router is skipped unless the current domain matches
18466 the list. If the match is achieved by means of a file lookup, the data that the
18467 lookup returned for the domain is placed in &$domain_data$& for use in string
18468 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18469 a list of the order in which preconditions are evaluated.
18470
18471
18472
18473 .option driver routers string unset
18474 This option must always be set. It specifies which of the available routers is
18475 to be used.
18476
18477
18478 .option dsn_lasthop routers boolean false
18479 .cindex "DSN" "success"
18480 .cindex "Delivery Status Notification" "success"
18481 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18482 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18483 instead send a success DSN as if the next hop does not support DSN.
18484 Not effective on redirect routers.
18485
18486
18487
18488 .option errors_to routers string&!! unset
18489 .cindex "envelope from"
18490 .cindex "envelope sender"
18491 .cindex "router" "changing address for errors"
18492 If a router successfully handles an address, it may assign the address to a
18493 transport for delivery or it may generate child addresses. In both cases, if
18494 there is a delivery problem during later processing, the resulting bounce
18495 message is sent to the address that results from expanding this string,
18496 provided that the address verifies successfully. The &%errors_to%& option is
18497 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18498
18499 The &%errors_to%& setting associated with an address can be overridden if it
18500 subsequently passes through other routers that have their own &%errors_to%&
18501 settings, or if the message is delivered by a transport with a &%return_path%&
18502 setting.
18503
18504 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18505 the expansion fails to verify, the errors address associated with the incoming
18506 address is used. At top level, this is the envelope sender. A non-forced
18507 expansion failure causes delivery to be deferred.
18508
18509 If an address for which &%errors_to%& has been set ends up being delivered over
18510 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18511 any bounces that are generated by other MTAs on the delivery route are also
18512 sent there. You can set &%errors_to%& to the empty string by either of these
18513 settings:
18514 .code
18515 errors_to =
18516 errors_to = ""
18517 .endd
18518 An expansion item that yields an empty string has the same effect. If you do
18519 this, a locally detected delivery error for addresses processed by this router
18520 no longer gives rise to a bounce message; the error is discarded. If the
18521 address is delivered to a remote host, the return path is set to &`<>`&, unless
18522 overridden by the &%return_path%& option on the transport.
18523
18524 .vindex "&$address_data$&"
18525 If for some reason you want to discard local errors, but use a non-empty
18526 MAIL command for remote delivery, you can preserve the original return
18527 path in &$address_data$& in the router, and reinstate it in the transport by
18528 setting &%return_path%&.
18529
18530 The most common use of &%errors_to%& is to direct mailing list bounces to the
18531 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18532 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18533
18534
18535
18536 .option expn routers&!? boolean true
18537 .cindex "address" "testing"
18538 .cindex "testing" "addresses"
18539 .cindex "EXPN" "router skipping"
18540 .cindex "router" "skipping for EXPN"
18541 If this option is turned off, the router is skipped when testing an address
18542 as a result of processing an SMTP EXPN command. You might, for example,
18543 want to turn it off on a router for users' &_.forward_& files, while leaving it
18544 on for the system alias file.
18545 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18546 are evaluated.
18547
18548 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18549 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18550 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18551
18552
18553
18554 .option fail_verify routers boolean false
18555 .cindex "router" "forcing verification failure"
18556 Setting this option has the effect of setting both &%fail_verify_sender%& and
18557 &%fail_verify_recipient%& to the same value.
18558
18559
18560
18561 .option fail_verify_recipient routers boolean false
18562 If this option is true and an address is accepted by this router when
18563 verifying a recipient, verification fails.
18564
18565
18566
18567 .option fail_verify_sender routers boolean false
18568 If this option is true and an address is accepted by this router when
18569 verifying a sender, verification fails.
18570
18571
18572
18573 .option fallback_hosts routers "string list" unset
18574 .cindex "router" "fallback hosts"
18575 .cindex "fallback" "hosts specified on router"
18576 String expansion is not applied to this option. The argument must be a
18577 colon-separated list of host names or IP addresses. The list separator can be
18578 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18579 each name or address. In fact, the format of each item is exactly the same as
18580 defined for the list of hosts in a &(manualroute)& router (see section
18581 &<<SECTformatonehostitem>>&).
18582
18583 If a router queues an address for a remote transport, this host list is
18584 associated with the address, and used instead of the transport's fallback host
18585 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18586 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18587 transport for further details.
18588
18589
18590 .option group routers string&!! "see below"
18591 .cindex "gid (group id)" "local delivery"
18592 .cindex "local transports" "uid and gid"
18593 .cindex "transport" "local"
18594 .cindex "router" "setting group"
18595 When a router queues an address for a transport, and the transport does not
18596 specify a group, the group given here is used when running the delivery
18597 process.
18598 The group may be specified numerically or by name. If expansion fails, the
18599 error is logged and delivery is deferred.
18600 The default is unset, unless &%check_local_user%& is set, when the default
18601 is taken from the password information. See also &%initgroups%& and &%user%&
18602 and the discussion in chapter &<<CHAPenvironment>>&.
18603
18604
18605
18606 .option headers_add routers list&!! unset
18607 .cindex "header lines" "adding"
18608 .cindex "router" "adding header lines"
18609 This option specifies a list of text headers,
18610 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18611 that is associated with any addresses that are accepted by the router.
18612 Each item is separately expanded, at routing time.  However, this
18613 option has no effect when an address is just being verified. The way in which
18614 the text is used to add header lines at transport time is described in section
18615 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18616 message is in the process of being transported. This means that references to
18617 header lines in string expansions in the transport's configuration do not
18618 &"see"& the added header lines.
18619
18620 The &%headers_add%& option is expanded after &%errors_to%&, but before
18621 &%headers_remove%& and &%transport%&. If an item is empty, or if
18622 an item expansion is forced to fail, the item has no effect. Other expansion
18623 failures are treated as configuration errors.
18624
18625 Unlike most options, &%headers_add%& can be specified multiple times
18626 for a router; all listed headers are added.
18627
18628 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18629 router that has the &%one_time%& option set.
18630
18631 .cindex "duplicate addresses"
18632 .oindex "&%unseen%&"
18633 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18634 additions are deleted when the address is passed on to subsequent routers.
18635 For a &%redirect%& router, if a generated address is the same as the incoming
18636 address, this can lead to duplicate addresses with different header
18637 modifications. Exim does not do duplicate deliveries (except, in certain
18638 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18639 which of the duplicates is discarded, so this ambiguous situation should be
18640 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18641
18642
18643
18644 .option headers_remove routers list&!! unset
18645 .cindex "header lines" "removing"
18646 .cindex "router" "removing header lines"
18647 This option specifies a list of text headers,
18648 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18649 that is associated with any addresses that are accepted by the router.
18650 Each item is separately expanded, at routing time.  However, this
18651 option has no effect when an address is just being verified. The way in which
18652 the text is used to remove header lines at transport time is described in
18653 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18654 the message is in the process of being transported. This means that references
18655 to header lines in string expansions in the transport's configuration still
18656 &"see"& the original header lines.
18657
18658 The &%headers_remove%& option is expanded after &%errors_to%& and
18659 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18660 the item has no effect. Other expansion failures are treated as configuration
18661 errors.
18662
18663 Unlike most options, &%headers_remove%& can be specified multiple times
18664 for a router; all listed headers are removed.
18665
18666 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18667 router that has the &%one_time%& option set.
18668
18669 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18670 removal requests are deleted when the address is passed on to subsequent
18671 routers, and this can lead to problems with duplicates -- see the similar
18672 warning for &%headers_add%& above.
18673
18674 &*Warning 3*&: Because of the separate expansion of the list items,
18675 items that contain a list separator must have it doubled.
18676 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18677
18678
18679
18680 .option ignore_target_hosts routers "host list&!!" unset
18681 .cindex "IP address" "discarding"
18682 .cindex "router" "discarding IP addresses"
18683 Although this option is a host list, it should normally contain IP address
18684 entries rather than names. If any host that is looked up by the router has an
18685 IP address that matches an item in this list, Exim behaves as if that IP
18686 address did not exist. This option allows you to cope with rogue DNS entries
18687 like
18688 .code
18689 remote.domain.example.  A  127.0.0.1
18690 .endd
18691 by setting
18692 .code
18693 ignore_target_hosts = 127.0.0.1
18694 .endd
18695 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18696 discarded in this way, the router declines. In a conventional configuration, an
18697 attempt to mail to such a domain would normally provoke the &"unrouteable
18698 domain"& error, and an attempt to verify an address in the domain would fail.
18699 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18700 router declines if presented with one of the listed addresses.
18701
18702 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18703 means of the first or the second of the following settings, respectively:
18704 .code
18705 ignore_target_hosts = 0.0.0.0/0
18706 ignore_target_hosts = <; 0::0/0
18707 .endd
18708 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18709 in the second line matches all IPv6 addresses.
18710
18711 This option may also be useful for ignoring link-local and site-local IPv6
18712 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18713 is expanded before use as a list, it is possible to make it dependent on the
18714 domain that is being routed.
18715
18716 .vindex "&$host_address$&"
18717 During its expansion, &$host_address$& is set to the IP address that is being
18718 checked.
18719
18720 .option initgroups routers boolean false
18721 .cindex "additional groups"
18722 .cindex "groups" "additional"
18723 .cindex "local transports" "uid and gid"
18724 .cindex "transport" "local"
18725 If the router queues an address for a transport, and this option is true, and
18726 the uid supplied by the router is not overridden by the transport, the
18727 &[initgroups()]& function is called when running the transport to ensure that
18728 any additional groups associated with the uid are set up. See also &%group%&
18729 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18730
18731
18732
18733 .option local_part_prefix routers&!? "string list" unset
18734 .cindex affix "router precondition"
18735 .cindex "router" "prefix for local part"
18736 .cindex "prefix" "for local part, used in router"
18737 If this option is set, the router is skipped unless the local part starts with
18738 one of the given strings, or &%local_part_prefix_optional%& is true. See
18739 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18740 evaluated.
18741
18742 The list is scanned from left to right, and the first prefix that matches is
18743 used. A limited form of wildcard is available; if the prefix begins with an
18744 asterisk, it matches the longest possible sequence of arbitrary characters at
18745 the start of the local part. An asterisk should therefore always be followed by
18746 some character that does not occur in normal local parts.
18747 .cindex "multiple mailboxes"
18748 .cindex "mailbox" "multiple"
18749 Wildcarding can be used to set up multiple user mailboxes, as described in
18750 section &<<SECTmulbox>>&.
18751
18752 .vindex "&$local_part$&"
18753 .vindex "&$local_part_prefix$&"
18754 During the testing of the &%local_parts%& option, and while the router is
18755 running, the prefix is removed from the local part, and is available in the
18756 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18757 the router accepts the address, this remains true during subsequent delivery by
18758 a transport. In particular, the local part that is transmitted in the RCPT
18759 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18760 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18761 the relevant transport.
18762
18763 When an address is being verified, &%local_part_prefix%& affects only the
18764 behaviour of the router. If the callout feature of verification is in use, this
18765 means that the full address, including the prefix, will be used during the
18766 callout.
18767
18768 The prefix facility is commonly used to handle local parts of the form
18769 &%owner-something%&. Another common use is to support local parts of the form
18770 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18771 to tell a user their forwarding is broken &-- by placing a router like this one
18772 immediately before the router that handles &_.forward_& files:
18773 .code
18774 real_localuser:
18775   driver = accept
18776   local_part_prefix = real-
18777   check_local_user
18778   transport = local_delivery
18779 .endd
18780 For security, it would probably be a good idea to restrict the use of this
18781 router to locally-generated messages, using a condition such as this:
18782 .code
18783   condition = ${if match {$sender_host_address}\
18784                          {\N^(|127\.0\.0\.1)$\N}}
18785 .endd
18786
18787 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18788 both conditions must be met if not optional. Care must be taken if wildcards
18789 are used in both a prefix and a suffix on the same router. Different
18790 separator characters must be used to avoid ambiguity.
18791
18792
18793 .option local_part_prefix_optional routers boolean false
18794 See &%local_part_prefix%& above.
18795
18796
18797
18798 .option local_part_suffix routers&!? "string list" unset
18799 .cindex "router" "suffix for local part"
18800 .cindex "suffix for local part" "used in router"
18801 This option operates in the same way as &%local_part_prefix%&, except that the
18802 local part must end (rather than start) with the given string, the
18803 &%local_part_suffix_optional%& option determines whether the suffix is
18804 mandatory, and the wildcard * character, if present, must be the last
18805 character of the suffix. This option facility is commonly used to handle local
18806 parts of the form &%something-request%& and multiple user mailboxes of the form
18807 &%username-foo%&.
18808
18809
18810 .option local_part_suffix_optional routers boolean false
18811 See &%local_part_suffix%& above.
18812
18813
18814
18815 .option local_parts routers&!? "local part list&!!" unset
18816 .cindex "router" "restricting to specific local parts"
18817 .cindex "local part" "checking in router"
18818 The router is run only if the local part of the address matches the list.
18819 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18820 are evaluated, and
18821 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18822 string is expanded, it is possible to make it depend on the domain, for
18823 example:
18824 .code
18825 local_parts = dbm;/usr/local/specials/$domain
18826 .endd
18827 .vindex "&$local_part_data$&"
18828 If the match is achieved by a lookup, the data that the lookup returned
18829 for the local part is placed in the variable &$local_part_data$& for use in
18830 expansions of the router's private options. You might use this option, for
18831 example, if you have a large number of local virtual domains, and you want to
18832 send all postmaster mail to the same place without having to set up an alias in
18833 each virtual domain:
18834 .code
18835 postmaster:
18836   driver = redirect
18837   local_parts = postmaster
18838   data = postmaster@real.domain.example
18839 .endd
18840
18841
18842 .option log_as_local routers boolean "see below"
18843 .cindex "log" "delivery line"
18844 .cindex "delivery" "log line format"
18845 Exim has two logging styles for delivery, the idea being to make local
18846 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18847 recipient address is given just as the local part, without a domain. The use of
18848 this style is controlled by this option. It defaults to true for the &(accept)&
18849 router, and false for all the others. This option applies only when a
18850 router assigns an address to a transport. It has no effect on routers that
18851 redirect addresses.
18852
18853
18854
18855 .option more routers boolean&!! true
18856 The result of string expansion for this option must be a valid boolean value,
18857 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18858 result causes an error, and delivery is deferred. If the expansion is forced to
18859 fail, the default value for the option (true) is used. Other failures cause
18860 delivery to be deferred.
18861
18862 If this option is set false, and the router declines to handle the address, no
18863 further routers are tried, routing fails, and the address is bounced.
18864 .oindex "&%self%&"
18865 However, if the router explicitly passes an address to the following router by
18866 means of the setting
18867 .code
18868 self = pass
18869 .endd
18870 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18871 does not affect the behaviour if one of the precondition tests fails. In that
18872 case, the address is always passed to the next router.
18873
18874 Note that &%address_data%& is not considered to be a precondition. If its
18875 expansion is forced to fail, the router declines, and the value of &%more%&
18876 controls what happens next.
18877
18878
18879 .option pass_on_timeout routers boolean false
18880 .cindex "timeout" "of router"
18881 .cindex "router" "timeout"
18882 If a router times out during a host lookup, it normally causes deferral of the
18883 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18884 router, overriding &%no_more%&. This may be helpful for systems that are
18885 intermittently connected to the Internet, or those that want to pass to a smart
18886 host any messages that cannot immediately be delivered.
18887
18888 There are occasional other temporary errors that can occur while doing DNS
18889 lookups. They are treated in the same way as a timeout, and this option
18890 applies to all of them.
18891
18892
18893
18894 .option pass_router routers string unset
18895 .cindex "router" "go to after &""pass""&"
18896 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18897 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18898 routing to continue, and overriding a false setting of &%more%&. When one of
18899 these routers returns &"pass"&, the address is normally handed on to the next
18900 router in sequence. This can be changed by setting &%pass_router%& to the name
18901 of another router. However (unlike &%redirect_router%&) the named router must
18902 be below the current router, to avoid loops. Note that this option applies only
18903 to the special case of &"pass"&. It does not apply when a router returns
18904 &"decline"& because it cannot handle an address.
18905
18906
18907
18908 .option redirect_router routers string unset
18909 .cindex "router" "start at after redirection"
18910 Sometimes an administrator knows that it is pointless to reprocess addresses
18911 generated from alias or forward files with the same router again. For
18912 example, if an alias file translates real names into login ids there is no
18913 point searching the alias file a second time, especially if it is a large file.
18914
18915 The &%redirect_router%& option can be set to the name of any router instance.
18916 It causes the routing of any generated addresses to start at the named router
18917 instead of at the first router. This option has no effect if the router in
18918 which it is set does not generate new addresses.
18919
18920
18921
18922 .option require_files routers&!? "string list&!!" unset
18923 .cindex "file" "requiring for router"
18924 .cindex "router" "requiring file existence"
18925 This option provides a general mechanism for predicating the running of a
18926 router on the existence or non-existence of certain files or directories.
18927 Before running a router, as one of its precondition tests, Exim works its way
18928 through the &%require_files%& list, expanding each item separately.
18929
18930 Because the list is split before expansion, any colons in expansion items must
18931 be doubled, or the facility for using a different list separator must be used
18932 (&<<SECTlistsepchange>>&).
18933 If any expansion is forced to fail, the item is ignored. Other expansion
18934 failures cause routing of the address to be deferred.
18935
18936 If any expanded string is empty, it is ignored. Otherwise, except as described
18937 below, each string must be a fully qualified file path, optionally preceded by
18938 &"!"&. The paths are passed to the &[stat()]& function to test for the
18939 existence of the files or directories. The router is skipped if any paths not
18940 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18941
18942 .cindex "NFS"
18943 If &[stat()]& cannot determine whether a file exists or not, delivery of
18944 the message is deferred. This can happen when NFS-mounted filesystems are
18945 unavailable.
18946
18947 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18948 options, so you cannot use it to check for the existence of a file in which to
18949 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18950 full list of the order in which preconditions are evaluated.) However, as
18951 these options are all expanded, you can use the &%exists%& expansion condition
18952 to make such tests. The &%require_files%& option is intended for checking files
18953 that the router may be going to use internally, or which are needed by a
18954 transport (e.g., &_.procmailrc_&).
18955
18956 During delivery, the &[stat()]& function is run as root, but there is a
18957 facility for some checking of the accessibility of a file by another user.
18958 This is not a proper permissions check, but just a &"rough"& check that
18959 operates as follows:
18960
18961 If an item in a &%require_files%& list does not contain any forward slash
18962 characters, it is taken to be the user (and optional group, separated by a
18963 comma) to be checked for subsequent files in the list. If no group is specified
18964 but the user is specified symbolically, the gid associated with the uid is
18965 used. For example:
18966 .code
18967 require_files = mail:/some/file
18968 require_files = $local_part:$home/.procmailrc
18969 .endd
18970 If a user or group name in a &%require_files%& list does not exist, the
18971 &%require_files%& condition fails.
18972
18973 Exim performs the check by scanning along the components of the file path, and
18974 checking the access for the given uid and gid. It checks for &"x"& access on
18975 directories, and &"r"& access on the final file. Note that this means that file
18976 access control lists, if the operating system has them, are ignored.
18977
18978 &*Warning 1*&: When the router is being run to verify addresses for an
18979 incoming SMTP message, Exim is not running as root, but under its own uid. This
18980 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18981 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18982 user is not permitted to read one of the directories on the file's path.
18983
18984 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18985 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18986 without root access. In this case, if a check for access by a particular user
18987 is requested, Exim creates a subprocess that runs as that user, and tries the
18988 check again in that process.
18989
18990 The default action for handling an unresolved EACCES is to consider it to
18991 be caused by a configuration error, and routing is deferred because the
18992 existence or non-existence of the file cannot be determined. However, in some
18993 circumstances it may be desirable to treat this condition as if the file did
18994 not exist. If the filename (or the exclamation mark that precedes the filename
18995 for non-existence) is preceded by a plus sign, the EACCES error is treated
18996 as if the file did not exist. For example:
18997 .code
18998 require_files = +/some/file
18999 .endd
19000 If the router is not an essential part of verification (for example, it
19001 handles users' &_.forward_& files), another solution is to set the &%verify%&
19002 option false so that the router is skipped when verifying.
19003
19004
19005
19006 .option retry_use_local_part routers boolean "see below"
19007 .cindex "hints database" "retry keys"
19008 .cindex "local part" "in retry keys"
19009 When a delivery suffers a temporary routing failure, a retry record is created
19010 in Exim's hints database. For addresses whose routing depends only on the
19011 domain, the key for the retry record should not involve the local part, but for
19012 other addresses, both the domain and the local part should be included.
19013 Usually, remote routing is of the former kind, and local routing is of the
19014 latter kind.
19015
19016 This option controls whether the local part is used to form the key for retry
19017 hints for addresses that suffer temporary errors while being handled by this
19018 router. The default value is true for any router that has any of
19019 &%check_local_user%&,
19020 &%local_parts%&,
19021 &%condition%&,
19022 &%local_part_prefix%&,
19023 &%local_part_suffix%&,
19024 &%senders%& or
19025 &%require_files%&
19026 set, and false otherwise. Note that this option does not apply to hints keys
19027 for transport delays; they are controlled by a generic transport option of the
19028 same name.
19029
19030 Failing to set this option when it is needed
19031 (because a remote router handles only some of the local-parts for a domain)
19032 can result in incorrect error messages being generated.
19033
19034 The setting of &%retry_use_local_part%& applies only to the router on which it
19035 appears. If the router generates child addresses, they are routed
19036 independently; this setting does not become attached to them.
19037
19038
19039
19040 .option router_home_directory routers string&!! unset
19041 .cindex "router" "home directory for"
19042 .cindex "home directory" "for router"
19043 .vindex "&$home$&"
19044 This option sets a home directory for use while the router is running. (Compare
19045 &%transport_home_directory%&, which sets a home directory for later
19046 transporting.) In particular, if used on a &(redirect)& router, this option
19047 sets a value for &$home$& while a filter is running. The value is expanded;
19048 forced expansion failure causes the option to be ignored &-- other failures
19049 cause the router to defer.
19050
19051 Expansion of &%router_home_directory%& happens immediately after the
19052 &%check_local_user%& test (if configured), before any further expansions take
19053 place.
19054 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19055 are evaluated.)
19056 While the router is running, &%router_home_directory%& overrides the value of
19057 &$home$& that came from &%check_local_user%&.
19058
19059 When a router accepts an address and assigns it to a local transport (including
19060 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19061 delivery), the home directory setting for the transport is taken from the first
19062 of these values that is set:
19063
19064 .ilist
19065 The &%home_directory%& option on the transport;
19066 .next
19067 The &%transport_home_directory%& option on the router;
19068 .next
19069 The password data if &%check_local_user%& is set on the router;
19070 .next
19071 The &%router_home_directory%& option on the router.
19072 .endlist
19073
19074 In other words, &%router_home_directory%& overrides the password data for the
19075 router, but not for the transport.
19076
19077
19078
19079 .option self routers string freeze
19080 .cindex "MX record" "pointing to local host"
19081 .cindex "local host" "MX pointing to"
19082 This option applies to those routers that use a recipient address to find a
19083 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19084 and &(manualroute)& routers.
19085 Certain configurations of the &(queryprogram)& router can also specify a list
19086 of remote hosts.
19087 Usually such routers are configured to send the message to a remote host via an
19088 &(smtp)& transport. The &%self%& option specifies what happens when the first
19089 host on the list turns out to be the local host.
19090 The way in which Exim checks for the local host is described in section
19091 &<<SECTreclocipadd>>&.
19092
19093 Normally this situation indicates either an error in Exim's configuration (for
19094 example, the router should be configured not to process this domain), or an
19095 error in the DNS (for example, the MX should not point to this host). For this
19096 reason, the default action is to log the incident, defer the address, and
19097 freeze the message. The following alternatives are provided for use in special
19098 cases:
19099
19100 .vlist
19101 .vitem &%defer%&
19102 Delivery of the message is tried again later, but the message is not frozen.
19103
19104 .vitem "&%reroute%&: <&'domain'&>"
19105 The domain is changed to the given domain, and the address is passed back to
19106 be reprocessed by the routers. No rewriting of headers takes place. This
19107 behaviour is essentially a redirection.
19108
19109 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19110 The domain is changed to the given domain, and the address is passed back to be
19111 reprocessed by the routers. Any headers that contain the original domain are
19112 rewritten.
19113
19114 .vitem &%pass%&
19115 .oindex "&%more%&"
19116 .vindex "&$self_hostname$&"
19117 The router passes the address to the next router, or to the router named in the
19118 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19119 subsequent routing and delivery, the variable &$self_hostname$& contains the
19120 name of the local host that the router encountered. This can be used to
19121 distinguish between different cases for hosts with multiple names. The
19122 combination
19123 .code
19124 self = pass
19125 no_more
19126 .endd
19127 ensures that only those addresses that routed to the local host are passed on.
19128 Without &%no_more%&, addresses that were declined for other reasons would also
19129 be passed to the next router.
19130
19131 .vitem &%fail%&
19132 Delivery fails and an error report is generated.
19133
19134 .vitem &%send%&
19135 .cindex "local host" "sending to"
19136 The anomaly is ignored and the address is queued for the transport. This
19137 setting should be used with extreme caution. For an &(smtp)& transport, it
19138 makes sense only in cases where the program that is listening on the SMTP port
19139 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19140 different configuration file that handles the domain in another way.
19141 .endlist
19142
19143
19144
19145 .option senders routers&!? "address list&!!" unset
19146 .cindex "router" "checking senders"
19147 If this option is set, the router is skipped unless the message's sender
19148 address matches something on the list.
19149 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19150 are evaluated.
19151
19152 There are issues concerning verification when the running of routers is
19153 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19154 setting, it sets the sender to the null string. When using the &%-bt%& option
19155 to check a configuration file, it is necessary also to use the &%-f%& option to
19156 set an appropriate sender. For incoming mail, the sender is unset when
19157 verifying the sender, but is available when verifying any recipients. If the
19158 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19159 matters.
19160
19161
19162 .option set routers "string list" unset
19163 .cindex router variables
19164 This option may be used multiple times on a router;
19165 because of this the list aspect is mostly irrelevant.
19166 The list separator is a semicolon but can be changed in the
19167 usual way.
19168
19169 Each list-element given must be of the form &"name = value"&
19170 and the names used must start with the string &"r_"&.
19171 Values containing a list-separator should have them doubled.
19172 When a router runs, the strings are evaluated in order,
19173 to create variables which are added to the set associated with
19174 the address.
19175 The variable is set with the expansion of the value.
19176 The variables can be used by the router options
19177 (not including any preconditions)
19178 and by the transport.
19179 Later definitions of a given named variable will override former ones.
19180 Variable use is via the usual &$r_...$& syntax.
19181
19182 This is similar to the &%address_data%& option, except that
19183 many independent variables can be used, with choice of naming.
19184
19185
19186 .option translate_ip_address routers string&!! unset
19187 .cindex "IP address" "translating"
19188 .cindex "packet radio"
19189 .cindex "router" "IP address translation"
19190 There exist some rare networking situations (for example, packet radio) where
19191 it is helpful to be able to translate IP addresses generated by normal routing
19192 mechanisms into other IP addresses, thus performing a kind of manual IP
19193 routing. This should be done only if the normal IP routing of the TCP/IP stack
19194 is inadequate or broken. Because this is an extremely uncommon requirement, the
19195 code to support this option is not included in the Exim binary unless
19196 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19197
19198 .vindex "&$host_address$&"
19199 The &%translate_ip_address%& string is expanded for every IP address generated
19200 by the router, with the generated address set in &$host_address$&. If the
19201 expansion is forced to fail, no action is taken.
19202 For any other expansion error, delivery of the message is deferred.
19203 If the result of the expansion is an IP address, that replaces the original
19204 address; otherwise the result is assumed to be a host name &-- this is looked
19205 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19206 produce one or more replacement IP addresses. For example, to subvert all IP
19207 addresses in some specific networks, this could be added to a router:
19208 .code
19209 translate_ip_address = \
19210   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19211     {$value}fail}}
19212 .endd
19213 The file would contain lines like
19214 .code
19215 10.2.3.128/26    some.host
19216 10.8.4.34/26     10.44.8.15
19217 .endd
19218 You should not make use of this facility unless you really understand what you
19219 are doing.
19220
19221
19222
19223 .option transport routers string&!! unset
19224 This option specifies the transport to be used when a router accepts an address
19225 and sets it up for delivery. A transport is never needed if a router is used
19226 only for verification. The value of the option is expanded at routing time,
19227 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19228 and result must be the name of one of the configured transports. If it is not,
19229 delivery is deferred.
19230
19231 The &%transport%& option is not used by the &(redirect)& router, but it does
19232 have some private options that set up transports for pipe and file deliveries
19233 (see chapter &<<CHAPredirect>>&).
19234
19235
19236
19237 .option transport_current_directory routers string&!! unset
19238 .cindex "current directory for local transport"
19239 This option associates a current directory with any address that is routed
19240 to a local transport. This can happen either because a transport is
19241 explicitly configured for the router, or because it generates a delivery to a
19242 file or a pipe. During the delivery process (that is, at transport time), this
19243 option string is expanded and is set as the current directory, unless
19244 overridden by a setting on the transport.
19245 If the expansion fails for any reason, including forced failure, an error is
19246 logged, and delivery is deferred.
19247 See chapter &<<CHAPenvironment>>& for details of the local delivery
19248 environment.
19249
19250
19251
19252
19253 .option transport_home_directory routers string&!! "see below"
19254 .cindex "home directory" "for local transport"
19255 This option associates a home directory with any address that is routed to a
19256 local transport. This can happen either because a transport is explicitly
19257 configured for the router, or because it generates a delivery to a file or a
19258 pipe. During the delivery process (that is, at transport time), the option
19259 string is expanded and is set as the home directory, unless overridden by a
19260 setting of &%home_directory%& on the transport.
19261 If the expansion fails for any reason, including forced failure, an error is
19262 logged, and delivery is deferred.
19263
19264 If the transport does not specify a home directory, and
19265 &%transport_home_directory%& is not set for the router, the home directory for
19266 the transport is taken from the password data if &%check_local_user%& is set for
19267 the router. Otherwise it is taken from &%router_home_directory%& if that option
19268 is set; if not, no home directory is set for the transport.
19269
19270 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19271 environment.
19272
19273
19274
19275
19276 .option unseen routers boolean&!! false
19277 .cindex "router" "carrying on after success"
19278 The result of string expansion for this option must be a valid boolean value,
19279 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19280 result causes an error, and delivery is deferred. If the expansion is forced to
19281 fail, the default value for the option (false) is used. Other failures cause
19282 delivery to be deferred.
19283
19284 When this option is set true, routing does not cease if the router accepts the
19285 address. Instead, a copy of the incoming address is passed to the next router,
19286 overriding a false setting of &%more%&. There is little point in setting
19287 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19288 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19289 sometimes true and sometimes false).
19290
19291 .cindex "copy of message (&%unseen%& option)"
19292 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19293 qualifier in filter files. It can be used to cause copies of messages to be
19294 delivered to some other destination, while also carrying out a normal delivery.
19295 In effect, the current address is made into a &"parent"& that has two children
19296 &-- one that is delivered as specified by this router, and a clone that goes on
19297 to be routed further. For this reason, &%unseen%& may not be combined with the
19298 &%one_time%& option in a &(redirect)& router.
19299
19300 &*Warning*&: Header lines added to the address (or specified for removal) by
19301 this router or by previous routers affect the &"unseen"& copy of the message
19302 only. The clone that continues to be processed by further routers starts with
19303 no added headers and none specified for removal. For a &%redirect%& router, if
19304 a generated address is the same as the incoming address, this can lead to
19305 duplicate addresses with different header modifications. Exim does not do
19306 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19307 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19308 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19309 &%redirect%& router may be of help.
19310
19311 Unlike the handling of header modifications, any data that was set by the
19312 &%address_data%& option in the current or previous routers &'is'& passed on to
19313 subsequent routers.
19314
19315
19316 .option user routers string&!! "see below"
19317 .cindex "uid (user id)" "local delivery"
19318 .cindex "local transports" "uid and gid"
19319 .cindex "transport" "local"
19320 .cindex "router" "user for filter processing"
19321 .cindex "filter" "user for processing"
19322 When a router queues an address for a transport, and the transport does not
19323 specify a user, the user given here is used when running the delivery process.
19324 The user may be specified numerically or by name. If expansion fails, the
19325 error is logged and delivery is deferred.
19326 This user is also used by the &(redirect)& router when running a filter file.
19327 The default is unset, except when &%check_local_user%& is set. In this case,
19328 the default is taken from the password information. If the user is specified as
19329 a name, and &%group%& is not set, the group associated with the user is used.
19330 See also &%initgroups%& and &%group%& and the discussion in chapter
19331 &<<CHAPenvironment>>&.
19332
19333
19334
19335 .option verify routers&!? boolean true
19336 Setting this option has the effect of setting &%verify_sender%& and
19337 &%verify_recipient%& to the same value.
19338
19339
19340 .option verify_only routers&!? boolean false
19341 .cindex "EXPN" "with &%verify_only%&"
19342 .oindex "&%-bv%&"
19343 .cindex "router" "used only when verifying"
19344 If this option is set, the router is used only when verifying an address,
19345 delivering in cutthrough mode or
19346 testing with the &%-bv%& option, not when actually doing a delivery, testing
19347 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19348 restricted to verifying only senders or recipients by means of
19349 &%verify_sender%& and &%verify_recipient%&.
19350
19351 &*Warning*&: When the router is being run to verify addresses for an incoming
19352 SMTP message, Exim is not running as root, but under its own uid. If the router
19353 accesses any files, you need to make sure that they are accessible to the Exim
19354 user or group.
19355
19356
19357 .option verify_recipient routers&!? boolean true
19358 If this option is false, the router is skipped when verifying recipient
19359 addresses,
19360 delivering in cutthrough mode
19361 or testing recipient verification using &%-bv%&.
19362 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19363 are evaluated.
19364 See also the &$verify_mode$& variable.
19365
19366
19367 .option verify_sender routers&!? boolean true
19368 If this option is false, the router is skipped when verifying sender addresses
19369 or testing sender verification using &%-bvs%&.
19370 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19371 are evaluated.
19372 See also the &$verify_mode$& variable.
19373 .ecindex IIDgenoprou1
19374 .ecindex IIDgenoprou2
19375
19376
19377
19378
19379
19380
19381 . ////////////////////////////////////////////////////////////////////////////
19382 . ////////////////////////////////////////////////////////////////////////////
19383
19384 .chapter "The accept router" "CHID4"
19385 .cindex "&(accept)& router"
19386 .cindex "routers" "&(accept)&"
19387 The &(accept)& router has no private options of its own. Unless it is being
19388 used purely for verification (see &%verify_only%&) a transport is required to
19389 be defined by the generic &%transport%& option. If the preconditions that are
19390 specified by generic options are met, the router accepts the address and queues
19391 it for the given transport. The most common use of this router is for setting
19392 up deliveries to local mailboxes. For example:
19393 .code
19394 localusers:
19395   driver = accept
19396   domains = mydomain.example
19397   check_local_user
19398   transport = local_delivery
19399 .endd
19400 The &%domains%& condition in this example checks the domain of the address, and
19401 &%check_local_user%& checks that the local part is the login of a local user.
19402 When both preconditions are met, the &(accept)& router runs, and queues the
19403 address for the &(local_delivery)& transport.
19404
19405
19406
19407
19408
19409
19410 . ////////////////////////////////////////////////////////////////////////////
19411 . ////////////////////////////////////////////////////////////////////////////
19412
19413 .chapter "The dnslookup router" "CHAPdnslookup"
19414 .scindex IIDdnsrou1 "&(dnslookup)& router"
19415 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19416 The &(dnslookup)& router looks up the hosts that handle mail for the
19417 recipient's domain in the DNS. A transport must always be set for this router,
19418 unless &%verify_only%& is set.
19419
19420 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19421 SRV records. If none are found, or if SRV support is not configured,
19422 MX records are looked up. If no MX records exist, address records are sought.
19423 However, &%mx_domains%& can be set to disable the direct use of address
19424 records.
19425
19426 MX records of equal priority are sorted by Exim into a random order. Exim then
19427 looks for address records for the host names obtained from MX or SRV records.
19428 When a host has more than one IP address, they are sorted into a random order,
19429 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19430 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19431 generic option, the router declines.
19432
19433 Unless they have the highest priority (lowest MX value), MX records that point
19434 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19435 are discarded, together with any other MX records of equal or lower priority.
19436
19437 .cindex "MX record" "pointing to local host"
19438 .cindex "local host" "MX pointing to"
19439 .oindex "&%self%&" "in &(dnslookup)& router"
19440 If the host pointed to by the highest priority MX record, or looked up as an
19441 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19442 happens is controlled by the generic &%self%& option.
19443
19444
19445 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19446 There have been problems with DNS servers when SRV records are looked up.
19447 Some misbehaving servers return a DNS error or timeout when a non-existent
19448 SRV record is sought. Similar problems have in the past been reported for
19449 MX records. The global &%dns_again_means_nonexist%& option can help with this
19450 problem, but it is heavy-handed because it is a global option.
19451
19452 For this reason, there are two options, &%srv_fail_domains%& and
19453 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19454 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19455 an attempt to look up an SRV or MX record causes one of these results, and the
19456 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19457 such record"&. In the case of an SRV lookup, this means that the router
19458 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19459 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19460 case routing fails.
19461
19462
19463 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19464 .cindex "&(dnslookup)& router" "declines"
19465 There are a few cases where a &(dnslookup)& router will decline to accept
19466 an address; if such a router is expected to handle "all remaining non-local
19467 domains", then it is important to set &%no_more%&.
19468
19469 The router will defer rather than decline if the domain
19470 is found in the &%fail_defer_domains%& router option.
19471
19472 Reasons for a &(dnslookup)& router to decline currently include:
19473 .ilist
19474 The domain does not exist in DNS
19475 .next
19476 The domain exists but the MX record's host part is just "."; this is a common
19477 convention (borrowed from SRV) used to indicate that there is no such service
19478 for this domain and to not fall back to trying A/AAAA records.
19479 .next
19480 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19481 .next
19482 MX record points to a non-existent host.
19483 .next
19484 MX record points to an IP address and the main section option
19485 &%allow_mx_to_ip%& is not set.
19486 .next
19487 MX records exist and point to valid hosts, but all hosts resolve only to
19488 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19489 .next
19490 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19491 &%dns_check_names_pattern%& for handling one variant of this)
19492 .next
19493 &%check_secondary_mx%& is set on this router but the local host can
19494 not be found in the MX records (see below)
19495 .endlist
19496
19497
19498
19499
19500 .section "Private options for dnslookup" "SECID118"
19501 .cindex "options" "&(dnslookup)& router"
19502 The private options for the &(dnslookup)& router are as follows:
19503
19504 .option check_secondary_mx dnslookup boolean false
19505 .cindex "MX record" "checking for secondary"
19506 If this option is set, the router declines unless the local host is found in
19507 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19508 process domains for which the local host is a secondary mail exchanger
19509 differently to other domains. The way in which Exim decides whether a host is
19510 the local host is described in section &<<SECTreclocipadd>>&.
19511
19512
19513 .option check_srv dnslookup string&!! unset
19514 .cindex "SRV record" "enabling use of"
19515 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19516 addition to MX and address records. The support is disabled by default. To
19517 enable SRV support, set the &%check_srv%& option to the name of the service
19518 required. For example,
19519 .code
19520 check_srv = smtp
19521 .endd
19522 looks for SRV records that refer to the normal smtp service. The option is
19523 expanded, so the service name can vary from message to message or address
19524 to address. This might be helpful if SRV records are being used for a
19525 submission service. If the expansion is forced to fail, the &%check_srv%&
19526 option is ignored, and the router proceeds to look for MX records in the
19527 normal way.
19528
19529 When the expansion succeeds, the router searches first for SRV records for
19530 the given service (it assumes TCP protocol). A single SRV record with a
19531 host name that consists of just a single dot indicates &"no such service for
19532 this domain"&; if this is encountered, the router declines. If other kinds of
19533 SRV record are found, they are used to construct a host list for delivery
19534 according to the rules of RFC 2782. MX records are not sought in this case.
19535
19536 When no SRV records are found, MX records (and address records) are sought in
19537 the traditional way. In other words, SRV records take precedence over MX
19538 records, just as MX records take precedence over address records. Note that
19539 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19540 defined it. It is apparently believed that MX records are sufficient for email
19541 and that SRV records should not be used for this purpose. However, SRV records
19542 have an additional &"weight"& feature which some people might find useful when
19543 trying to split an SMTP load between hosts of different power.
19544
19545 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19546 when there is a DNS lookup error.
19547
19548
19549
19550
19551 .option fail_defer_domains dnslookup "domain list&!!" unset
19552 .cindex "MX record" "not found"
19553 DNS lookups for domains matching &%fail_defer_domains%&
19554 which find no matching record will cause the router to defer
19555 rather than the default behaviour of decline.
19556 This maybe be useful for queueing messages for a newly created
19557 domain while the DNS configuration is not ready.
19558 However, it will result in any message with mistyped domains
19559 also being queued.
19560
19561
19562 .option ipv4_only "string&!!" unset
19563 .cindex IPv6 disabling
19564 .cindex DNS "IPv6 disabling"
19565 The string is expanded, and if the result is anything but a forced failure,
19566 or an empty string, or one of the strings “0” or “no” or “false”
19567 (checked without regard to the case of the letters),
19568 only A records are used.
19569
19570 .option ipv4_prefer "string&!!" unset
19571 .cindex IPv4 preference
19572 .cindex DNS "IPv4 preference"
19573 The string is expanded, and if the result is anything but a forced failure,
19574 or an empty string, or one of the strings “0” or “no” or “false”
19575 (checked without regard to the case of the letters),
19576 A records are sorted before AAAA records (inverting the default).
19577
19578 .option mx_domains dnslookup "domain list&!!" unset
19579 .cindex "MX record" "required to exist"
19580 .cindex "SRV record" "required to exist"
19581 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19582 record in order to be recognized. (The name of this option could be improved.)
19583 For example, if all the mail hosts in &'fict.example'& are known to have MX
19584 records, except for those in &'discworld.fict.example'&, you could use this
19585 setting:
19586 .code
19587 mx_domains = ! *.discworld.fict.example : *.fict.example
19588 .endd
19589 This specifies that messages addressed to a domain that matches the list but
19590 has no MX record should be bounced immediately instead of being routed using
19591 the address record.
19592
19593
19594 .option mx_fail_domains dnslookup "domain list&!!" unset
19595 If the DNS lookup for MX records for one of the domains in this list causes a
19596 DNS lookup error, Exim behaves as if no MX records were found. See section
19597 &<<SECTprowitdnsloo>>& for more discussion.
19598
19599
19600
19601
19602 .option qualify_single dnslookup boolean true
19603 .cindex "DNS" "resolver options"
19604 .cindex "DNS" "qualifying single-component names"
19605 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19606 lookups. Typically, but not standardly, this causes the resolver to qualify
19607 single-component names with the default domain. For example, on a machine
19608 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19609 &'thesaurus.ref.example'& inside the resolver. For details of what your
19610 resolver actually does, consult your man pages for &'resolver'& and
19611 &'resolv.conf'&.
19612
19613
19614
19615 .option rewrite_headers dnslookup boolean true
19616 .cindex "rewriting" "header lines"
19617 .cindex "header lines" "rewriting"
19618 If the domain name in the address that is being processed is not fully
19619 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19620 an address is specified as &'dormouse@teaparty'&, the domain might be
19621 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19622 occur as a result of setting the &%widen_domains%& option. If
19623 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19624 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19625 header lines of the message are rewritten with the full domain name.
19626
19627 This option should be turned off only when it is known that no message is
19628 ever going to be sent outside an environment where the abbreviation makes
19629 sense.
19630
19631 When an MX record is looked up in the DNS and matches a wildcard record, name
19632 servers normally return a record containing the name that has been looked up,
19633 making it impossible to detect whether a wildcard was present or not. However,
19634 some name servers have recently been seen to return the wildcard entry. If the
19635 name returned by a DNS lookup begins with an asterisk, it is not used for
19636 header rewriting.
19637
19638
19639 .option same_domain_copy_routing dnslookup boolean false
19640 .cindex "address" "copying routing"
19641 Addresses with the same domain are normally routed by the &(dnslookup)& router
19642 to the same list of hosts. However, this cannot be presumed, because the router
19643 options and preconditions may refer to the local part of the address. By
19644 default, therefore, Exim routes each address in a message independently. DNS
19645 servers run caches, so repeated DNS lookups are not normally expensive, and in
19646 any case, personal messages rarely have more than a few recipients.
19647
19648 If you are running mailing lists with large numbers of subscribers at the same
19649 domain, and you are using a &(dnslookup)& router which is independent of the
19650 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19651 lookups for identical domains in one message. In this case, when &(dnslookup)&
19652 routes an address to a remote transport, any other unrouted addresses in the
19653 message that have the same domain are automatically given the same routing
19654 without processing them independently,
19655 provided the following conditions are met:
19656
19657 .ilist
19658 No router that processed the address specified &%headers_add%& or
19659 &%headers_remove%&.
19660 .next
19661 The router did not change the address in any way, for example, by &"widening"&
19662 the domain.
19663 .endlist
19664
19665
19666
19667
19668 .option search_parents dnslookup boolean false
19669 .cindex "DNS" "resolver options"
19670 When this option is true, the resolver option RES_DNSRCH is set for DNS
19671 lookups. This is different from the &%qualify_single%& option in that it
19672 applies to domains containing dots. Typically, but not standardly, it causes
19673 the resolver to search for the name in the current domain and in parent
19674 domains. For example, on a machine in the &'fict.example'& domain, if looking
19675 up &'teaparty.wonderland'& failed, the resolver would try
19676 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19677 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19678
19679 Setting this option true can cause problems in domains that have a wildcard MX
19680 record, because any domain that does not have its own MX record matches the
19681 local wildcard.
19682
19683
19684
19685 .option srv_fail_domains dnslookup "domain list&!!" unset
19686 If the DNS lookup for SRV records for one of the domains in this list causes a
19687 DNS lookup error, Exim behaves as if no SRV records were found. See section
19688 &<<SECTprowitdnsloo>>& for more discussion.
19689
19690
19691
19692
19693 .option widen_domains dnslookup "string list" unset
19694 .cindex "domain" "partial; widening"
19695 If a DNS lookup fails and this option is set, each of its strings in turn is
19696 added onto the end of the domain, and the lookup is tried again. For example,
19697 if
19698 .code
19699 widen_domains = fict.example:ref.example
19700 .endd
19701 is set and a lookup of &'klingon.dictionary'& fails,
19702 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19703 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19704 and &%search_parents%& options can cause some widening to be undertaken inside
19705 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19706 when verifying, unless &%rewrite_headers%& is false (not the default).
19707
19708
19709 .section "Effect of qualify_single and search_parents" "SECID119"
19710 When a domain from an envelope recipient is changed by the resolver as a result
19711 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19712 corresponding address in the message's header lines unless &%rewrite_headers%&
19713 is set false. Exim then re-routes the address, using the full domain.
19714
19715 These two options affect only the DNS lookup that takes place inside the router
19716 for the domain of the address that is being routed. They do not affect lookups
19717 such as that implied by
19718 .code
19719 domains = @mx_any
19720 .endd
19721 that may happen while processing a router precondition before the router is
19722 entered. No widening ever takes place for these lookups.
19723 .ecindex IIDdnsrou1
19724 .ecindex IIDdnsrou2
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734 . ////////////////////////////////////////////////////////////////////////////
19735 . ////////////////////////////////////////////////////////////////////////////
19736
19737 .chapter "The ipliteral router" "CHID5"
19738 .cindex "&(ipliteral)& router"
19739 .cindex "domain literal" "routing"
19740 .cindex "routers" "&(ipliteral)&"
19741 This router has no private options. Unless it is being used purely for
19742 verification (see &%verify_only%&) a transport is required to be defined by the
19743 generic &%transport%& option. The router accepts the address if its domain part
19744 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19745 router handles the address
19746 .code
19747 root@[192.168.1.1]
19748 .endd
19749 by setting up delivery to the host with that IP address. IPv4 domain literals
19750 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19751 are similar, but the address is preceded by &`ipv6:`&. For example:
19752 .code
19753 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19754 .endd
19755 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19756 grounds that sooner or later somebody will try it.
19757
19758 .oindex "&%self%&" "in &(ipliteral)& router"
19759 If the IP address matches something in &%ignore_target_hosts%&, the router
19760 declines. If an IP literal turns out to refer to the local host, the generic
19761 &%self%& option determines what happens.
19762
19763 The RFCs require support for domain literals; however, their use is
19764 controversial in today's Internet. If you want to use this router, you must
19765 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19766 Exim will not recognize the domain literal syntax in addresses.
19767
19768
19769
19770 . ////////////////////////////////////////////////////////////////////////////
19771 . ////////////////////////////////////////////////////////////////////////////
19772
19773 .chapter "The iplookup router" "CHID6"
19774 .cindex "&(iplookup)& router"
19775 .cindex "routers" "&(iplookup)&"
19776 The &(iplookup)& router was written to fulfil a specific requirement in
19777 Cambridge University (which in fact no longer exists). For this reason, it is
19778 not included in the binary of Exim by default. If you want to include it, you
19779 must set
19780 .code
19781 ROUTER_IPLOOKUP=yes
19782 .endd
19783 in your &_Local/Makefile_& configuration file.
19784
19785 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19786 connection to one or more specific hosts. The host can then return the same or
19787 a different address &-- in effect rewriting the recipient address in the
19788 message's envelope. The new address is then passed on to subsequent routers. If
19789 this process fails, the address can be passed on to other routers, or delivery
19790 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19791 must not be specified for it.
19792
19793 .cindex "options" "&(iplookup)& router"
19794 .option hosts iplookup string unset
19795 This option must be supplied. Its value is a colon-separated list of host
19796 names. The hosts are looked up using &[gethostbyname()]&
19797 (or &[getipnodebyname()]& when available)
19798 and are tried in order until one responds to the query. If none respond, what
19799 happens is controlled by &%optional%&.
19800
19801
19802 .option optional iplookup boolean false
19803 If &%optional%& is true, if no response is obtained from any host, the address
19804 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19805 delivery to the address is deferred.
19806
19807
19808 .option port iplookup integer 0
19809 .cindex "port" "&(iplookup)& router"
19810 This option must be supplied. It specifies the port number for the TCP or UDP
19811 call.
19812
19813
19814 .option protocol iplookup string udp
19815 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19816 protocols is to be used.
19817
19818
19819 .option query iplookup string&!! "see below"
19820 This defines the content of the query that is sent to the remote hosts. The
19821 default value is:
19822 .code
19823 $local_part@$domain $local_part@$domain
19824 .endd
19825 The repetition serves as a way of checking that a response is to the correct
19826 query in the default case (see &%response_pattern%& below).
19827
19828
19829 .option reroute iplookup string&!! unset
19830 If this option is not set, the rerouted address is precisely the byte string
19831 returned by the remote host, up to the first white space, if any. If set, the
19832 string is expanded to form the rerouted address. It can include parts matched
19833 in the response by &%response_pattern%& by means of numeric variables such as
19834 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19835 whether or not a pattern is in use. In all cases, the rerouted address must end
19836 up in the form &'local_part@domain'&.
19837
19838
19839 .option response_pattern iplookup string unset
19840 This option can be set to a regular expression that is applied to the string
19841 returned from the remote host. If the pattern does not match the response, the
19842 router declines. If &%response_pattern%& is not set, no checking of the
19843 response is done, unless the query was defaulted, in which case there is a
19844 check that the text returned after the first white space is the original
19845 address. This checks that the answer that has been received is in response to
19846 the correct question. For example, if the response is just a new domain, the
19847 following could be used:
19848 .code
19849 response_pattern = ^([^@]+)$
19850 reroute = $local_part@$1
19851 .endd
19852
19853 .option timeout iplookup time 5s
19854 This specifies the amount of time to wait for a response from the remote
19855 machine. The same timeout is used for the &[connect()]& function for a TCP
19856 call. It does not apply to UDP.
19857
19858
19859
19860
19861 . ////////////////////////////////////////////////////////////////////////////
19862 . ////////////////////////////////////////////////////////////////////////////
19863
19864 .chapter "The manualroute router" "CHID7"
19865 .scindex IIDmanrou1 "&(manualroute)& router"
19866 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19867 .cindex "domain" "manually routing"
19868 The &(manualroute)& router is so-called because it provides a way of manually
19869 routing an address according to its domain. It is mainly used when you want to
19870 route addresses to remote hosts according to your own rules, bypassing the
19871 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19872 route to local transports, a facility that may be useful if you want to save
19873 messages for dial-in hosts in local files.
19874
19875 The &(manualroute)& router compares a list of domain patterns with the domain
19876 it is trying to route. If there is no match, the router declines. Each pattern
19877 has associated with it a list of hosts and some other optional data, which may
19878 include a transport. The combination of a pattern and its data is called a
19879 &"routing rule"&. For patterns that do not have an associated transport, the
19880 generic &%transport%& option must specify a transport, unless the router is
19881 being used purely for verification (see &%verify_only%&).
19882
19883 .vindex "&$host$&"
19884 In the case of verification, matching the domain pattern is sufficient for the
19885 router to accept the address. When actually routing an address for delivery,
19886 an address that matches a domain pattern is queued for the associated
19887 transport. If the transport is not a local one, a host list must be associated
19888 with the pattern; IP addresses are looked up for the hosts, and these are
19889 passed to the transport along with the mail address. For local transports, a
19890 host list is optional. If it is present, it is passed in &$host$& as a single
19891 text string.
19892
19893 The list of routing rules can be provided as an inline string in
19894 &%route_list%&, or the data can be obtained by looking up the domain in a file
19895 or database by setting &%route_data%&. Only one of these settings may appear in
19896 any one instance of &(manualroute)&. The format of routing rules is described
19897 below, following the list of private options.
19898
19899
19900 .section "Private options for manualroute" "SECTprioptman"
19901
19902 .cindex "options" "&(manualroute)& router"
19903 The private options for the &(manualroute)& router are as follows:
19904
19905 .option host_all_ignored manualroute string defer
19906 See &%host_find_failed%&.
19907
19908 .option host_find_failed manualroute string freeze
19909 This option controls what happens when &(manualroute)& tries to find an IP
19910 address for a host, and the host does not exist. The option can be set to one
19911 of the following values:
19912 .code
19913 decline
19914 defer
19915 fail
19916 freeze
19917 ignore
19918 pass
19919 .endd
19920 The default (&"freeze"&) assumes that this state is a serious configuration
19921 error. The difference between &"pass"& and &"decline"& is that the former
19922 forces the address to be passed to the next router (or the router defined by
19923 &%pass_router%&),
19924 .oindex "&%more%&"
19925 overriding &%no_more%&, whereas the latter passes the address to the next
19926 router only if &%more%& is true.
19927
19928 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19929 cannot be found. If all the hosts in the list are ignored, the behaviour is
19930 controlled by the &%host_all_ignored%& option. This takes the same values
19931 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19932
19933 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19934 state; if a host lookup gets a temporary error, delivery is deferred unless the
19935 generic &%pass_on_timeout%& option is set.
19936
19937
19938 .option hosts_randomize manualroute boolean false
19939 .cindex "randomized host list"
19940 .cindex "host" "list of; randomized"
19941 If this option is set, the order of the items in a host list in a routing rule
19942 is randomized each time the list is used, unless an option in the routing rule
19943 overrides (see below). Randomizing the order of a host list can be used to do
19944 crude load sharing. However, if more than one mail address is routed by the
19945 same router to the same host list, the host lists are considered to be the same
19946 (even though they may be randomized into different orders) for the purpose of
19947 deciding whether to batch the deliveries into a single SMTP transaction.
19948
19949 When &%hosts_randomize%& is true, a host list may be split
19950 into groups whose order is separately randomized. This makes it possible to
19951 set up MX-like behaviour. The boundaries between groups are indicated by an
19952 item that is just &`+`& in the host list. For example:
19953 .code
19954 route_list = * host1:host2:host3:+:host4:host5
19955 .endd
19956 The order of the first three hosts and the order of the last two hosts is
19957 randomized for each use, but the first three always end up before the last two.
19958 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19959 randomized host list is passed to an &(smtp)& transport that also has
19960 &%hosts_randomize set%&, the list is not re-randomized.
19961
19962
19963 .option route_data manualroute string&!! unset
19964 If this option is set, it must expand to yield the data part of a routing rule.
19965 Typically, the expansion string includes a lookup based on the domain. For
19966 example:
19967 .code
19968 route_data = ${lookup{$domain}dbm{/etc/routes}}
19969 .endd
19970 If the expansion is forced to fail, or the result is an empty string, the
19971 router declines. Other kinds of expansion failure cause delivery to be
19972 deferred.
19973
19974
19975 .option route_list manualroute "string list" unset
19976 This string is a list of routing rules, in the form defined below. Note that,
19977 unlike most string lists, the items are separated by semicolons. This is so
19978 that they may contain colon-separated host lists.
19979
19980
19981 .option same_domain_copy_routing manualroute boolean false
19982 .cindex "address" "copying routing"
19983 Addresses with the same domain are normally routed by the &(manualroute)&
19984 router to the same list of hosts. However, this cannot be presumed, because the
19985 router options and preconditions may refer to the local part of the address. By
19986 default, therefore, Exim routes each address in a message independently. DNS
19987 servers run caches, so repeated DNS lookups are not normally expensive, and in
19988 any case, personal messages rarely have more than a few recipients.
19989
19990 If you are running mailing lists with large numbers of subscribers at the same
19991 domain, and you are using a &(manualroute)& router which is independent of the
19992 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19993 lookups for identical domains in one message. In this case, when
19994 &(manualroute)& routes an address to a remote transport, any other unrouted
19995 addresses in the message that have the same domain are automatically given the
19996 same routing without processing them independently. However, this is only done
19997 if &%headers_add%& and &%headers_remove%& are unset.
19998
19999
20000
20001
20002 .section "Routing rules in route_list" "SECID120"
20003 The value of &%route_list%& is a string consisting of a sequence of routing
20004 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20005 entered as two semicolons. Alternatively, the list separator can be changed as
20006 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20007 Empty rules are ignored. The format of each rule is
20008 .display
20009 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20010 .endd
20011 The following example contains two rules, each with a simple domain pattern and
20012 no options:
20013 .code
20014 route_list = \
20015   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20016   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20017 .endd
20018 The three parts of a rule are separated by white space. The pattern and the
20019 list of hosts can be enclosed in quotes if necessary, and if they are, the
20020 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20021 single domain pattern, which is the only mandatory item in the rule. The
20022 pattern is in the same format as one item in a domain list (see section
20023 &<<SECTdomainlist>>&),
20024 except that it may not be the name of an interpolated file.
20025 That is, it may be wildcarded, or a regular expression, or a file or database
20026 lookup (with semicolons doubled, because of the use of semicolon as a separator
20027 in a &%route_list%&).
20028
20029 The rules in &%route_list%& are searched in order until one of the patterns
20030 matches the domain that is being routed. The list of hosts and then options are
20031 then used as described below. If there is no match, the router declines. When
20032 &%route_list%& is set, &%route_data%& must not be set.
20033
20034
20035
20036 .section "Routing rules in route_data" "SECID121"
20037 The use of &%route_list%& is convenient when there are only a small number of
20038 routing rules. For larger numbers, it is easier to use a file or database to
20039 hold the routing information, and use the &%route_data%& option instead.
20040 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20041 Most commonly, &%route_data%& is set as a string that contains an
20042 expansion lookup. For example, suppose we place two routing rules in a file
20043 like this:
20044 .code
20045 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20046 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20047 .endd
20048 This data can be accessed by setting
20049 .code
20050 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20051 .endd
20052 Failure of the lookup results in an empty string, causing the router to
20053 decline. However, you do not have to use a lookup in &%route_data%&. The only
20054 requirement is that the result of expanding the string is a list of hosts,
20055 possibly followed by options, separated by white space. The list of hosts must
20056 be enclosed in quotes if it contains white space.
20057
20058
20059
20060
20061 .section "Format of the list of hosts" "SECID122"
20062 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20063 always separately expanded before use. If the expansion fails, the router
20064 declines. The result of the expansion must be a colon-separated list of names
20065 and/or IP addresses, optionally also including ports.
20066 If the list is written with spaces, it must be protected with quotes.
20067 The format of each item
20068 in the list is described in the next section. The list separator can be changed
20069 as described in section &<<SECTlistsepchange>>&.
20070
20071 If the list of hosts was obtained from a &%route_list%& item, the following
20072 variables are set during its expansion:
20073
20074 .ilist
20075 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20076 If the domain was matched against a regular expression, the numeric variables
20077 &$1$&, &$2$&, etc. may be set. For example:
20078 .code
20079 route_list = ^domain(\d+)   host-$1.text.example
20080 .endd
20081 .next
20082 &$0$& is always set to the entire domain.
20083 .next
20084 &$1$& is also set when partial matching is done in a file lookup.
20085
20086 .next
20087 .vindex "&$value$&"
20088 If the pattern that matched the domain was a lookup item, the data that was
20089 looked up is available in the expansion variable &$value$&. For example:
20090 .code
20091 route_list = lsearch;;/some/file.routes  $value
20092 .endd
20093 .endlist
20094
20095 Note the doubling of the semicolon in the pattern that is necessary because
20096 semicolon is the default route list separator.
20097
20098
20099
20100 .section "Format of one host item" "SECTformatonehostitem"
20101 Each item in the list of hosts is either a host name or an IP address,
20102 optionally with an attached port number. When no port is given, an IP address
20103 is not enclosed in brackets. When a port is specified, it overrides the port
20104 specification on the transport. The port is separated from the name or address
20105 by a colon. This leads to some complications:
20106
20107 .ilist
20108 Because colon is the default separator for the list of hosts, either
20109 the colon that specifies a port must be doubled, or the list separator must
20110 be changed. The following two examples have the same effect:
20111 .code
20112 route_list = * "host1.tld::1225 : host2.tld::1226"
20113 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20114 .endd
20115 .next
20116 When IPv6 addresses are involved, it gets worse, because they contain
20117 colons of their own. To make this case easier, it is permitted to
20118 enclose an IP address (either v4 or v6) in square brackets if a port
20119 number follows. For example:
20120 .code
20121 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20122 .endd
20123 .endlist
20124
20125 .section "How the list of hosts is used" "SECThostshowused"
20126 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20127 the hosts is tried, in the order specified, when carrying out the SMTP
20128 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20129 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20130 transport.
20131
20132 Hosts may be listed by name or by IP address. An unadorned name in the list of
20133 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20134 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20135 records in the DNS. For example:
20136 .code
20137 route_list = *  x.y.z:p.q.r/MX:e.f.g
20138 .endd
20139 If this feature is used with a port specifier, the port must come last. For
20140 example:
20141 .code
20142 route_list = *  dom1.tld/mx::1225
20143 .endd
20144 If the &%hosts_randomize%& option is set, the order of the items in the list is
20145 randomized before any lookups are done. Exim then scans the list; for any name
20146 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20147 be an interface on the local host and the item is not the first in the list,
20148 Exim discards it and any subsequent items. If it is the first item, what
20149 happens is controlled by the
20150 .oindex "&%self%&" "in &(manualroute)& router"
20151 &%self%& option of the router.
20152
20153 A name on the list that is followed by &`/MX`& is replaced with the list of
20154 hosts obtained by looking up MX records for the name. This is always a DNS
20155 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20156 below) are not relevant here. The order of these hosts is determined by the
20157 preference values in the MX records, according to the usual rules. Because
20158 randomizing happens before the MX lookup, it does not affect the order that is
20159 defined by MX preferences.
20160
20161 If the local host is present in the sublist obtained from MX records, but is
20162 not the most preferred host in that list, it and any equally or less
20163 preferred hosts are removed before the sublist is inserted into the main list.
20164
20165 If the local host is the most preferred host in the MX list, what happens
20166 depends on where in the original list of hosts the &`/MX`& item appears. If it
20167 is not the first item (that is, there are previous hosts in the main list),
20168 Exim discards this name and any subsequent items in the main list.
20169
20170 If the MX item is first in the list of hosts, and the local host is the
20171 most preferred host, what happens is controlled by the &%self%& option of the
20172 router.
20173
20174 DNS failures when lookup up the MX records are treated in the same way as DNS
20175 failures when looking up IP addresses: &%pass_on_timeout%& and
20176 &%host_find_failed%& are used when relevant.
20177
20178 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20179 whether obtained from an MX lookup or not.
20180
20181
20182
20183 .section "How the options are used" "SECThowoptused"
20184 The options are a sequence of words, space-separated.
20185 One of the words can be the name of a transport; this overrides the
20186 &%transport%& option on the router for this particular routing rule only. The
20187 other words (if present) control randomization of the list of hosts on a
20188 per-rule basis, and how the IP addresses of the hosts are to be found when
20189 routing to a remote transport. These options are as follows:
20190
20191 .ilist
20192 &%randomize%&: randomize the order of the hosts in this list, overriding the
20193 setting of &%hosts_randomize%& for this routing rule only.
20194 .next
20195 &%no_randomize%&: do not randomize the order of the hosts in this list,
20196 overriding the setting of &%hosts_randomize%& for this routing rule only.
20197 .next
20198 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20199 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20200 also look in &_/etc/hosts_& or other sources of information.
20201 .next
20202 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20203 no address records are found. If there is a temporary DNS error (such as a
20204 timeout), delivery is deferred.
20205 .next
20206 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20207 .next
20208 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20209 .endlist
20210
20211 For example:
20212 .code
20213 route_list = domain1  host1:host2:host3  randomize bydns;\
20214              domain2  host4:host5
20215 .endd
20216 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20217 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20218 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20219 or &[gethostbyname()]&, and the result of the lookup is the result of that
20220 call.
20221
20222 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20223 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20224 instead of TRY_AGAIN. That is why the default action is to try a DNS
20225 lookup first. Only if that gives a definite &"no such host"& is the local
20226 function called.
20227
20228 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20229 inadvertent constraint that a transport name as an option had to be the last
20230 option specified.
20231
20232
20233
20234 If no IP address for a host can be found, what happens is controlled by the
20235 &%host_find_failed%& option.
20236
20237 .vindex "&$host$&"
20238 When an address is routed to a local transport, IP addresses are not looked up.
20239 The host list is passed to the transport in the &$host$& variable.
20240
20241
20242
20243 .section "Manualroute examples" "SECID123"
20244 In some of the examples that follow, the presence of the &%remote_smtp%&
20245 transport, as defined in the default configuration file, is assumed:
20246
20247 .ilist
20248 .cindex "smart host" "example router"
20249 The &(manualroute)& router can be used to forward all external mail to a
20250 &'smart host'&. If you have set up, in the main part of the configuration, a
20251 named domain list that contains your local domains, for example:
20252 .code
20253 domainlist local_domains = my.domain.example
20254 .endd
20255 You can arrange for all other domains to be routed to a smart host by making
20256 your first router something like this:
20257 .code
20258 smart_route:
20259   driver = manualroute
20260   domains = !+local_domains
20261   transport = remote_smtp
20262   route_list = * smarthost.ref.example
20263 .endd
20264 This causes all non-local addresses to be sent to the single host
20265 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20266 they are tried in order
20267 (but you can use &%hosts_randomize%& to vary the order each time).
20268 Another way of configuring the same thing is this:
20269 .code
20270 smart_route:
20271   driver = manualroute
20272   transport = remote_smtp
20273   route_list = !+local_domains  smarthost.ref.example
20274 .endd
20275 There is no difference in behaviour between these two routers as they stand.
20276 However, they behave differently if &%no_more%& is added to them. In the first
20277 example, the router is skipped if the domain does not match the &%domains%&
20278 precondition; the following router is always tried. If the router runs, it
20279 always matches the domain and so can never decline. Therefore, &%no_more%&
20280 would have no effect. In the second case, the router is never skipped; it
20281 always runs. However, if it doesn't match the domain, it declines. In this case
20282 &%no_more%& would prevent subsequent routers from running.
20283
20284 .next
20285 .cindex "mail hub example"
20286 A &'mail hub'& is a host which receives mail for a number of domains via MX
20287 records in the DNS and delivers it via its own private routing mechanism. Often
20288 the final destinations are behind a firewall, with the mail hub being the one
20289 machine that can connect to machines both inside and outside the firewall. The
20290 &(manualroute)& router is usually used on a mail hub to route incoming messages
20291 to the correct hosts. For a small number of domains, the routing can be inline,
20292 using the &%route_list%& option, but for a larger number a file or database
20293 lookup is easier to manage.
20294
20295 If the domain names are in fact the names of the machines to which the mail is
20296 to be sent by the mail hub, the configuration can be quite simple. For
20297 example:
20298 .code
20299 hub_route:
20300   driver = manualroute
20301   transport = remote_smtp
20302   route_list = *.rhodes.tvs.example  $domain
20303 .endd
20304 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20305 whose names are the same as the mail domains. A similar approach can be taken
20306 if the host name can be obtained from the domain name by a string manipulation
20307 that the expansion facilities can handle. Otherwise, a lookup based on the
20308 domain can be used to find the host:
20309 .code
20310 through_firewall:
20311   driver = manualroute
20312   transport = remote_smtp
20313   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20314 .endd
20315 The result of the lookup must be the name or IP address of the host (or
20316 hosts) to which the address is to be routed. If the lookup fails, the route
20317 data is empty, causing the router to decline. The address then passes to the
20318 next router.
20319
20320 .next
20321 .cindex "batched SMTP output example"
20322 .cindex "SMTP" "batched outgoing; example"
20323 You can use &(manualroute)& to deliver messages to pipes or files in batched
20324 SMTP format for onward transportation by some other means. This is one way of
20325 storing mail for a dial-up host when it is not connected. The route list entry
20326 can be as simple as a single domain name in a configuration like this:
20327 .code
20328 save_in_file:
20329   driver = manualroute
20330   transport = batchsmtp_appendfile
20331   route_list = saved.domain.example
20332 .endd
20333 though often a pattern is used to pick up more than one domain. If there are
20334 several domains or groups of domains with different transport requirements,
20335 different transports can be listed in the routing information:
20336 .code
20337 save_in_file:
20338   driver = manualroute
20339   route_list = \
20340     *.saved.domain1.example  $domain  batch_appendfile; \
20341     *.saved.domain2.example  \
20342       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20343       batch_pipe
20344 .endd
20345 .vindex "&$domain$&"
20346 .vindex "&$host$&"
20347 The first of these just passes the domain in the &$host$& variable, which
20348 doesn't achieve much (since it is also in &$domain$&), but the second does a
20349 file lookup to find a value to pass, causing the router to decline to handle
20350 the address if the lookup fails.
20351
20352 .next
20353 .cindex "UUCP" "example of router for"
20354 Routing mail directly to UUCP software is a specific case of the use of
20355 &(manualroute)& in a gateway to another mail environment. This is an example of
20356 one way it can be done:
20357 .code
20358 # Transport
20359 uucp:
20360   driver = pipe
20361   user = nobody
20362   command = /usr/local/bin/uux -r - \
20363     ${substr_-5:$host}!rmail ${local_part}
20364   return_fail_output = true
20365
20366 # Router
20367 uucphost:
20368   transport = uucp
20369   driver = manualroute
20370   route_data = \
20371     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20372 .endd
20373 The file &_/usr/local/exim/uucphosts_& contains entries like
20374 .code
20375 darksite.ethereal.example:           darksite.UUCP
20376 .endd
20377 It can be set up more simply without adding and removing &".UUCP"& but this way
20378 makes clear the distinction between the domain name
20379 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20380 .endlist
20381 .ecindex IIDmanrou1
20382 .ecindex IIDmanrou2
20383
20384
20385
20386
20387
20388
20389
20390
20391 . ////////////////////////////////////////////////////////////////////////////
20392 . ////////////////////////////////////////////////////////////////////////////
20393
20394 .chapter "The queryprogram router" "CHAPdriverlast"
20395 .scindex IIDquerou1 "&(queryprogram)& router"
20396 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20397 .cindex "routing" "by external program"
20398 The &(queryprogram)& router routes an address by running an external command
20399 and acting on its output. This is an expensive way to route, and is intended
20400 mainly for use in lightly-loaded systems, or for performing experiments.
20401 However, if it is possible to use the precondition options (&%domains%&,
20402 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20403 be used in special cases, even on a busy host. There are the following private
20404 options:
20405 .cindex "options" "&(queryprogram)& router"
20406
20407 .option command queryprogram string&!! unset
20408 This option must be set. It specifies the command that is to be run. The
20409 command is split up into a command name and arguments, and then each is
20410 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20411 &<<CHAPpipetransport>>&).
20412
20413
20414 .option command_group queryprogram string unset
20415 .cindex "gid (group id)" "in &(queryprogram)& router"
20416 This option specifies a gid to be set when running the command while routing an
20417 address for deliver. It must be set if &%command_user%& specifies a numerical
20418 uid. If it begins with a digit, it is interpreted as the numerical value of the
20419 gid. Otherwise it is looked up using &[getgrnam()]&.
20420
20421
20422 .option command_user queryprogram string unset
20423 .cindex "uid (user id)" "for &(queryprogram)&"
20424 This option must be set. It specifies the uid which is set when running the
20425 command while routing an address for delivery. If the value begins with a digit,
20426 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20427 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20428 not set, a value for the gid also.
20429
20430 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20431 root, which it does during a normal delivery in a conventional configuration.
20432 However, when an address is being verified during message reception, Exim is
20433 usually running as the Exim user, not as root. If the &(queryprogram)& router
20434 is called from a non-root process, Exim cannot change uid or gid before running
20435 the command. In this circumstance the command runs under the current uid and
20436 gid.
20437
20438
20439 .option current_directory queryprogram string /
20440 This option specifies an absolute path which is made the current directory
20441 before running the command.
20442
20443
20444 .option timeout queryprogram time 1h
20445 If the command does not complete within the timeout period, its process group
20446 is killed and the message is frozen. A value of zero time specifies no
20447 timeout.
20448
20449
20450 The standard output of the command is connected to a pipe, which is read when
20451 the command terminates. It should consist of a single line of output,
20452 containing up to five fields, separated by white space. The maximum length of
20453 the line is 1023 characters. Longer lines are silently truncated. The first
20454 field is one of the following words (case-insensitive):
20455
20456 .ilist
20457 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20458 below).
20459 .next
20460 &'Decline'&: the router declines; pass the address to the next router, unless
20461 &%no_more%& is set.
20462 .next
20463 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20464 subsequent text on the line is an error message. If the router is run as part
20465 of address verification during an incoming SMTP message, the message is
20466 included in the SMTP response.
20467 .next
20468 &'Defer'&: routing could not be completed at this time; try again later. Any
20469 subsequent text on the line is an error message which is logged. It is not
20470 included in any SMTP response.
20471 .next
20472 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20473 .next
20474 &'Pass'&: pass the address to the next router (or the router specified by
20475 &%pass_router%&), overriding &%no_more%&.
20476 .next
20477 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20478 new addresses, which are routed independently, starting with the first router,
20479 or the router specified by &%redirect_router%&, if set.
20480 .endlist
20481
20482 When the first word is &'accept'&, the remainder of the line consists of a
20483 number of keyed data values, as follows (split into two lines here, to fit on
20484 the page):
20485 .code
20486 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20487 LOOKUP=byname|bydns DATA=<text>
20488 .endd
20489 The data items can be given in any order, and all are optional. If no transport
20490 is included, the transport specified by the generic &%transport%& option is
20491 used. The list of hosts and the lookup type are needed only if the transport is
20492 an &(smtp)& transport that does not itself supply a list of hosts.
20493
20494 The format of the list of hosts is the same as for the &(manualroute)& router.
20495 As well as host names and IP addresses with optional port numbers, as described
20496 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20497 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20498 (see section &<<SECThostshowused>>&).
20499
20500 If the lookup type is not specified, Exim behaves as follows when trying to
20501 find an IP address for each host: First, a DNS lookup is done. If this yields
20502 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20503 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20504 result of the lookup is the result of that call.
20505
20506 .vindex "&$address_data$&"
20507 If the DATA field is set, its value is placed in the &$address_data$&
20508 variable. For example, this return line
20509 .code
20510 accept hosts=x1.y.example:x2.y.example data="rule1"
20511 .endd
20512 routes the address to the default transport, passing a list of two hosts. When
20513 the transport runs, the string &"rule1"& is in &$address_data$&.
20514 .ecindex IIDquerou1
20515 .ecindex IIDquerou2
20516
20517
20518
20519
20520 . ////////////////////////////////////////////////////////////////////////////
20521 . ////////////////////////////////////////////////////////////////////////////
20522
20523 .chapter "The redirect router" "CHAPredirect"
20524 .scindex IIDredrou1 "&(redirect)& router"
20525 .scindex IIDredrou2 "routers" "&(redirect)&"
20526 .cindex "alias file" "in a &(redirect)& router"
20527 .cindex "address redirection" "&(redirect)& router"
20528 The &(redirect)& router handles several kinds of address redirection. Its most
20529 common uses are for resolving local part aliases from a central alias file
20530 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20531 files, but it has many other potential uses. The incoming address can be
20532 redirected in several different ways:
20533
20534 .ilist
20535 It can be replaced by one or more new addresses which are themselves routed
20536 independently.
20537 .next
20538 It can be routed to be delivered to a given file or directory.
20539 .next
20540 It can be routed to be delivered to a specified pipe command.
20541 .next
20542 It can cause an automatic reply to be generated.
20543 .next
20544 It can be forced to fail, optionally with a custom error message.
20545 .next
20546 It can be temporarily deferred, optionally with a custom message.
20547 .next
20548 It can be discarded.
20549 .endlist
20550
20551 The generic &%transport%& option must not be set for &(redirect)& routers.
20552 However, there are some private options which define transports for delivery to
20553 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20554 &%pipe_transport%& and &%reply_transport%& descriptions below.
20555
20556 If success DSNs have been requested
20557 .cindex "DSN" "success"
20558 .cindex "Delivery Status Notification" "success"
20559 redirection triggers one and the DSN options are not passed any further.
20560
20561
20562
20563 .section "Redirection data" "SECID124"
20564 The router operates by interpreting a text string which it obtains either by
20565 expanding the contents of the &%data%& option, or by reading the entire
20566 contents of a file whose name is given in the &%file%& option. These two
20567 options are mutually exclusive. The first is commonly used for handling system
20568 aliases, in a configuration like this:
20569 .code
20570 system_aliases:
20571   driver = redirect
20572   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20573 .endd
20574 If the lookup fails, the expanded string in this example is empty. When the
20575 expansion of &%data%& results in an empty string, the router declines. A forced
20576 expansion failure also causes the router to decline; other expansion failures
20577 cause delivery to be deferred.
20578
20579 A configuration using &%file%& is commonly used for handling users'
20580 &_.forward_& files, like this:
20581 .code
20582 userforward:
20583   driver = redirect
20584   check_local_user
20585   file = $home/.forward
20586   no_verify
20587 .endd
20588 If the file does not exist, or causes no action to be taken (for example, it is
20589 empty or consists only of comments), the router declines. &*Warning*&: This
20590 is not the case when the file contains syntactically valid items that happen to
20591 yield empty addresses, for example, items containing only RFC 2822 address
20592 comments.
20593
20594 .new
20595 .cindex "tainted data" "in filenames"
20596 .cindex redirect "tainted data"
20597 Tainted data may not be used for a filename.
20598
20599 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20600 directly for redirection,
20601 as they are provided by a potential attacker.
20602 In the examples above, &$local_part$& is used for looking up data held locally
20603 on the system, and not used directly (the second example derives &$home$& via
20604 the passsword file or database, using &$local_part$&).
20605 .wen
20606
20607
20608
20609 .section "Forward files and address verification" "SECID125"
20610 .cindex "address redirection" "while verifying"
20611 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20612 &_.forward_& files, as in the example above. There are two reasons for this:
20613
20614 .ilist
20615 When Exim is receiving an incoming SMTP message from a remote host, it is
20616 running under the Exim uid, not as root. Exim is unable to change uid to read
20617 the file as the user, and it may not be able to read it as the Exim user. So in
20618 practice the router may not be able to operate.
20619 .next
20620 However, even when the router can operate, the existence of a &_.forward_& file
20621 is unimportant when verifying an address. What should be checked is whether the
20622 local part is a valid user name or not. Cutting out the redirection processing
20623 saves some resources.
20624 .endlist
20625
20626
20627
20628
20629
20630
20631 .section "Interpreting redirection data" "SECID126"
20632 .cindex "Sieve filter" "specifying in redirection data"
20633 .cindex "filter" "specifying in redirection data"
20634 The contents of the data string, whether obtained from &%data%& or &%file%&,
20635 can be interpreted in two different ways:
20636
20637 .ilist
20638 If the &%allow_filter%& option is set true, and the data begins with the text
20639 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20640 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20641 respectively. Details of the syntax and semantics of filter files are described
20642 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20643 document is intended for use by end users.
20644 .next
20645 Otherwise, the data must be a comma-separated list of redirection items, as
20646 described in the next section.
20647 .endlist
20648
20649 When a message is redirected to a file (a &"mail folder"&), the filename given
20650 in a non-filter redirection list must always be an absolute path. A filter may
20651 generate a relative path &-- how this is handled depends on the transport's
20652 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20653 for the &(appendfile)& transport.
20654
20655
20656
20657 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20658 .cindex "address redirection" "non-filter list items"
20659 When the redirection data is not an Exim or Sieve filter, for example, if it
20660 comes from a conventional alias or forward file, it consists of a list of
20661 addresses, filenames, pipe commands, or certain special items (see section
20662 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20663 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20664 depending on their default values. The items in the list are separated by
20665 commas or newlines.
20666 If a comma is required in an item, the entire item must be enclosed in double
20667 quotes.
20668
20669 Lines starting with a # character are comments, and are ignored, and # may
20670 also appear following a comma, in which case everything between the # and the
20671 next newline character is ignored.
20672
20673 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20674 double quotes are retained because some forms of mail address require their use
20675 (but never to enclose the entire address). In the following description,
20676 &"item"& refers to what remains after any surrounding double quotes have been
20677 removed.
20678
20679 .vindex "&$local_part$&"
20680 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20681 and the expansion contains a reference to &$local_part$&, you should make use
20682 of the &%quote_local_part%& expansion operator, in case the local part contains
20683 special characters. For example, to redirect all mail for the domain
20684 &'obsolete.example'&, retaining the existing local part, you could use this
20685 setting:
20686 .code
20687 data = ${quote_local_part:$local_part}@newdomain.example
20688 .endd
20689
20690
20691 .section "Redirecting to a local mailbox" "SECTredlocmai"
20692 .cindex "routing" "loops in"
20693 .cindex "loop" "while routing, avoidance of"
20694 .cindex "address redirection" "to local mailbox"
20695 A redirection item may safely be the same as the address currently under
20696 consideration. This does not cause a routing loop, because a router is
20697 automatically skipped if any ancestor of the address that is being processed
20698 is the same as the current address and was processed by the current router.
20699 Such an address is therefore passed to the following routers, so it is handled
20700 as if there were no redirection. When making this loop-avoidance test, the
20701 complete local part, including any prefix or suffix, is used.
20702
20703 .cindex "address redirection" "local part without domain"
20704 Specifying the same local part without a domain is a common usage in personal
20705 filter files when the user wants to have messages delivered to the local
20706 mailbox and also forwarded elsewhere. For example, the user whose login is
20707 &'cleo'& might have a &_.forward_& file containing this:
20708 .code
20709 cleo, cleopatra@egypt.example
20710 .endd
20711 .cindex "backslash in alias file"
20712 .cindex "alias file" "backslash in"
20713 For compatibility with other MTAs, such unqualified local parts may be
20714 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20715 it does make a difference if more than one domain is being handled
20716 synonymously.
20717
20718 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20719 2822 address that does not include a domain, the item is qualified using the
20720 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20721 addresses are qualified using the value in &%qualify_recipient%&, but you can
20722 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20723
20724 Care must be taken if there are alias names for local users.
20725 Consider an MTA handling a single local domain where the system alias file
20726 contains:
20727 .code
20728 Sam.Reman: spqr
20729 .endd
20730 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20731 messages in the local mailbox, and also forward copies elsewhere. He creates
20732 this forward file:
20733 .code
20734 Sam.Reman, spqr@reme.elsewhere.example
20735 .endd
20736 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20737 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20738 second time round, because it has previously routed it,
20739 and the following routers presumably cannot handle the alias. The forward file
20740 should really contain
20741 .code
20742 spqr, spqr@reme.elsewhere.example
20743 .endd
20744 but because this is such a common error, the &%check_ancestor%& option (see
20745 below) exists to provide a way to get round it. This is normally set on a
20746 &(redirect)& router that is handling users' &_.forward_& files.
20747
20748
20749
20750 .section "Special items in redirection lists" "SECTspecitredli"
20751 In addition to addresses, the following types of item may appear in redirection
20752 lists (that is, in non-filter redirection data):
20753
20754 .ilist
20755 .cindex "pipe" "in redirection list"
20756 .cindex "address redirection" "to pipe"
20757 An item is treated as a pipe command if it begins with &"|"& and does not parse
20758 as a valid RFC 2822 address that includes a domain. A transport for running the
20759 command must be specified by the &%pipe_transport%& option.
20760 Normally, either the router or the transport specifies a user and a group under
20761 which to run the delivery. The default is to use the Exim user and group.
20762
20763 Single or double quotes can be used for enclosing the individual arguments of
20764 the pipe command; no interpretation of escapes is done for single quotes. If
20765 the command contains a comma character, it is necessary to put the whole item
20766 in double quotes, for example:
20767 .code
20768 "|/some/command ready,steady,go"
20769 .endd
20770 since items in redirection lists are terminated by commas. Do not, however,
20771 quote just the command. An item such as
20772 .code
20773 |"/some/command ready,steady,go"
20774 .endd
20775 is interpreted as a pipe with a rather strange command name, and no arguments.
20776
20777 Note that the above example assumes that the text comes from a lookup source
20778 of some sort, so that the quotes are part of the data.  If composing a
20779 redirect router with a &%data%& option directly specifying this command, the
20780 quotes will be used by the configuration parser to define the extent of one
20781 string, but will not be passed down into the redirect router itself.  There
20782 are two main approaches to get around this: escape quotes to be part of the
20783 data itself, or avoid using this mechanism and instead create a custom
20784 transport with the &%command%& option set and reference that transport from
20785 an &%accept%& router.
20786
20787 .next
20788 .cindex "file" "in redirection list"
20789 .cindex "address redirection" "to file"
20790 An item is interpreted as a path name if it begins with &"/"& and does not
20791 parse as a valid RFC 2822 address that includes a domain. For example,
20792 .code
20793 /home/world/minbari
20794 .endd
20795 is treated as a filename, but
20796 .code
20797 /s=molari/o=babylon/@x400gate.way
20798 .endd
20799 is treated as an address. For a filename, a transport must be specified using
20800 the &%file_transport%& option. However, if the generated path name ends with a
20801 forward slash character, it is interpreted as a directory name rather than a
20802 filename, and &%directory_transport%& is used instead.
20803
20804 Normally, either the router or the transport specifies a user and a group under
20805 which to run the delivery. The default is to use the Exim user and group.
20806
20807 .cindex "&_/dev/null_&"
20808 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20809 bypassed at a high level, and the log entry shows &"**bypassed**"&
20810 instead of a transport name. In this case the user and group are not used.
20811
20812 .next
20813 .cindex "included address list"
20814 .cindex "address redirection" "included external list"
20815 If an item is of the form
20816 .code
20817 :include:<path name>
20818 .endd
20819 a list of further items is taken from the given file and included at that
20820 point. &*Note*&: Such a file can not be a filter file; it is just an
20821 out-of-line addition to the list. The items in the included list are separated
20822 by commas or newlines and are not subject to expansion. If this is the first
20823 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20824 the alias name. This example is incorrect:
20825 .code
20826 list1    :include:/opt/lists/list1
20827 .endd
20828 It must be given as
20829 .code
20830 list1:   :include:/opt/lists/list1
20831 .endd
20832 .new
20833 .cindex "tainted data" "in filenames"
20834 .cindex redirect "tainted data"
20835 Tainted data may not be used for a filename.
20836 .wen
20837 .next
20838 .cindex "address redirection" "to black hole"
20839 .cindex "delivery" "discard"
20840 .cindex "delivery" "blackhole"
20841 .cindex "black hole"
20842 .cindex "abandoning mail"
20843 Sometimes you want to throw away mail to a particular local part.  Making the
20844 &%data%& option expand to an empty string does not work, because that causes
20845 the router to decline. Instead, the alias item
20846 .code
20847 :blackhole:
20848 .endd
20849 can be used. It does what its name implies. No delivery is
20850 done, and no error message is generated. This has the same effect as specifying
20851 &_/dev/null_& as a destination, but it can be independently disabled.
20852
20853 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20854 delivery is done for the original local part, even if other redirection items
20855 are present. If you are generating a multi-item list (for example, by reading a
20856 database) and need the ability to provide a no-op item, you must use
20857 &_/dev/null_&.
20858
20859 .next
20860 .cindex "delivery" "forcing failure"
20861 .cindex "delivery" "forcing deferral"
20862 .cindex "failing delivery" "forcing"
20863 .cindex "deferred delivery, forcing"
20864 .cindex "customizing" "failure message"
20865 An attempt to deliver a particular address can be deferred or forced to fail by
20866 redirection items of the form
20867 .code
20868 :defer:
20869 :fail:
20870 .endd
20871 respectively. When a redirection list contains such an item, it applies
20872 to the entire redirection; any other items in the list are ignored. Any
20873 text following &':fail:'& or &':defer:'& is placed in the error text
20874 associated with the failure. For example, an alias file might contain:
20875 .code
20876 X.Employee:  :fail: Gone away, no forwarding address
20877 .endd
20878 In the case of an address that is being verified from an ACL or as the subject
20879 of a
20880 .cindex "VRFY" "error text, display of"
20881 VRFY command, the text is included in the SMTP error response by
20882 default.
20883 .cindex "EXPN" "error text, display of"
20884 The text is not included in the response to an EXPN command. In non-SMTP cases
20885 the text is included in the error message that Exim generates.
20886
20887 .cindex "SMTP" "error codes"
20888 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20889 &':fail:'&. However, if the message starts with three digits followed by a
20890 space, optionally followed by an extended code of the form &'n.n.n'&, also
20891 followed by a space, and the very first digit is the same as the default error
20892 code, the code from the message is used instead. If the very first digit is
20893 incorrect, a panic error is logged, and the default code is used. You can
20894 suppress the use of the supplied code in a redirect router by setting the
20895 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20896 ignored.
20897
20898 .vindex "&$acl_verify_message$&"
20899 In an ACL, an explicitly provided message overrides the default, but the
20900 default message is available in the variable &$acl_verify_message$& and can
20901 therefore be included in a custom message if this is desired.
20902
20903 Normally the error text is the rest of the redirection list &-- a comma does
20904 not terminate it &-- but a newline does act as a terminator. Newlines are not
20905 normally present in alias expansions. In &(lsearch)& lookups they are removed
20906 as part of the continuation process, but they may exist in other kinds of
20907 lookup and in &':include:'& files.
20908
20909 During routing for message delivery (as opposed to verification), a redirection
20910 containing &':fail:'& causes an immediate failure of the incoming address,
20911 whereas &':defer:'& causes the message to remain in the queue so that a
20912 subsequent delivery attempt can happen at a later time. If an address is
20913 deferred for too long, it will ultimately fail, because the normal retry
20914 rules still apply.
20915
20916 .next
20917 .cindex "alias file" "exception to default"
20918 Sometimes it is useful to use a single-key search type with a default (see
20919 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20920 for exceptions to the default. These can be handled by aliasing them to
20921 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20922 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20923 results in an empty redirection list has the same effect.
20924 .endlist
20925
20926
20927 .section "Duplicate addresses" "SECTdupaddr"
20928 .cindex "duplicate addresses"
20929 .cindex "address duplicate, discarding"
20930 .cindex "pipe" "duplicated"
20931 Exim removes duplicate addresses from the list to which it is delivering, so as
20932 to deliver just one copy to each address. This does not apply to deliveries
20933 routed to pipes by different immediate parent addresses, but an indirect
20934 aliasing scheme of the type
20935 .code
20936 pipe:       |/some/command $local_part
20937 localpart1: pipe
20938 localpart2: pipe
20939 .endd
20940 does not work with a message that is addressed to both local parts, because
20941 when the second is aliased to the intermediate local part &"pipe"& it gets
20942 discarded as being the same as a previously handled address. However, a scheme
20943 such as
20944 .code
20945 localpart1: |/some/command $local_part
20946 localpart2: |/some/command $local_part
20947 .endd
20948 does result in two different pipe deliveries, because the immediate parents of
20949 the pipes are distinct.
20950
20951
20952
20953 .section "Repeated redirection expansion" "SECID128"
20954 .cindex "repeated redirection expansion"
20955 .cindex "address redirection" "repeated for each delivery attempt"
20956 When a message cannot be delivered to all of its recipients immediately,
20957 leading to two or more delivery attempts, redirection expansion is carried out
20958 afresh each time for those addresses whose children were not all previously
20959 delivered. If redirection is being used as a mailing list, this can lead to new
20960 members of the list receiving copies of old messages. The &%one_time%& option
20961 can be used to avoid this.
20962
20963
20964 .section "Errors in redirection lists" "SECID129"
20965 .cindex "address redirection" "errors"
20966 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20967 error is skipped, and an entry is written to the main log. This may be useful
20968 for mailing lists that are automatically managed. Otherwise, if an error is
20969 detected while generating the list of new addresses, the original address is
20970 deferred. See also &%syntax_errors_to%&.
20971
20972
20973
20974 .section "Private options for the redirect router" "SECID130"
20975
20976 .cindex "options" "&(redirect)& router"
20977 The private options for the &(redirect)& router are as follows:
20978
20979
20980 .option allow_defer redirect boolean false
20981 Setting this option allows the use of &':defer:'& in non-filter redirection
20982 data, or the &%defer%& command in an Exim filter file.
20983
20984
20985 .option allow_fail redirect boolean false
20986 .cindex "failing delivery" "from filter"
20987 If this option is true, the &':fail:'& item can be used in a redirection list,
20988 and the &%fail%& command may be used in an Exim filter file.
20989
20990
20991 .option allow_filter redirect boolean false
20992 .cindex "filter" "enabling use of"
20993 .cindex "Sieve filter" "enabling use of"
20994 Setting this option allows Exim to interpret redirection data that starts with
20995 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20996 are some features of Exim filter files that some administrators may wish to
20997 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20998
20999 It is also possible to lock out Exim filters or Sieve filters while allowing
21000 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21001
21002
21003 The filter is run using the uid and gid set by the generic &%user%& and
21004 &%group%& options. These take their defaults from the password data if
21005 &%check_local_user%& is set, so in the normal case of users' personal filter
21006 files, the filter is run as the relevant user. When &%allow_filter%& is set
21007 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21008
21009
21010
21011 .option allow_freeze redirect boolean false
21012 .cindex "freezing messages" "allowing in filter"
21013 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21014 This command is more normally encountered in system filters, and is disabled by
21015 default for redirection filters because it isn't something you usually want to
21016 let ordinary users do.
21017
21018
21019
21020 .option check_ancestor redirect boolean false
21021 This option is concerned with handling generated addresses that are the same
21022 as some address in the list of redirection ancestors of the current address.
21023 Although it is turned off by default in the code, it is set in the default
21024 configuration file for handling users' &_.forward_& files. It is recommended
21025 for this use of the &(redirect)& router.
21026
21027 When &%check_ancestor%& is set, if a generated address (including the domain)
21028 is the same as any ancestor of the current address, it is replaced by a copy of
21029 the current address. This helps in the case where local part A is aliased to B,
21030 and B has a &_.forward_& file pointing back to A. For example, within a single
21031 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21032 &_&~jb/.forward_& contains:
21033 .code
21034 \Joe.Bloggs, <other item(s)>
21035 .endd
21036 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21037 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21038 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21039 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21040 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21041 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21042 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21043 original address. See also the &%repeat_use%& option below.
21044
21045
21046 .option check_group redirect boolean "see below"
21047 When the &%file%& option is used, the group owner of the file is checked only
21048 when this option is set. The permitted groups are those listed in the
21049 &%owngroups%& option, together with the user's default group if
21050 &%check_local_user%& is set. If the file has the wrong group, routing is
21051 deferred. The default setting for this option is true if &%check_local_user%&
21052 is set and the &%modemask%& option permits the group write bit, or if the
21053 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21054
21055
21056
21057 .option check_owner redirect boolean "see below"
21058 When the &%file%& option is used, the owner of the file is checked only when
21059 this option is set. If &%check_local_user%& is set, the local user is
21060 permitted; otherwise the owner must be one of those listed in the &%owners%&
21061 option. The default value for this option is true if &%check_local_user%& or
21062 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21063
21064
21065 .option data redirect string&!! unset
21066 This option is mutually exclusive with &%file%&. One or other of them must be
21067 set, but not both. The contents of &%data%& are expanded, and then used as the
21068 list of forwarding items, or as a set of filtering instructions. If the
21069 expansion is forced to fail, or the result is an empty string or a string that
21070 has no effect (consists entirely of comments), the router declines.
21071
21072 When filtering instructions are used, the string must begin with &"#Exim
21073 filter"&, and all comments in the string, including this initial one, must be
21074 terminated with newline characters. For example:
21075 .code
21076 data = #Exim filter\n\
21077        if $h_to: contains Exim then save $home/mail/exim endif
21078 .endd
21079 If you are reading the data from a database where newlines cannot be included,
21080 you can use the &${sg}$& expansion item to turn the escape string of your
21081 choice into a newline.
21082
21083
21084 .option directory_transport redirect string&!! unset
21085 A &(redirect)& router sets up a direct delivery to a directory when a path name
21086 ending with a slash is specified as a new &"address"&. The transport used is
21087 specified by this option, which, after expansion, must be the name of a
21088 configured transport. This should normally be an &(appendfile)& transport.
21089
21090
21091 .option file redirect string&!! unset
21092 This option specifies the name of a file that contains the redirection data. It
21093 is mutually exclusive with the &%data%& option. The string is expanded before
21094 use; if the expansion is forced to fail, the router declines. Other expansion
21095 failures cause delivery to be deferred. The result of a successful expansion
21096 must be an absolute path. The entire file is read and used as the redirection
21097 data. If the data is an empty string or a string that has no effect (consists
21098 entirely of comments), the router declines.
21099
21100 .cindex "NFS" "checking for file existence"
21101 If the attempt to open the file fails with a &"does not exist"& error, Exim
21102 runs a check on the containing directory,
21103 unless &%ignore_enotdir%& is true (see below).
21104 If the directory does not appear to exist, delivery is deferred. This can
21105 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21106 is a mount problem. If the containing directory does exist, but the file does
21107 not, the router declines.
21108
21109
21110 .option file_transport redirect string&!! unset
21111 .vindex "&$address_file$&"
21112 A &(redirect)& router sets up a direct delivery to a file when a path name not
21113 ending in a slash is specified as a new &"address"&. The transport used is
21114 specified by this option, which, after expansion, must be the name of a
21115 configured transport. This should normally be an &(appendfile)& transport. When
21116 it is running, the filename is in &$address_file$&.
21117
21118
21119 .option filter_prepend_home redirect boolean true
21120 When this option is true, if a &(save)& command in an Exim filter specifies a
21121 relative path, and &$home$& is defined, it is automatically prepended to the
21122 relative path. If this option is set false, this action does not happen. The
21123 relative path is then passed to the transport unmodified.
21124
21125
21126 .option forbid_blackhole redirect boolean false
21127 .cindex "restricting access to features"
21128 .cindex "filter" "locking out certain features"
21129 If this option is true, the &':blackhole:'& item may not appear in a
21130 redirection list.
21131
21132
21133 .option forbid_exim_filter redirect boolean false
21134 .cindex "restricting access to features"
21135 .cindex "filter" "locking out certain features"
21136 If this option is set true, only Sieve filters are permitted when
21137 &%allow_filter%& is true.
21138
21139
21140
21141
21142 .option forbid_file redirect boolean false
21143 .cindex "restricting access to features"
21144 .cindex "delivery" "to file; forbidding"
21145 .cindex "filter" "locking out certain features"
21146 .cindex "Sieve filter" "forbidding delivery to a file"
21147 .cindex "Sieve filter" "&""keep""& facility; disabling"
21148 If this option is true, this router may not generate a new address that
21149 specifies delivery to a local file or directory, either from a filter or from a
21150 conventional forward file. This option is forced to be true if &%one_time%& is
21151 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21152 locks out the Sieve's &"keep"& facility.
21153
21154
21155 .option forbid_filter_dlfunc redirect boolean false
21156 .cindex "restricting access to features"
21157 .cindex "filter" "locking out certain features"
21158 If this option is true, string expansions in Exim filters are not allowed to
21159 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21160 functions.
21161
21162 .option forbid_filter_existstest redirect boolean false
21163 .cindex "restricting access to features"
21164 .cindex "filter" "locking out certain features"
21165 .cindex "expansion" "statting a file"
21166 If this option is true, string expansions in Exim filters are not allowed to
21167 make use of the &%exists%& condition or the &%stat%& expansion item.
21168
21169 .option forbid_filter_logwrite redirect boolean false
21170 .cindex "restricting access to features"
21171 .cindex "filter" "locking out certain features"
21172 If this option is true, use of the logging facility in Exim filters is not
21173 permitted. Logging is in any case available only if the filter is being run
21174 under some unprivileged uid (which is normally the case for ordinary users'
21175 &_.forward_& files).
21176
21177
21178 .option forbid_filter_lookup redirect boolean false
21179 .cindex "restricting access to features"
21180 .cindex "filter" "locking out certain features"
21181 If this option is true, string expansions in Exim filter files are not allowed
21182 to make use of &%lookup%& items.
21183
21184
21185 .option forbid_filter_perl redirect boolean false
21186 .cindex "restricting access to features"
21187 .cindex "filter" "locking out certain features"
21188 This option has an effect only if Exim is built with embedded Perl support. If
21189 it is true, string expansions in Exim filter files are not allowed to make use
21190 of the embedded Perl support.
21191
21192
21193 .option forbid_filter_readfile redirect boolean false
21194 .cindex "restricting access to features"
21195 .cindex "filter" "locking out certain features"
21196 If this option is true, string expansions in Exim filter files are not allowed
21197 to make use of &%readfile%& items.
21198
21199
21200 .option forbid_filter_readsocket redirect boolean false
21201 .cindex "restricting access to features"
21202 .cindex "filter" "locking out certain features"
21203 If this option is true, string expansions in Exim filter files are not allowed
21204 to make use of &%readsocket%& items.
21205
21206
21207 .option forbid_filter_reply redirect boolean false
21208 .cindex "restricting access to features"
21209 .cindex "filter" "locking out certain features"
21210 If this option is true, this router may not generate an automatic reply
21211 message. Automatic replies can be generated only from Exim or Sieve filter
21212 files, not from traditional forward files. This option is forced to be true if
21213 &%one_time%& is set.
21214
21215
21216 .option forbid_filter_run redirect boolean false
21217 .cindex "restricting access to features"
21218 .cindex "filter" "locking out certain features"
21219 If this option is true, string expansions in Exim filter files are not allowed
21220 to make use of &%run%& items.
21221
21222
21223 .option forbid_include redirect boolean false
21224 .cindex "restricting access to features"
21225 .cindex "filter" "locking out certain features"
21226 If this option is true, items of the form
21227 .code
21228 :include:<path name>
21229 .endd
21230 are not permitted in non-filter redirection lists.
21231
21232
21233 .option forbid_pipe redirect boolean false
21234 .cindex "restricting access to features"
21235 .cindex "filter" "locking out certain features"
21236 .cindex "delivery" "to pipe; forbidding"
21237 If this option is true, this router may not generate a new address which
21238 specifies delivery to a pipe, either from an Exim filter or from a conventional
21239 forward file. This option is forced to be true if &%one_time%& is set.
21240
21241
21242 .option forbid_sieve_filter redirect boolean false
21243 .cindex "restricting access to features"
21244 .cindex "filter" "locking out certain features"
21245 If this option is set true, only Exim filters are permitted when
21246 &%allow_filter%& is true.
21247
21248
21249 .cindex "SMTP" "error codes"
21250 .option forbid_smtp_code redirect boolean false
21251 If this option is set true, any SMTP error codes that are present at the start
21252 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21253 the default codes (451 and 550, respectively) are always used.
21254
21255
21256
21257
21258 .option hide_child_in_errmsg redirect boolean false
21259 .cindex "bounce message" "redirection details; suppressing"
21260 If this option is true, it prevents Exim from quoting a child address if it
21261 generates a bounce or delay message for it. Instead it says &"an address
21262 generated from <&'the top level address'&>"&. Of course, this applies only to
21263 bounces generated locally. If a message is forwarded to another host, &'its'&
21264 bounce may well quote the generated address.
21265
21266
21267 .option ignore_eacces redirect boolean false
21268 .cindex "EACCES"
21269 If this option is set and an attempt to open a redirection file yields the
21270 EACCES error (permission denied), the &(redirect)& router behaves as if the
21271 file did not exist.
21272
21273
21274 .option ignore_enotdir redirect boolean false
21275 .cindex "ENOTDIR"
21276 If this option is set and an attempt to open a redirection file yields the
21277 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21278 router behaves as if the file did not exist.
21279
21280 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21281 router that has the &%file%& option set discovers that the file does not exist
21282 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21283 against unmounted NFS directories. If the parent can not be statted, delivery
21284 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21285 is set, because that option tells Exim to ignore &"something on the path is not
21286 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21287 that some operating systems give ENOENT where others give ENOTDIR.
21288
21289
21290
21291 .option include_directory redirect string unset
21292 If this option is set, the path names of any &':include:'& items in a
21293 redirection list must start with this directory.
21294
21295
21296 .option modemask redirect "octal integer" 022
21297 This specifies mode bits which must not be set for a file specified by the
21298 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21299
21300
21301 .option one_time redirect boolean false
21302 .cindex "one-time aliasing/forwarding expansion"
21303 .cindex "alias file" "one-time expansion"
21304 .cindex "forward file" "one-time expansion"
21305 .cindex "mailing lists" "one-time expansion"
21306 .cindex "address redirection" "one-time expansion"
21307 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21308 files each time it tries to deliver a message causes a problem when one or more
21309 of the generated addresses fails be delivered at the first attempt. The problem
21310 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21311 but of what happens when the redirection list changes during the time that the
21312 message is on Exim's queue. This is particularly true in the case of mailing
21313 lists, where new subscribers might receive copies of messages that were posted
21314 before they subscribed.
21315
21316 If &%one_time%& is set and any addresses generated by the router fail to
21317 deliver at the first attempt, the failing addresses are added to the message as
21318 &"top level"& addresses, and the parent address that generated them is marked
21319 &"delivered"&. Thus, redirection does not happen again at the next delivery
21320 attempt.
21321
21322 &*Warning 1*&: Any header line addition or removal that is specified by this
21323 router would be lost if delivery did not succeed at the first attempt. For this
21324 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21325 permitted when &%one_time%& is set.
21326
21327 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21328 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21329 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21330
21331 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21332 &%one_time%&.
21333
21334 The original top-level address is remembered with each of the generated
21335 addresses, and is output in any log messages. However, any intermediate parent
21336 addresses are not recorded. This makes a difference to the log only if
21337 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21338 typically be used for mailing lists, where there is normally just one level of
21339 expansion.
21340
21341
21342 .option owners redirect "string list" unset
21343 .cindex "ownership" "alias file"
21344 .cindex "ownership" "forward file"
21345 .cindex "alias file" "ownership"
21346 .cindex "forward file" "ownership"
21347 This specifies a list of permitted owners for the file specified by &%file%&.
21348 This list is in addition to the local user when &%check_local_user%& is set.
21349 See &%check_owner%& above.
21350
21351
21352 .option owngroups redirect "string list" unset
21353 This specifies a list of permitted groups for the file specified by &%file%&.
21354 The list is in addition to the local user's primary group when
21355 &%check_local_user%& is set. See &%check_group%& above.
21356
21357
21358 .option pipe_transport redirect string&!! unset
21359 .vindex "&$address_pipe$&"
21360 A &(redirect)& router sets up a direct delivery to a pipe when a string
21361 starting with a vertical bar character is specified as a new &"address"&. The
21362 transport used is specified by this option, which, after expansion, must be the
21363 name of a configured transport. This should normally be a &(pipe)& transport.
21364 When the transport is run, the pipe command is in &$address_pipe$&.
21365
21366
21367 .option qualify_domain redirect string&!! unset
21368 .vindex "&$qualify_recipient$&"
21369 If this option is set, and an unqualified address (one without a domain) is
21370 generated, and that address would normally be qualified by the global setting
21371 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21372 expanding this string. If the expansion fails, the router declines. If you want
21373 to revert to the default, you can have the expansion generate
21374 &$qualify_recipient$&.
21375
21376 This option applies to all unqualified addresses generated by Exim filters,
21377 but for traditional &_.forward_& files, it applies only to addresses that are
21378 not preceded by a backslash. Sieve filters cannot generate unqualified
21379 addresses.
21380
21381 .option qualify_preserve_domain redirect boolean false
21382 .cindex "domain" "in redirection; preserving"
21383 .cindex "preserving domain in redirection"
21384 .cindex "address redirection" "domain; preserving"
21385 If this option is set, the router's local &%qualify_domain%& option must not be
21386 set (a configuration error occurs if it is). If an unqualified address (one
21387 without a domain) is generated, it is qualified with the domain of the parent
21388 address (the immediately preceding ancestor) instead of the global
21389 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21390 this applies whether or not the address is preceded by a backslash.
21391
21392
21393 .option repeat_use redirect boolean true
21394 If this option is set false, the router is skipped for a child address that has
21395 any ancestor that was routed by this router. This test happens before any of
21396 the other preconditions are tested. Exim's default anti-looping rules skip
21397 only when the ancestor is the same as the current address. See also
21398 &%check_ancestor%& above and the generic &%redirect_router%& option.
21399
21400
21401 .option reply_transport redirect string&!! unset
21402 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21403 &%vacation%& command is used in a filter file. The transport used is specified
21404 by this option, which, after expansion, must be the name of a configured
21405 transport. This should normally be an &(autoreply)& transport. Other transports
21406 are unlikely to do anything sensible or useful.
21407
21408
21409 .option rewrite redirect boolean true
21410 .cindex "address redirection" "disabling rewriting"
21411 If this option is set false, addresses generated by the router are not
21412 subject to address rewriting. Otherwise, they are treated like new addresses
21413 and are rewritten according to the global rewriting rules.
21414
21415
21416 .option sieve_subaddress redirect string&!! unset
21417 The value of this option is passed to a Sieve filter to specify the
21418 :subaddress part of an address.
21419
21420 .option sieve_useraddress redirect string&!! unset
21421 The value of this option is passed to a Sieve filter to specify the :user part
21422 of an address. However, if it is unset, the entire original local part
21423 (including any prefix or suffix) is used for :user.
21424
21425
21426 .option sieve_vacation_directory redirect string&!! unset
21427 .cindex "Sieve filter" "vacation directory"
21428 To enable the &"vacation"& extension for Sieve filters, you must set
21429 &%sieve_vacation_directory%& to the directory where vacation databases are held
21430 (do not put anything else in that directory), and ensure that the
21431 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21432 needs their own directory; Exim will create it if necessary.
21433
21434
21435
21436 .option skip_syntax_errors redirect boolean false
21437 .cindex "forward file" "broken"
21438 .cindex "address redirection" "broken files"
21439 .cindex "alias file" "broken"
21440 .cindex "broken alias or forward files"
21441 .cindex "ignoring faulty addresses"
21442 .cindex "skipping faulty addresses"
21443 .cindex "error" "skipping bad syntax"
21444 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21445 non-filter redirection data are skipped, and each failing address is logged. If
21446 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21447 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21448 are expanded and placed at the head of the error message generated by
21449 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21450 be the same address as the generic &%errors_to%& option. The
21451 &%skip_syntax_errors%& option is often used when handling mailing lists.
21452
21453 If all the addresses in a redirection list are skipped because of syntax
21454 errors, the router declines to handle the original address, and it is passed to
21455 the following routers.
21456
21457 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21458 error in the filter causes filtering to be abandoned without any action being
21459 taken. The incident is logged, and the router declines to handle the address,
21460 so it is passed to the following routers.
21461
21462 .cindex "Sieve filter" "syntax errors in"
21463 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21464 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21465 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21466
21467 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21468 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21469 option, used with an address that does not get redirected, can be used to
21470 notify users of these errors, by means of a router like this:
21471 .code
21472 userforward:
21473   driver = redirect
21474   allow_filter
21475   check_local_user
21476   file = $home/.forward
21477   file_transport = address_file
21478   pipe_transport = address_pipe
21479   reply_transport = address_reply
21480   no_verify
21481   skip_syntax_errors
21482   syntax_errors_to = real-$local_part@$domain
21483   syntax_errors_text = \
21484    This is an automatically generated message. An error has\n\
21485    been found in your .forward file. Details of the error are\n\
21486    reported below. While this error persists, you will receive\n\
21487    a copy of this message for every message that is addressed\n\
21488    to you. If your .forward file is a filter file, or if it is\n\
21489    a non-filter file containing no valid forwarding addresses,\n\
21490    a copy of each incoming message will be put in your normal\n\
21491    mailbox. If a non-filter file contains at least one valid\n\
21492    forwarding address, forwarding to the valid addresses will\n\
21493    happen, and those will be the only deliveries that occur.
21494 .endd
21495 You also need a router to ensure that local addresses that are prefixed by
21496 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21497 put this immediately before the &(userforward)& router:
21498 .code
21499 real_localuser:
21500   driver = accept
21501   check_local_user
21502   local_part_prefix = real-
21503   transport = local_delivery
21504 .endd
21505 For security, it would probably be a good idea to restrict the use of this
21506 router to locally-generated messages, using a condition such as this:
21507 .code
21508   condition = ${if match {$sender_host_address}\
21509                          {\N^(|127\.0\.0\.1)$\N}}
21510 .endd
21511
21512
21513 .option syntax_errors_text redirect string&!! unset
21514 See &%skip_syntax_errors%& above.
21515
21516
21517 .option syntax_errors_to redirect string unset
21518 See &%skip_syntax_errors%& above.
21519 .ecindex IIDredrou1
21520 .ecindex IIDredrou2
21521
21522
21523
21524
21525
21526
21527 . ////////////////////////////////////////////////////////////////////////////
21528 . ////////////////////////////////////////////////////////////////////////////
21529
21530 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21531          "Environment for local transports"
21532 .scindex IIDenvlotra1 "local transports" "environment for"
21533 .scindex IIDenvlotra2 "environment" "local transports"
21534 .scindex IIDenvlotra3 "transport" "local; environment for"
21535 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21536 transport can be thought of as similar to a pipe.) Exim always runs transports
21537 in subprocesses, under specified uids and gids. Typical deliveries to local
21538 mailboxes run under the uid and gid of the local user.
21539
21540 Exim also sets a specific current directory while running the transport; for
21541 some transports a home directory setting is also relevant. The &(pipe)&
21542 transport is the only one that sets up environment variables; see section
21543 &<<SECTpipeenv>>& for details.
21544
21545 The values used for the uid, gid, and the directories may come from several
21546 different places. In many cases, the router that handles the address associates
21547 settings with that address as a result of its &%check_local_user%&, &%group%&,
21548 or &%user%& options. However, values may also be given in the transport's own
21549 configuration, and these override anything that comes from the router.
21550
21551
21552
21553 .section "Concurrent deliveries" "SECID131"
21554 .cindex "concurrent deliveries"
21555 .cindex "simultaneous deliveries"
21556 If two different messages for the same local recipient arrive more or less
21557 simultaneously, the two delivery processes are likely to run concurrently. When
21558 the &(appendfile)& transport is used to write to a file, Exim applies locking
21559 rules to stop concurrent processes from writing to the same file at the same
21560 time.
21561
21562 However, when you use a &(pipe)& transport, it is up to you to arrange any
21563 locking that is needed. Here is a silly example:
21564 .code
21565 my_transport:
21566   driver = pipe
21567   command = /bin/sh -c 'cat >>/some/file'
21568 .endd
21569 This is supposed to write the message at the end of the file. However, if two
21570 messages arrive at the same time, the file will be scrambled. You can use the
21571 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21572 file using the same algorithm that Exim itself uses.
21573
21574
21575
21576
21577 .section "Uids and gids" "SECTenvuidgid"
21578 .cindex "local transports" "uid and gid"
21579 .cindex "transport" "local; uid and gid"
21580 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21581 overrides any group that the router set in the address, even if &%user%& is not
21582 set for the transport. This makes it possible, for example, to run local mail
21583 delivery under the uid of the recipient (set by the router), but in a special
21584 group (set by the transport). For example:
21585 .code
21586 # Routers ...
21587 # User/group are set by check_local_user in this router
21588 local_users:
21589   driver = accept
21590   check_local_user
21591   transport = group_delivery
21592
21593 # Transports ...
21594 # This transport overrides the group
21595 group_delivery:
21596   driver = appendfile
21597   file = /var/spool/mail/$local_part
21598   group = mail
21599 .endd
21600 If &%user%& is set for a transport, its value overrides what is set in the
21601 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21602 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21603 set.
21604
21605 .oindex "&%initgroups%&"
21606 When the uid is taken from the transport's configuration, the &[initgroups()]&
21607 function is called for the groups associated with that uid if the
21608 &%initgroups%& option is set for the transport. When the uid is not specified
21609 by the transport, but is associated with the address by a router, the option
21610 for calling &[initgroups()]& is taken from the router configuration.
21611
21612 .cindex "&(pipe)& transport" "uid for"
21613 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21614 is set and &%user%& is not set, the uid of the process that called Exim to
21615 receive the message is used, and if &%group%& is not set, the corresponding
21616 original gid is also used.
21617
21618 This is the detailed preference order for obtaining a gid; the first of the
21619 following that is set is used:
21620
21621 .ilist
21622 A &%group%& setting of the transport;
21623 .next
21624 A &%group%& setting of the router;
21625 .next
21626 A gid associated with a user setting of the router, either as a result of
21627 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21628 .next
21629 The group associated with a non-numeric &%user%& setting of the transport;
21630 .next
21631 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21632 the uid is the creator's uid;
21633 .next
21634 The Exim gid if the Exim uid is being used as a default.
21635 .endlist
21636
21637 If, for example, the user is specified numerically on the router and there are
21638 no group settings, no gid is available. In this situation, an error occurs.
21639 This is different for the uid, for which there always is an ultimate default.
21640 The first of the following that is set is used:
21641
21642 .ilist
21643 A &%user%& setting of the transport;
21644 .next
21645 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21646 .next
21647 A &%user%& setting of the router;
21648 .next
21649 A &%check_local_user%& setting of the router;
21650 .next
21651 The Exim uid.
21652 .endlist
21653
21654 Of course, an error will still occur if the uid that is chosen is on the
21655 &%never_users%& list.
21656
21657
21658
21659
21660
21661 .section "Current and home directories" "SECID132"
21662 .cindex "current directory for local transport"
21663 .cindex "home directory" "for local transport"
21664 .cindex "transport" "local; home directory for"
21665 .cindex "transport" "local; current directory for"
21666 Routers may set current and home directories for local transports by means of
21667 the &%transport_current_directory%& and &%transport_home_directory%& options.
21668 However, if the transport's &%current_directory%& or &%home_directory%& options
21669 are set, they override the router's values. In detail, the home directory
21670 for a local transport is taken from the first of these values that is set:
21671
21672 .ilist
21673 The &%home_directory%& option on the transport;
21674 .next
21675 The &%transport_home_directory%& option on the router;
21676 .next
21677 The password data if &%check_local_user%& is set on the router;
21678 .next
21679 The &%router_home_directory%& option on the router.
21680 .endlist
21681
21682 The current directory is taken from the first of these values that is set:
21683
21684 .ilist
21685 The &%current_directory%& option on the transport;
21686 .next
21687 The &%transport_current_directory%& option on the router.
21688 .endlist
21689
21690
21691 If neither the router nor the transport sets a current directory, Exim uses the
21692 value of the home directory, if it is set. Otherwise it sets the current
21693 directory to &_/_& before running a local transport.
21694
21695
21696
21697 .section "Expansion variables derived from the address" "SECID133"
21698 .vindex "&$domain$&"
21699 .vindex "&$local_part$&"
21700 .vindex "&$original_domain$&"
21701 Normally a local delivery is handling a single address, and in that case the
21702 variables such as &$domain$& and &$local_part$& are set during local
21703 deliveries. However, in some circumstances more than one address may be handled
21704 at once (for example, while writing batch SMTP for onward transmission by some
21705 other means). In this case, the variables associated with the local part are
21706 never set, &$domain$& is set only if all the addresses have the same domain,
21707 and &$original_domain$& is never set.
21708 .ecindex IIDenvlotra1
21709 .ecindex IIDenvlotra2
21710 .ecindex IIDenvlotra3
21711
21712
21713
21714
21715
21716
21717
21718 . ////////////////////////////////////////////////////////////////////////////
21719 . ////////////////////////////////////////////////////////////////////////////
21720
21721 .chapter "Generic options for transports" "CHAPtransportgeneric"
21722 .scindex IIDgenoptra1 "generic options" "transport"
21723 .scindex IIDgenoptra2 "options" "generic; for transports"
21724 .scindex IIDgenoptra3 "transport" "generic options for"
21725 The following generic options apply to all transports:
21726
21727
21728 .option body_only transports boolean false
21729 .cindex "transport" "body only"
21730 .cindex "message" "transporting body only"
21731 .cindex "body of message" "transporting"
21732 If this option is set, the message's headers are not transported. It is
21733 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21734 or &(pipe)& transports, the settings of &%message_prefix%& and
21735 &%message_suffix%& should be checked, because this option does not
21736 automatically suppress them.
21737
21738
21739 .option current_directory transports string&!! unset
21740 .cindex "transport" "current directory for"
21741 This specifies the current directory that is to be set while running the
21742 transport, overriding any value that may have been set by the router.
21743 If the expansion fails for any reason, including forced failure, an error is
21744 logged, and delivery is deferred.
21745
21746
21747 .option disable_logging transports boolean false
21748 If this option is set true, nothing is logged for any
21749 deliveries by the transport or for any
21750 transport errors. You should not set this option unless you really, really know
21751 what you are doing.
21752
21753
21754 .option debug_print transports string&!! unset
21755 .cindex "testing" "variables in drivers"
21756 If this option is set and debugging is enabled (see the &%-d%& command line
21757 option), the string is expanded and included in the debugging output when the
21758 transport is run.
21759 If expansion of the string fails, the error message is written to the debugging
21760 output, and Exim carries on processing.
21761 This facility is provided to help with checking out the values of variables and
21762 so on when debugging driver configurations. For example, if a &%headers_add%&
21763 option is not working properly, &%debug_print%& could be used to output the
21764 variables it references. A newline is added to the text if it does not end with
21765 one.
21766 The variables &$transport_name$& and &$router_name$& contain the name of the
21767 transport and the router that called it.
21768
21769 .option delivery_date_add transports boolean false
21770 .cindex "&'Delivery-date:'& header line"
21771 If this option is true, a &'Delivery-date:'& header is added to the message.
21772 This gives the actual time the delivery was made. As this is not a standard
21773 header, Exim has a configuration option (&%delivery_date_remove%&) which
21774 requests its removal from incoming messages, so that delivered messages can
21775 safely be resent to other recipients.
21776
21777
21778 .option driver transports string unset
21779 This specifies which of the available transport drivers is to be used.
21780 There is no default, and this option must be set for every transport.
21781
21782
21783 .option envelope_to_add transports boolean false
21784 .cindex "&'Envelope-to:'& header line"
21785 If this option is true, an &'Envelope-to:'& header is added to the message.
21786 This gives the original address(es) in the incoming envelope that caused this
21787 delivery to happen. More than one address may be present if the transport is
21788 configured to handle several addresses at once, or if more than one original
21789 address was redirected to the same final address. As this is not a standard
21790 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21791 its removal from incoming messages, so that delivered messages can safely be
21792 resent to other recipients.
21793
21794
21795 .option event_action transports string&!! unset
21796 .cindex events
21797 This option declares a string to be expanded for Exim's events mechanism.
21798 For details see chapter &<<CHAPevents>>&.
21799
21800
21801 .option group transports string&!! "Exim group"
21802 .cindex "transport" "group; specifying"
21803 This option specifies a gid for running the transport process, overriding any
21804 value that the router supplies, and also overriding any value associated with
21805 &%user%& (see below).
21806
21807
21808 .option headers_add transports list&!! unset
21809 .cindex "header lines" "adding in transport"
21810 .cindex "transport" "header lines; adding"
21811 This option specifies a list of text headers,
21812 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21813 which are (separately) expanded and added to the header
21814 portion of a message as it is transported, as described in section
21815 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21816 routers. If the result of the expansion is an empty string, or if the expansion
21817 is forced to fail, no action is taken. Other expansion failures are treated as
21818 errors and cause the delivery to be deferred.
21819
21820 Unlike most options, &%headers_add%& can be specified multiple times
21821 for a transport; all listed headers are added.
21822
21823
21824 .option headers_only transports boolean false
21825 .cindex "transport" "header lines only"
21826 .cindex "message" "transporting headers only"
21827 .cindex "header lines" "transporting"
21828 If this option is set, the message's body is not transported. It is mutually
21829 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21830 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21831 checked, since this option does not automatically suppress them.
21832
21833
21834 .option headers_remove transports list&!! unset
21835 .cindex "header lines" "removing"
21836 .cindex "transport" "header lines; removing"
21837 This option specifies a list of header names,
21838 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21839 these headers are omitted from the message as it is transported, as described
21840 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21841 routers.
21842 Each list item is separately expanded.
21843 If the result of the expansion is an empty string, or if the expansion
21844 is forced to fail, no action is taken. Other expansion failures are treated as
21845 errors and cause the delivery to be deferred.
21846
21847 Unlike most options, &%headers_remove%& can be specified multiple times
21848 for a transport; all listed headers are removed.
21849
21850 &*Warning*&: Because of the separate expansion of the list items,
21851 items that contain a list separator must have it doubled.
21852 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21853
21854
21855
21856 .option headers_rewrite transports string unset
21857 .cindex "transport" "header lines; rewriting"
21858 .cindex "rewriting" "at transport time"
21859 This option allows addresses in header lines to be rewritten at transport time,
21860 that is, as the message is being copied to its destination. The contents of the
21861 option are a colon-separated list of rewriting rules. Each rule is in exactly
21862 the same form as one of the general rewriting rules that are applied when a
21863 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21864 example,
21865 .code
21866 headers_rewrite = a@b c@d f : \
21867                   x@y w@z
21868 .endd
21869 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21870 &'w@z'& in all address-bearing header lines. The rules are applied to the
21871 header lines just before they are written out at transport time, so they affect
21872 only those copies of the message that pass through the transport. However, only
21873 the message's original header lines, and any that were added by a system
21874 filter, are rewritten. If a router or transport adds header lines, they are not
21875 affected by this option. These rewriting rules are &'not'& applied to the
21876 envelope. You can change the return path using &%return_path%&, but you cannot
21877 change envelope recipients at this time.
21878
21879
21880 .option home_directory transports string&!! unset
21881 .cindex "transport" "home directory for"
21882 .vindex "&$home$&"
21883 This option specifies a home directory setting for a local transport,
21884 overriding any value that may be set by the router. The home directory is
21885 placed in &$home$& while expanding the transport's private options. It is also
21886 used as the current directory if no current directory is set by the
21887 &%current_directory%& option on the transport or the
21888 &%transport_current_directory%& option on the router. If the expansion fails
21889 for any reason, including forced failure, an error is logged, and delivery is
21890 deferred.
21891
21892
21893 .option initgroups transports boolean false
21894 .cindex "additional groups"
21895 .cindex "groups" "additional"
21896 .cindex "transport" "group; additional"
21897 If this option is true and the uid for the delivery process is provided by the
21898 transport, the &[initgroups()]& function is called when running the transport
21899 to ensure that any additional groups associated with the uid are set up.
21900
21901
21902 .option max_parallel transports integer&!! unset
21903 .cindex limit "transport parallelism"
21904 .cindex transport "parallel processes"
21905 .cindex transport "concurrency limit"
21906 .cindex "delivery" "parallelism for transport"
21907 If this option is set and expands to an integer greater than zero
21908 it limits the number of concurrent runs of the transport.
21909 The control does not apply to shadow transports.
21910
21911 .cindex "hints database" "transport concurrency control"
21912 Exim implements this control by means of a hints database in which a record is
21913 incremented whenever a transport process is being created. The record
21914 is decremented and possibly removed when the process terminates.
21915 Obviously there is scope for
21916 records to get left lying around if there is a system or program crash. To
21917 guard against this, Exim ignores any records that are more than six hours old.
21918
21919 If you use this option, you should also arrange to delete the
21920 relevant hints database whenever your system reboots. The names of the files
21921 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21922 may be one or two files, depending on the type of DBM in use. The same files
21923 are used for ETRN and smtp transport serialization.
21924
21925
21926 .option message_size_limit transports string&!! 0
21927 .cindex "limit" "message size per transport"
21928 .cindex "size" "of message, limit"
21929 .cindex "transport" "message size; limiting"
21930 This option controls the size of messages passed through the transport. It is
21931 expanded before use; the result of the expansion must be a sequence of decimal
21932 digits, optionally followed by K or M. If the expansion fails for any reason,
21933 including forced failure, or if the result is not of the required form,
21934 delivery is deferred. If the value is greater than zero and the size of a
21935 message exceeds this limit, the address is failed. If there is any chance that
21936 the resulting bounce message could be routed to the same transport, you should
21937 ensure that &%return_size_limit%& is less than the transport's
21938 &%message_size_limit%&, as otherwise the bounce message will fail to get
21939 delivered.
21940
21941
21942
21943 .option rcpt_include_affixes transports boolean false
21944 .cindex "prefix" "for local part, including in envelope"
21945 .cindex "suffix for local part" "including in envelope"
21946 .cindex "local part" "prefix"
21947 .cindex "local part" "suffix"
21948 When this option is false (the default), and an address that has had any
21949 affixes (prefixes or suffixes) removed from the local part is delivered by any
21950 form of SMTP or LMTP, the affixes are not included. For example, if a router
21951 that contains
21952 .code
21953 local_part_prefix = *-
21954 .endd
21955 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21956 is delivered with
21957 .code
21958 RCPT TO:<xyz@some.domain>
21959 .endd
21960 This is also the case when an ACL-time callout is being used to verify a
21961 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21962 whole local part is included in the RCPT command. This option applies to BSMTP
21963 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21964 &(lmtp)& and &(smtp)& transports.
21965
21966
21967 .option retry_use_local_part transports boolean "see below"
21968 .cindex "hints database" "retry keys"
21969 When a delivery suffers a temporary failure, a retry record is created
21970 in Exim's hints database. For remote deliveries, the key for the retry record
21971 is based on the name and/or IP address of the failing remote host. For local
21972 deliveries, the key is normally the entire address, including both the local
21973 part and the domain. This is suitable for most common cases of local delivery
21974 temporary failure &-- for example, exceeding a mailbox quota should delay only
21975 deliveries to that mailbox, not to the whole domain.
21976
21977 However, in some special cases you may want to treat a temporary local delivery
21978 as a failure associated with the domain, and not with a particular local part.
21979 (For example, if you are storing all mail for some domain in files.) You can do
21980 this by setting &%retry_use_local_part%& false.
21981
21982 For all the local transports, its default value is true. For remote transports,
21983 the default value is false for tidiness, but changing the value has no effect
21984 on a remote transport in the current implementation.
21985
21986
21987 .option return_path transports string&!! unset
21988 .cindex "envelope sender"
21989 .cindex "envelope from"
21990 .cindex "transport" "return path; changing"
21991 .cindex "return path" "changing in transport"
21992 If this option is set, the string is expanded at transport time and replaces
21993 the existing return path (envelope sender) value in the copy of the message
21994 that is being delivered. An empty return path is permitted. This feature is
21995 designed for remote deliveries, where the value of this option is used in the
21996 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21997 only effect is to change the address that is placed in the &'Return-path:'&
21998 header line, if one is added to the message (see the next option).
21999
22000 &*Note:*& A changed return path is not logged unless you add
22001 &%return_path_on_delivery%& to the log selector.
22002
22003 .vindex "&$return_path$&"
22004 The expansion can refer to the existing value via &$return_path$&. This is
22005 either the message's envelope sender, or an address set by the
22006 &%errors_to%& option on a router. If the expansion is forced to fail, no
22007 replacement occurs; if it fails for another reason, delivery is deferred. This
22008 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22009 section &<<SECTverp>>&.
22010
22011 &*Note*&: If a delivery error is detected locally, including the case when a
22012 remote server rejects a message at SMTP time, the bounce message is not sent to
22013 the value of this option. It is sent to the previously set errors address.
22014 This defaults to the incoming sender address, but can be changed by setting
22015 &%errors_to%& in a router.
22016
22017
22018
22019 .option return_path_add transports boolean false
22020 .cindex "&'Return-path:'& header line"
22021 If this option is true, a &'Return-path:'& header is added to the message.
22022 Although the return path is normally available in the prefix line of BSD
22023 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22024 have easy access to it.
22025
22026 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22027 the delivery SMTP server makes the final delivery"&. This implies that this
22028 header should not be present in incoming messages. Exim has a configuration
22029 option, &%return_path_remove%&, which requests removal of this header from
22030 incoming messages, so that delivered messages can safely be resent to other
22031 recipients.
22032
22033
22034 .option shadow_condition transports string&!! unset
22035 See &%shadow_transport%& below.
22036
22037
22038 .option shadow_transport transports string unset
22039 .cindex "shadow transport"
22040 .cindex "transport" "shadow"
22041 A local transport may set the &%shadow_transport%& option to the name of
22042 another local transport. Shadow remote transports are not supported.
22043
22044 Whenever a delivery to the main transport succeeds, and either
22045 &%shadow_condition%& is unset, or its expansion does not result in the empty
22046 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22047 passed to the shadow transport, with the same delivery address or addresses. If
22048 expansion fails, no action is taken except that non-forced expansion failures
22049 cause a log line to be written.
22050
22051 The result of the shadow transport is discarded and does not affect the
22052 subsequent processing of the message. Only a single level of shadowing is
22053 provided; the &%shadow_transport%& option is ignored on any transport when it
22054 is running as a shadow. Options concerned with output from pipes are also
22055 ignored. The log line for the successful delivery has an item added on the end,
22056 of the form
22057 .code
22058 ST=<shadow transport name>
22059 .endd
22060 If the shadow transport did not succeed, the error message is put in
22061 parentheses afterwards. Shadow transports can be used for a number of different
22062 purposes, including keeping more detailed log information than Exim normally
22063 provides, and implementing automatic acknowledgment policies based on message
22064 headers that some sites insist on.
22065
22066
22067 .option transport_filter transports string&!! unset
22068 .cindex "transport" "filter"
22069 .cindex "filter" "transport filter"
22070 This option sets up a filtering (in the Unix shell sense) process for messages
22071 at transport time. It should not be confused with mail filtering as set up by
22072 individual users or via a system filter.
22073 If unset, or expanding to an empty string, no filtering is done.
22074
22075 When the message is about to be written out, the command specified by
22076 &%transport_filter%& is started up in a separate, parallel process, and
22077 the entire message, including the header lines, is passed to it on its standard
22078 input (this in fact is done from a third process, to avoid deadlock). The
22079 command must be specified as an absolute path.
22080
22081 The lines of the message that are written to the transport filter are
22082 terminated by newline (&"\n"&). The message is passed to the filter before any
22083 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22084 lines beginning with a dot, and also before any processing implied by the
22085 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22086 &(pipe)& transports.
22087
22088 The standard error for the filter process is set to the same destination as its
22089 standard output; this is read and written to the message's ultimate
22090 destination. The process that writes the message to the filter, the
22091 filter itself, and the original process that reads the result and delivers it
22092 are all run in parallel, like a shell pipeline.
22093
22094 The filter can perform any transformations it likes, but of course should take
22095 care not to break RFC 2822 syntax. Exim does not check the result, except to
22096 test for a final newline when SMTP is in use. All messages transmitted over
22097 SMTP must end with a newline, so Exim supplies one if it is missing.
22098
22099 .cindex "content scanning" "per user"
22100 A transport filter can be used to provide content-scanning on a per-user basis
22101 at delivery time if the only required effect of the scan is to modify the
22102 message. For example, a content scan could insert a new header line containing
22103 a spam score. This could be interpreted by a filter in the user's MUA. It is
22104 not possible to discard a message at this stage.
22105
22106 .cindex "SMTP" "SIZE"
22107 A problem might arise if the filter increases the size of a message that is
22108 being sent down an SMTP connection. If the receiving SMTP server has indicated
22109 support for the SIZE parameter, Exim will have sent the size of the message
22110 at the start of the SMTP session. If what is actually sent is substantially
22111 more, the server might reject the message. This can be worked round by setting
22112 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22113 additions to the message, or to disable the use of SIZE altogether.
22114
22115 .vindex "&$pipe_addresses$&"
22116 The value of the &%transport_filter%& option is the command string for starting
22117 the filter, which is run directly from Exim, not under a shell. The string is
22118 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22119 Exim breaks it up into arguments and then expands each argument separately (see
22120 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22121 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22122 of arguments, one for each address that applies to this delivery. (This isn't
22123 an ideal name for this feature here, but as it was already implemented for the
22124 &(pipe)& transport, it seemed sensible not to change it.)
22125
22126 .vindex "&$host$&"
22127 .vindex "&$host_address$&"
22128 The expansion variables &$host$& and &$host_address$& are available when the
22129 transport is a remote one. They contain the name and IP address of the host to
22130 which the message is being sent. For example:
22131 .code
22132 transport_filter = /some/directory/transport-filter.pl \
22133   $host $host_address $sender_address $pipe_addresses
22134 .endd
22135
22136 Two problems arise if you want to use more complicated expansion items to
22137 generate transport filter commands, both of which due to the fact that the
22138 command is split up &'before'& expansion.
22139 .ilist
22140 If an expansion item contains white space, you must quote it, so that it is all
22141 part of the same command item. If the entire option setting is one such
22142 expansion item, you have to take care what kind of quoting you use. For
22143 example:
22144 .code
22145 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22146 .endd
22147 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22148 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22149 stripped by Exim when it read the option's value. When the value is used, if
22150 the single quotes were missing, the line would be split into two items,
22151 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22152 Exim tried to expand the first one.
22153 .next
22154 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22155 expansion cannot generate multiple arguments, or a command name followed by
22156 arguments. Consider this example:
22157 .code
22158 transport_filter = ${lookup{$host}lsearch{/a/file}\
22159                     {$value}{/bin/cat}}
22160 .endd
22161 The result of the lookup is interpreted as the name of the command, even
22162 if it contains white space. The simplest way round this is to use a shell:
22163 .code
22164 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22165                                {$value}{/bin/cat}}
22166 .endd
22167 .endlist
22168
22169 The filter process is run under the same uid and gid as the normal delivery.
22170 For remote deliveries this is the Exim uid/gid by default. The command should
22171 normally yield a zero return code. Transport filters are not supposed to fail.
22172 A non-zero code is taken to mean that the transport filter encountered some
22173 serious problem. Delivery of the message is deferred; the message remains on
22174 the queue and is tried again later. It is not possible to cause a message to be
22175 bounced from a transport filter.
22176
22177 If a transport filter is set on an autoreply transport, the original message is
22178 passed through the filter as it is being copied into the newly generated
22179 message, which happens if the &%return_message%& option is set.
22180
22181
22182 .option transport_filter_timeout transports time 5m
22183 .cindex "transport" "filter, timeout"
22184 When Exim is reading the output of a transport filter, it applies a timeout
22185 that can be set by this option. Exceeding the timeout is normally treated as a
22186 temporary delivery failure. However, if a transport filter is used with a
22187 &(pipe)& transport, a timeout in the transport filter is treated in the same
22188 way as a timeout in the pipe command itself. By default, a timeout is a hard
22189 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22190 becomes a temporary error.
22191
22192
22193 .option user transports string&!! "Exim user"
22194 .cindex "uid (user id)" "local delivery"
22195 .cindex "transport" "user, specifying"
22196 This option specifies the user under whose uid the delivery process is to be
22197 run, overriding any uid that may have been set by the router. If the user is
22198 given as a name, the uid is looked up from the password data, and the
22199 associated group is taken as the value of the gid to be used if the &%group%&
22200 option is not set.
22201
22202 For deliveries that use local transports, a user and group are normally
22203 specified explicitly or implicitly (for example, as a result of
22204 &%check_local_user%&) by the router or transport.
22205
22206 .cindex "hints database" "access by remote transport"
22207 For remote transports, you should leave this option unset unless you really are
22208 sure you know what you are doing. When a remote transport is running, it needs
22209 to be able to access Exim's hints databases, because each host may have its own
22210 retry data.
22211 .ecindex IIDgenoptra1
22212 .ecindex IIDgenoptra2
22213 .ecindex IIDgenoptra3
22214
22215
22216
22217
22218
22219
22220 . ////////////////////////////////////////////////////////////////////////////
22221 . ////////////////////////////////////////////////////////////////////////////
22222
22223 .chapter "Address batching in local transports" "CHAPbatching" &&&
22224          "Address batching"
22225 .cindex "transport" "local; address batching in"
22226 The only remote transport (&(smtp)&) is normally configured to handle more than
22227 one address at a time, so that when several addresses are routed to the same
22228 remote host, just one copy of the message is sent. Local transports, however,
22229 normally handle one address at a time. That is, a separate instance of the
22230 transport is run for each address that is routed to the transport. A separate
22231 copy of the message is delivered each time.
22232
22233 .cindex "batched local delivery"
22234 .oindex "&%batch_max%&"
22235 .oindex "&%batch_id%&"
22236 In special cases, it may be desirable to handle several addresses at once in a
22237 local transport, for example:
22238
22239 .ilist
22240 In an &(appendfile)& transport, when storing messages in files for later
22241 delivery by some other means, a single copy of the message with multiple
22242 recipients saves space.
22243 .next
22244 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22245 a single copy saves time, and is the normal way LMTP is expected to work.
22246 .next
22247 In a &(pipe)& transport, when passing the message
22248 to a scanner program or
22249 to some other delivery mechanism such as UUCP, multiple recipients may be
22250 acceptable.
22251 .endlist
22252
22253 These three local transports all have the same options for controlling multiple
22254 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22255 repeating the information for each transport, these options are described here.
22256
22257 The &%batch_max%& option specifies the maximum number of addresses that can be
22258 delivered together in a single run of the transport. Its default value is one
22259 (no batching). When more than one address is routed to a transport that has a
22260 &%batch_max%& value greater than one, the addresses are delivered in a batch
22261 (that is, in a single run of the transport with multiple recipients), subject
22262 to certain conditions:
22263
22264 .ilist
22265 .vindex "&$local_part$&"
22266 If any of the transport's options contain a reference to &$local_part$&, no
22267 batching is possible.
22268 .next
22269 .vindex "&$domain$&"
22270 If any of the transport's options contain a reference to &$domain$&, only
22271 addresses with the same domain are batched.
22272 .next
22273 .cindex "customizing" "batching condition"
22274 If &%batch_id%& is set, it is expanded for each address, and only those
22275 addresses with the same expanded value are batched. This allows you to specify
22276 customized batching conditions. Failure of the expansion for any reason,
22277 including forced failure, disables batching, but it does not stop the delivery
22278 from taking place.
22279 .next
22280 Batched addresses must also have the same errors address (where to send
22281 delivery errors), the same header additions and removals, the same user and
22282 group for the transport, and if a host list is present, the first host must
22283 be the same.
22284 .endlist
22285
22286 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22287 both when the file or pipe command is specified in the transport, and when it
22288 is specified by a &(redirect)& router, but all the batched addresses must of
22289 course be routed to the same file or pipe command. These two transports have an
22290 option called &%use_bsmtp%&, which causes them to deliver the message in
22291 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22292 &%check_string%& and &%escape_string%& options are forced to the values
22293 .code
22294 check_string = "."
22295 escape_string = ".."
22296 .endd
22297 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22298 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22299 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22300
22301 .cindex "&'Envelope-to:'& header line"
22302 If the generic &%envelope_to_add%& option is set for a batching transport, the
22303 &'Envelope-to:'& header that is added to the message contains all the addresses
22304 that are being processed together. If you are using a batching &(appendfile)&
22305 transport without &%use_bsmtp%&, the only way to preserve the recipient
22306 addresses is to set the &%envelope_to_add%& option.
22307
22308 .cindex "&(pipe)& transport" "with multiple addresses"
22309 .vindex "&$pipe_addresses$&"
22310 If you are using a &(pipe)& transport without BSMTP, and setting the
22311 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22312 the command. This is not a true variable; it is a bit of magic that causes each
22313 of the recipient addresses to be inserted into the command as a separate
22314 argument. This provides a way of accessing all the addresses that are being
22315 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22316 are specified by a &(redirect)& router.
22317
22318
22319
22320
22321 . ////////////////////////////////////////////////////////////////////////////
22322 . ////////////////////////////////////////////////////////////////////////////
22323
22324 .chapter "The appendfile transport" "CHAPappendfile"
22325 .scindex IIDapptra1 "&(appendfile)& transport"
22326 .scindex IIDapptra2 "transports" "&(appendfile)&"
22327 .cindex "directory creation"
22328 .cindex "creating directories"
22329 The &(appendfile)& transport delivers a message by appending it to an existing
22330 file, or by creating an entirely new file in a specified directory. Single
22331 files to which messages are appended can be in the traditional Unix mailbox
22332 format, or optionally in the MBX format supported by the Pine MUA and
22333 University of Washington IMAP daemon, &'inter alia'&. When each message is
22334 being delivered as a separate file, &"maildir"& format can optionally be used
22335 to give added protection against failures that happen part-way through the
22336 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22337 supported. For all file formats, Exim attempts to create as many levels of
22338 directory as necessary, provided that &%create_directory%& is set.
22339
22340 The code for the optional formats is not included in the Exim binary by
22341 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22342 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22343 included.
22344
22345 .cindex "quota" "system"
22346 Exim recognizes system quota errors, and generates an appropriate message. Exim
22347 also supports its own quota control within the transport, for use when the
22348 system facility is unavailable or cannot be used for some reason.
22349
22350 If there is an error while appending to a file (for example, quota exceeded or
22351 partition filled), Exim attempts to reset the file's length and last
22352 modification time back to what they were before. If there is an error while
22353 creating an entirely new file, the new file is removed.
22354
22355 Before appending to a file, a number of security checks are made, and the
22356 file is locked. A detailed description is given below, after the list of
22357 private options.
22358
22359 The &(appendfile)& transport is most commonly used for local deliveries to
22360 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22361 putting messages into files for remote delivery by some means other than Exim.
22362 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22363 option).
22364
22365
22366
22367 .section "The file and directory options" "SECTfildiropt"
22368 The &%file%& option specifies a single file, to which the message is appended;
22369 the &%directory%& option specifies a directory, in which a new file containing
22370 the message is created. Only one of these two options can be set, and for
22371 normal deliveries to mailboxes, one of them &'must'& be set.
22372
22373 .vindex "&$address_file$&"
22374 .vindex "&$local_part$&"
22375 However, &(appendfile)& is also used for delivering messages to files or
22376 directories whose names (or parts of names) are obtained from alias,
22377 forwarding, or filtering operations (for example, a &%save%& command in a
22378 user's Exim filter). When such a transport is running, &$local_part$& contains
22379 the local part that was aliased or forwarded, and &$address_file$& contains the
22380 name (or partial name) of the file or directory generated by the redirection
22381 operation. There are two cases:
22382
22383 .ilist
22384 If neither &%file%& nor &%directory%& is set, the redirection operation
22385 must specify an absolute path (one that begins with &`/`&). This is the most
22386 common case when users with local accounts use filtering to sort mail into
22387 different folders. See for example, the &(address_file)& transport in the
22388 default configuration. If the path ends with a slash, it is assumed to be the
22389 name of a directory. A delivery to a directory can also be forced by setting
22390 &%maildir_format%& or &%mailstore_format%&.
22391 .next
22392 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22393 used to determine the file or directory name for the delivery. Normally, the
22394 contents of &$address_file$& are used in some way in the string expansion.
22395 .endlist
22396 .new
22397 .cindex "tainted data" "in filenames"
22398 .cindex appendfile "tainted data"
22399 Tainted data may not be used for a file or directory name.
22400 This means that, for instance, &$local_part$& cannot be used directly
22401 as a component of a path.  It can however be used as the key for a lookup
22402 which returns a path (or component).
22403 .wen
22404
22405
22406 .cindex "Sieve filter" "configuring &(appendfile)&"
22407 .cindex "Sieve filter" "relative mailbox path handling"
22408 As an example of the second case, consider an environment where users do not
22409 have home directories. They may be permitted to use Exim filter commands of the
22410 form:
22411 .code
22412 save folder23
22413 .endd
22414 or Sieve filter commands of the form:
22415 .code
22416 require "fileinto";
22417 fileinto "folder23";
22418 .endd
22419 In this situation, the expansion of &%file%& or &%directory%& in the transport
22420 must transform the relative path into an appropriate absolute filename. In the
22421 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22422 is used as a result of a &"keep"& action in the filter. This example shows one
22423 way of handling this requirement:
22424 .code
22425 file = ${if eq{$address_file}{inbox} \
22426             {/var/mail/$local_part} \
22427             {${if eq{${substr_0_1:$address_file}}{/} \
22428                   {$address_file} \
22429                   {$home/mail/$address_file} \
22430             }} \
22431        }
22432 .endd
22433 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22434 location, absolute paths are used without change, and other folders are in the
22435 &_mail_& directory within the home directory.
22436
22437 &*Note 1*&: While processing an Exim filter, a relative path such as
22438 &_folder23_& is turned into an absolute path if a home directory is known to
22439 the router. In particular, this is the case if &%check_local_user%& is set. If
22440 you want to prevent this happening at routing time, you can set
22441 &%router_home_directory%& empty. This forces the router to pass the relative
22442 path to the transport.
22443
22444 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22445 the &%file%& or &%directory%& option is still used if it is set.
22446
22447
22448
22449
22450 .section "Private options for appendfile" "SECID134"
22451 .cindex "options" "&(appendfile)& transport"
22452
22453
22454
22455 .option allow_fifo appendfile boolean false
22456 .cindex "fifo (named pipe)"
22457 .cindex "named pipe (fifo)"
22458 .cindex "pipe" "named (fifo)"
22459 Setting this option permits delivery to named pipes (FIFOs) as well as to
22460 regular files. If no process is reading the named pipe at delivery time, the
22461 delivery is deferred.
22462
22463
22464 .option allow_symlink appendfile boolean false
22465 .cindex "symbolic link" "to mailbox"
22466 .cindex "mailbox" "symbolic link"
22467 By default, &(appendfile)& will not deliver if the path name for the file is
22468 that of a symbolic link. Setting this option relaxes that constraint, but there
22469 are security issues involved in the use of symbolic links. Be sure you know
22470 what you are doing if you set this. Details of exactly what this option affects
22471 are included in the discussion which follows this list of options.
22472
22473
22474 .option batch_id appendfile string&!! unset
22475 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22476 However, batching is automatically disabled for &(appendfile)& deliveries that
22477 happen as a result of forwarding or aliasing or other redirection directly to a
22478 file.
22479
22480
22481 .option batch_max appendfile integer 1
22482 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22483
22484
22485 .option check_group appendfile boolean false
22486 When this option is set, the group owner of the file defined by the &%file%&
22487 option is checked to see that it is the same as the group under which the
22488 delivery process is running. The default setting is false because the default
22489 file mode is 0600, which means that the group is irrelevant.
22490
22491
22492 .option check_owner appendfile boolean true
22493 When this option is set, the owner of the file defined by the &%file%& option
22494 is checked to ensure that it is the same as the user under which the delivery
22495 process is running.
22496
22497
22498 .option check_string appendfile string "see below"
22499 .cindex "&""From""& line"
22500 As &(appendfile)& writes the message, the start of each line is tested for
22501 matching &%check_string%&, and if it does, the initial matching characters are
22502 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22503 a literal string, not a regular expression, and the case of any letters it
22504 contains is significant.
22505
22506 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22507 are forced to &"."& and &".."& respectively, and any settings in the
22508 configuration are ignored. Otherwise, they default to &"From&~"& and
22509 &">From&~"& when the &%file%& option is set, and unset when any of the
22510 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22511
22512 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22513 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22514 &"From&~"& indicates the start of a new message. All four options need changing
22515 if another format is used. For example, to deliver to mailboxes in MMDF format:
22516 .cindex "MMDF format mailbox"
22517 .cindex "mailbox" "MMDF format"
22518 .code
22519 check_string = "\1\1\1\1\n"
22520 escape_string = "\1\1\1\1 \n"
22521 message_prefix = "\1\1\1\1\n"
22522 message_suffix = "\1\1\1\1\n"
22523 .endd
22524 .option create_directory appendfile boolean true
22525 .cindex "directory creation"
22526 When this option is true, Exim attempts to create any missing superior
22527 directories for the file that it is about to write. A created directory's mode
22528 is given by the &%directory_mode%& option.
22529
22530 The group ownership of a newly created directory is highly dependent on the
22531 operating system (and possibly the file system) that is being used. For
22532 example, in Solaris, if the parent directory has the setgid bit set, its group
22533 is propagated to the child; if not, the currently set group is used. However,
22534 in FreeBSD, the parent's group is always used.
22535
22536
22537
22538 .option create_file appendfile string anywhere
22539 This option constrains the location of files and directories that are created
22540 by this transport. It applies to files defined by the &%file%& option and
22541 directories defined by the &%directory%& option. In the case of maildir
22542 delivery, it applies to the top level directory, not the maildir directories
22543 beneath.
22544
22545 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22546 &"belowhome"&. In the second and third cases, a home directory must have been
22547 set for the transport. This option is not useful when an explicit filename is
22548 given for normal mailbox deliveries. It is intended for the case when filenames
22549 are generated from users' &_.forward_& files. These are usually handled
22550 by an &(appendfile)& transport called &%address_file%&. See also
22551 &%file_must_exist%&.
22552
22553
22554 .option directory appendfile string&!! unset
22555 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22556 or &%directory%& must be set, unless the delivery is the direct result of a
22557 redirection (see section &<<SECTfildiropt>>&).
22558
22559 When &%directory%& is set, the string is expanded, and the message is delivered
22560 into a new file or files in or below the given directory, instead of being
22561 appended to a single mailbox file. A number of different formats are provided
22562 (see &%maildir_format%& and &%mailstore_format%&), and see section
22563 &<<SECTopdir>>& for further details of this form of delivery.
22564
22565
22566 .option directory_file appendfile string&!! "see below"
22567 .cindex "base62"
22568 .vindex "&$inode$&"
22569 When &%directory%& is set, but neither &%maildir_format%& nor
22570 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22571 whose name is obtained by expanding this string. The default value is:
22572 .code
22573 q${base62:$tod_epoch}-$inode
22574 .endd
22575 This generates a unique name from the current time, in base 62 form, and the
22576 inode of the file. The variable &$inode$& is available only when expanding this
22577 option.
22578
22579
22580 .option directory_mode appendfile "octal integer" 0700
22581 If &(appendfile)& creates any directories as a result of the
22582 &%create_directory%& option, their mode is specified by this option.
22583
22584
22585 .option escape_string appendfile string "see description"
22586 See &%check_string%& above.
22587
22588
22589 .option file appendfile string&!! unset
22590 This option is mutually exclusive with the &%directory%& option, but one of
22591 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22592 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22593 specifies a single file, to which the message is appended. One or more of
22594 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22595 &%file%&.
22596
22597 .cindex "NFS" "lock file"
22598 .cindex "locking files"
22599 .cindex "lock files"
22600 If you are using more than one host to deliver over NFS into the same
22601 mailboxes, you should always use lock files.
22602
22603 The string value is expanded for each delivery, and must yield an absolute
22604 path. The most common settings of this option are variations on one of these
22605 examples:
22606 .code
22607 file = /var/spool/mail/$local_part
22608 file = /home/$local_part/inbox
22609 file = $home/inbox
22610 .endd
22611 .cindex "&""sticky""& bit"
22612 In the first example, all deliveries are done into the same directory. If Exim
22613 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22614 create a file in the directory, so the &"sticky"& bit must be turned on for
22615 deliveries to be possible, or alternatively the &%group%& option can be used to
22616 run the delivery under a group id which has write access to the directory.
22617
22618
22619
22620 .option file_format appendfile string unset
22621 .cindex "file" "mailbox; checking existing format"
22622 This option requests the transport to check the format of an existing file
22623 before adding to it. The check consists of matching a specific string at the
22624 start of the file. The value of the option consists of an even number of
22625 colon-separated strings. The first of each pair is the test string, and the
22626 second is the name of a transport. If the transport associated with a matched
22627 string is not the current transport, control is passed over to the other
22628 transport. For example, suppose the standard &(local_delivery)& transport has
22629 this added to it:
22630 .code
22631 file_format = "From       : local_delivery :\
22632                \1\1\1\1\n : local_mmdf_delivery"
22633 .endd
22634 Mailboxes that begin with &"From"& are still handled by this transport, but if
22635 a mailbox begins with four binary ones followed by a newline, control is passed
22636 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22637 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22638 is assumed to match the current transport. If the start of a mailbox doesn't
22639 match any string, or if the transport named for a given string is not defined,
22640 delivery is deferred.
22641
22642
22643 .option file_must_exist appendfile boolean false
22644 If this option is true, the file specified by the &%file%& option must exist.
22645 A temporary error occurs if it does not, causing delivery to be deferred.
22646 If this option is false, the file is created if it does not exist.
22647
22648
22649 .option lock_fcntl_timeout appendfile time 0s
22650 .cindex "timeout" "mailbox locking"
22651 .cindex "mailbox" "locking, blocking and non-blocking"
22652 .cindex "locking files"
22653 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22654 when locking an open mailbox file. If the call fails, the delivery process
22655 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22656 Non-blocking calls are used so that the file is not kept open during the wait
22657 for the lock; the reason for this is to make it as safe as possible for
22658 deliveries over NFS in the case when processes might be accessing an NFS
22659 mailbox without using a lock file. This should not be done, but
22660 misunderstandings and hence misconfigurations are not unknown.
22661
22662 On a busy system, however, the performance of a non-blocking lock approach is
22663 not as good as using a blocking lock with a timeout. In this case, the waiting
22664 is done inside the system call, and Exim's delivery process acquires the lock
22665 and can proceed as soon as the previous lock holder releases it.
22666
22667 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22668 timeout, are used. There may still be some retrying: the maximum number of
22669 retries is
22670 .code
22671 (lock_retries * lock_interval) / lock_fcntl_timeout
22672 .endd
22673 rounded up to the next whole number. In other words, the total time during
22674 which &(appendfile)& is trying to get a lock is roughly the same, unless
22675 &%lock_fcntl_timeout%& is set very large.
22676
22677 You should consider setting this option if you are getting a lot of delayed
22678 local deliveries because of errors of the form
22679 .code
22680 failed to lock mailbox /some/file (fcntl)
22681 .endd
22682
22683 .option lock_flock_timeout appendfile time 0s
22684 This timeout applies to file locking when using &[flock()]& (see
22685 &%use_flock%&); the timeout operates in a similar manner to
22686 &%lock_fcntl_timeout%&.
22687
22688
22689 .option lock_interval appendfile time 3s
22690 This specifies the time to wait between attempts to lock the file. See below
22691 for details of locking.
22692
22693
22694 .option lock_retries appendfile integer 10
22695 This specifies the maximum number of attempts to lock the file. A value of zero
22696 is treated as 1. See below for details of locking.
22697
22698
22699 .option lockfile_mode appendfile "octal integer" 0600
22700 This specifies the mode of the created lock file, when a lock file is being
22701 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22702
22703
22704 .option lockfile_timeout appendfile time 30m
22705 .cindex "timeout" "mailbox locking"
22706 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22707 exists and is older than this value, it is assumed to have been left behind by
22708 accident, and Exim attempts to remove it.
22709
22710
22711 .option mailbox_filecount appendfile string&!! unset
22712 .cindex "mailbox" "specifying size of"
22713 .cindex "size" "of mailbox"
22714 If this option is set, it is expanded, and the result is taken as the current
22715 number of files in the mailbox. It must be a decimal number, optionally
22716 followed by K or M. This provides a way of obtaining this information from an
22717 external source that maintains the data.
22718
22719
22720 .option mailbox_size appendfile string&!! unset
22721 .cindex "mailbox" "specifying size of"
22722 .cindex "size" "of mailbox"
22723 If this option is set, it is expanded, and the result is taken as the current
22724 size the mailbox. It must be a decimal number, optionally followed by K or M.
22725 This provides a way of obtaining this information from an external source that
22726 maintains the data. This is likely to be helpful for maildir deliveries where
22727 it is computationally expensive to compute the size of a mailbox.
22728
22729
22730
22731 .option maildir_format appendfile boolean false
22732 .cindex "maildir format" "specifying"
22733 If this option is set with the &%directory%& option, the delivery is into a new
22734 file, in the &"maildir"& format that is used by other mail software. When the
22735 transport is activated directly from a &(redirect)& router (for example, the
22736 &(address_file)& transport in the default configuration), setting
22737 &%maildir_format%& causes the path received from the router to be treated as a
22738 directory, whether or not it ends with &`/`&. This option is available only if
22739 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22740 &<<SECTmaildirdelivery>>& below for further details.
22741
22742
22743 .option maildir_quota_directory_regex appendfile string "See below"
22744 .cindex "maildir format" "quota; directories included in"
22745 .cindex "quota" "maildir; directories included in"
22746 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22747 a regular expression for specifying directories, relative to the quota
22748 directory (see &%quota_directory%&), that should be included in the quota
22749 calculation. The default value is:
22750 .code
22751 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22752 .endd
22753 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22754 (directories whose names begin with a dot). If you want to exclude the
22755 &_Trash_&
22756 folder from the count (as some sites do), you need to change this setting to
22757 .code
22758 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22759 .endd
22760 This uses a negative lookahead in the regular expression to exclude the
22761 directory whose name is &_.Trash_&. When a directory is excluded from quota
22762 calculations, quota processing is bypassed for any messages that are delivered
22763 directly into that directory.
22764
22765
22766 .option maildir_retries appendfile integer 10
22767 This option specifies the number of times to retry when writing a file in
22768 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22769
22770
22771 .option maildir_tag appendfile string&!! unset
22772 This option applies only to deliveries in maildir format, and is described in
22773 section &<<SECTmaildirdelivery>>& below.
22774
22775
22776 .option maildir_use_size_file appendfile&!! boolean false
22777 .cindex "maildir format" "&_maildirsize_& file"
22778 The result of string expansion for this option must be a valid boolean value.
22779 If it is true, it enables support for &_maildirsize_& files. Exim
22780 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22781 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22782 value is zero. See &%maildir_quota_directory_regex%& above and section
22783 &<<SECTmaildirdelivery>>& below for further details.
22784
22785 .option maildirfolder_create_regex appendfile string unset
22786 .cindex "maildir format" "&_maildirfolder_& file"
22787 .cindex "&_maildirfolder_&, creating"
22788 The value of this option is a regular expression. If it is unset, it has no
22789 effect. Otherwise, before a maildir delivery takes place, the pattern is
22790 matched against the name of the maildir directory, that is, the directory
22791 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22792 delivery. If there is a match, Exim checks for the existence of a file called
22793 &_maildirfolder_& in the directory, and creates it if it does not exist.
22794 See section &<<SECTmaildirdelivery>>& for more details.
22795
22796
22797 .option mailstore_format appendfile boolean false
22798 .cindex "mailstore format" "specifying"
22799 If this option is set with the &%directory%& option, the delivery is into two
22800 new files in  &"mailstore"& format. The option is available only if
22801 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22802 below for further details.
22803
22804
22805 .option mailstore_prefix appendfile string&!! unset
22806 This option applies only to deliveries in mailstore format, and is described in
22807 section &<<SECTopdir>>& below.
22808
22809
22810 .option mailstore_suffix appendfile string&!! unset
22811 This option applies only to deliveries in mailstore format, and is described in
22812 section &<<SECTopdir>>& below.
22813
22814
22815 .option mbx_format appendfile boolean false
22816 .cindex "locking files"
22817 .cindex "file" "locking"
22818 .cindex "file" "MBX format"
22819 .cindex "MBX format, specifying"
22820 This option is available only if Exim has been compiled with SUPPORT_MBX
22821 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22822 the message is appended to the mailbox file in MBX format instead of
22823 traditional Unix format. This format is supported by Pine4 and its associated
22824 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22825
22826 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22827 automatically changed by the use of &%mbx_format%&. They should normally be set
22828 empty when using MBX format, so this option almost always appears in this
22829 combination:
22830 .code
22831 mbx_format = true
22832 message_prefix =
22833 message_suffix =
22834 .endd
22835 If none of the locking options are mentioned in the configuration,
22836 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22837 is possible to specify the other kinds of locking with &%mbx_format%&, but
22838 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22839 interworks with &'c-client'&, providing for shared access to the mailbox. It
22840 should not be used if any program that does not use this form of locking is
22841 going to access the mailbox, nor should it be used if the mailbox file is NFS
22842 mounted, because it works only when the mailbox is accessed from a single host.
22843
22844 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22845 the standard version of &'c-client'&, because as long as it has a mailbox open
22846 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22847 append messages to it.
22848
22849
22850 .option message_prefix appendfile string&!! "see below"
22851 .cindex "&""From""& line"
22852 The string specified here is expanded and output at the start of every message.
22853 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22854 in which case it is:
22855 .code
22856 message_prefix = "From ${if def:return_path{$return_path}\
22857   {MAILER-DAEMON}} $tod_bsdinbox\n"
22858 .endd
22859 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22860 &`\n`& to &`\r\n`& in &%message_prefix%&.
22861
22862 .option message_suffix appendfile string&!! "see below"
22863 The string specified here is expanded and output at the end of every message.
22864 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22865 in which case it is a single newline character. The suffix can be suppressed by
22866 setting
22867 .code
22868 message_suffix =
22869 .endd
22870 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22871 &`\n`& to &`\r\n`& in &%message_suffix%&.
22872
22873 .option mode appendfile "octal integer" 0600
22874 If the output file is created, it is given this mode. If it already exists and
22875 has wider permissions, they are reduced to this mode. If it has narrower
22876 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22877 if the delivery is the result of a &%save%& command in a filter file specifying
22878 a particular mode, the mode of the output file is always forced to take that
22879 value, and this option is ignored.
22880
22881
22882 .option mode_fail_narrower appendfile boolean true
22883 This option applies in the case when an existing mailbox file has a narrower
22884 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22885 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22886 continues with the delivery attempt, using the existing mode of the file.
22887
22888
22889 .option notify_comsat appendfile boolean false
22890 If this option is true, the &'comsat'& daemon is notified after every
22891 successful delivery to a user mailbox. This is the daemon that notifies logged
22892 on users about incoming mail.
22893
22894
22895 .option quota appendfile string&!! unset
22896 .cindex "quota" "imposed by Exim"
22897 This option imposes a limit on the size of the file to which Exim is appending,
22898 or to the total space used in the directory tree when the &%directory%& option
22899 is set. In the latter case, computation of the space used is expensive, because
22900 all the files in the directory (and any sub-directories) have to be
22901 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22902 &%maildir_use_size_file%& for ways to avoid this in environments where users
22903 have no shell access to their mailboxes).
22904
22905 As there is no interlock against two simultaneous deliveries into a
22906 multi-file mailbox, it is possible for the quota to be overrun in this case.
22907 For single-file mailboxes, of course, an interlock is a necessity.
22908
22909 A file's size is taken as its &'used'& value. Because of blocking effects, this
22910 may be a lot less than the actual amount of disk space allocated to the file.
22911 If the sizes of a number of files are being added up, the rounding effect can
22912 become quite noticeable, especially on systems that have large block sizes.
22913 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22914 the obvious value which users understand most easily.
22915
22916 The value of the option is expanded, and must then be a numerical value
22917 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22918 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22919 and further option modifiers. If Exim is running on a system with
22920 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22921 be handled.
22922
22923 The option modifier &%no_check%& can be used to force delivery even if the over
22924 quota condition is met. The quota gets updated as usual.
22925
22926 &*Note*&: A value of zero is interpreted as &"no quota"&.
22927
22928 The expansion happens while Exim is running as root, before it changes uid for
22929 the delivery. This means that files that are inaccessible to the end user can
22930 be used to hold quota values that are looked up in the expansion. When delivery
22931 fails because this quota is exceeded, the handling of the error is as for
22932 system quota failures.
22933
22934 By default, Exim's quota checking mimics system quotas, and restricts the
22935 mailbox to the specified maximum size, though the value is not accurate to the
22936 last byte, owing to separator lines and additional headers that may get added
22937 during message delivery. When a mailbox is nearly full, large messages may get
22938 refused even though small ones are accepted, because the size of the current
22939 message is added to the quota when the check is made. This behaviour can be
22940 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22941 for exceeding the quota does not include the current message. Thus, deliveries
22942 continue until the quota has been exceeded; thereafter, no further messages are
22943 delivered. See also &%quota_warn_threshold%&.
22944
22945
22946 .option quota_directory appendfile string&!! unset
22947 This option defines the directory to check for quota purposes when delivering
22948 into individual files. The default is the delivery directory, or, if a file
22949 called &_maildirfolder_& exists in a maildir directory, the parent of the
22950 delivery directory.
22951
22952
22953 .option quota_filecount appendfile string&!! 0
22954 This option applies when the &%directory%& option is set. It limits the total
22955 number of files in the directory (compare the inode limit in system quotas). It
22956 can only be used if &%quota%& is also set. The value is expanded; an expansion
22957 failure causes delivery to be deferred. A value of zero is interpreted as
22958 &"no quota"&.
22959
22960 The option modifier &%no_check%& can be used to force delivery even if the over
22961 quota condition is met. The quota gets updated as usual.
22962
22963 .option quota_is_inclusive appendfile boolean true
22964 See &%quota%& above.
22965
22966
22967 .option quota_size_regex appendfile string unset
22968 This option applies when one of the delivery modes that writes a separate file
22969 for each message is being used. When Exim wants to find the size of one of
22970 these files in order to test the quota, it first checks &%quota_size_regex%&.
22971 If this is set to a regular expression that matches the filename, and it
22972 captures one string, that string is interpreted as a representation of the
22973 file's size. The value of &%quota_size_regex%& is not expanded.
22974
22975 This feature is useful only when users have no shell access to their mailboxes
22976 &-- otherwise they could defeat the quota simply by renaming the files. This
22977 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22978 the file length to the filename. For example:
22979 .code
22980 maildir_tag = ,S=$message_size
22981 quota_size_regex = ,S=(\d+)
22982 .endd
22983 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22984 number of lines in the message.
22985
22986 The regular expression should not assume that the length is at the end of the
22987 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22988 sometimes add other information onto the ends of message filenames.
22989
22990 Section &<<SECID136>>& contains further information.
22991
22992 This option should not be used when other message-handling software
22993 may duplicate messages by making hardlinks to the files.  When that is done Exim
22994 will count the message size once for each filename, in contrast with the actual
22995 disk usage.  When the option is not set, calculating total usage requires
22996 a system-call per file to get the size; the number of links is then available also
22997 as is used to adjust the effective size.
22998
22999
23000 .option quota_warn_message appendfile string&!! "see below"
23001 See below for the use of this option. If it is not set when
23002 &%quota_warn_threshold%& is set, it defaults to
23003 .code
23004 quota_warn_message = "\
23005   To: $local_part@$domain\n\
23006   Subject: Your mailbox\n\n\
23007   This message is automatically created \
23008   by mail delivery software.\n\n\
23009   The size of your mailbox has exceeded \
23010   a warning threshold that is\n\
23011   set by the system administrator.\n"
23012 .endd
23013
23014
23015 .option quota_warn_threshold appendfile string&!! 0
23016 .cindex "quota" "warning threshold"
23017 .cindex "mailbox" "size warning"
23018 .cindex "size" "of mailbox"
23019 This option is expanded in the same way as &%quota%& (see above). If the
23020 resulting value is greater than zero, and delivery of the message causes the
23021 size of the file or total space in the directory tree to cross the given
23022 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23023 may be specified as a percentage of it by following the value with a percent
23024 sign. For example:
23025 .code
23026 quota = 10M
23027 quota_warn_threshold = 75%
23028 .endd
23029 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23030 percent sign is ignored.
23031
23032 The warning message itself is specified by the &%quota_warn_message%& option,
23033 and it must start with a &'To:'& header line containing the recipient(s) of the
23034 warning message. These do not necessarily have to include the recipient(s) of
23035 the original message. A &'Subject:'& line should also normally be supplied. You
23036 can include any other header lines that you want. If you do not include a
23037 &'From:'& line, the default is:
23038 .code
23039 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23040 .endd
23041 .oindex &%errors_reply_to%&
23042 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23043 option.
23044
23045 The &%quota%& option does not have to be set in order to use this option; they
23046 are independent of one another except when the threshold is specified as a
23047 percentage.
23048
23049
23050 .option use_bsmtp appendfile boolean false
23051 .cindex "envelope from"
23052 .cindex "envelope sender"
23053 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23054 format, with the envelope sender and recipient(s) included as SMTP commands. If
23055 you want to include a leading HELO command with such messages, you can do
23056 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23057 for details of batch SMTP.
23058
23059
23060 .option use_crlf appendfile boolean false
23061 .cindex "carriage return"
23062 .cindex "linefeed"
23063 This option causes lines to be terminated with the two-character CRLF sequence
23064 (carriage return, linefeed) instead of just a linefeed character. In the case
23065 of batched SMTP, the byte sequence written to the file is then an exact image
23066 of what would be sent down a real SMTP connection.
23067
23068 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23069 (which are used to supply the traditional &"From&~"& and blank line separators
23070 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23071 carriage return characters if these are needed. In cases where these options
23072 have non-empty defaults, the values end with a single linefeed, so they must be
23073 changed to end with &`\r\n`& if &%use_crlf%& is set.
23074
23075
23076 .option use_fcntl_lock appendfile boolean "see below"
23077 This option controls the use of the &[fcntl()]& function to lock a file for
23078 exclusive use when a message is being appended. It is set by default unless
23079 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23080 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23081 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23082
23083
23084 .option use_flock_lock appendfile boolean false
23085 This option is provided to support the use of &[flock()]& for file locking, for
23086 the few situations where it is needed. Most modern operating systems support
23087 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23088 each other. Exim uses &[fcntl()]& locking by default.
23089
23090 This option is required only if you are using an operating system where
23091 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23092 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23093 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23094
23095 .cindex "Solaris" "&[flock()]& support"
23096 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23097 have it (and some, I think, provide a not quite right version built on top of
23098 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23099 the ability to use it, and any attempt to do so will cause a configuration
23100 error.
23101
23102 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23103 is just being mapped onto &[fcntl()]& by the OS).
23104
23105
23106 .option use_lockfile appendfile boolean "see below"
23107 If this option is turned off, Exim does not attempt to create a lock file when
23108 appending to a mailbox file. In this situation, the only locking is by
23109 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23110 sure that every MUA that is ever going to look at your users' mailboxes uses
23111 &[fcntl()]& rather than a lock file, and even then only when you are not
23112 delivering over NFS from more than one host.
23113
23114 .cindex "NFS" "lock file"
23115 In order to append to an NFS file safely from more than one host, it is
23116 necessary to take out a lock &'before'& opening the file, and the lock file
23117 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23118 file corruption.
23119
23120 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23121 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23122 except when &%mbx_format%& is set.
23123
23124
23125 .option use_mbx_lock appendfile boolean "see below"
23126 This option is available only if Exim has been compiled with SUPPORT_MBX
23127 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23128 locking rules be used. It is set by default if &%mbx_format%& is set and none
23129 of the locking options are mentioned in the configuration. The locking rules
23130 are the same as are used by the &'c-client'& library that underlies Pine and
23131 the IMAP4 and POP daemons that come with it (see the discussion below). The
23132 rules allow for shared access to the mailbox. However, this kind of locking
23133 does not work when the mailbox is NFS mounted.
23134
23135 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23136 &%use_flock_lock%& to control what kind of locking is used in implementing the
23137 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23138 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23139
23140
23141
23142
23143 .section "Operational details for appending" "SECTopappend"
23144 .cindex "appending to a file"
23145 .cindex "file" "appending"
23146 Before appending to a file, the following preparations are made:
23147
23148 .ilist
23149 If the name of the file is &_/dev/null_&, no action is taken, and a success
23150 return is given.
23151
23152 .next
23153 .cindex "directory creation"
23154 If any directories on the file's path are missing, Exim creates them if the
23155 &%create_directory%& option is set. A created directory's mode is given by the
23156 &%directory_mode%& option.
23157
23158 .next
23159 If &%file_format%& is set, the format of an existing file is checked. If this
23160 indicates that a different transport should be used, control is passed to that
23161 transport.
23162
23163 .next
23164 .cindex "file" "locking"
23165 .cindex "locking files"
23166 .cindex "NFS" "lock file"
23167 If &%use_lockfile%& is set, a lock file is built in a way that will work
23168 reliably over NFS, as follows:
23169
23170 .olist
23171 Create a &"hitching post"& file whose name is that of the lock file with the
23172 current time, primary host name, and process id added, by opening for writing
23173 as a new file. If this fails with an access error, delivery is deferred.
23174 .next
23175 Close the hitching post file, and hard link it to the lock filename.
23176 .next
23177 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23178 Unlink the hitching post name.
23179 .next
23180 Otherwise, use &[stat()]& to get information about the hitching post file, and
23181 then unlink hitching post name. If the number of links is exactly two, creation
23182 of the lock file succeeded but something (for example, an NFS server crash and
23183 restart) caused this fact not to be communicated to the &[link()]& call.
23184 .next
23185 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23186 up to &%lock_retries%& times. However, since any program that writes to a
23187 mailbox should complete its task very quickly, it is reasonable to time out old
23188 lock files that are normally the result of user agent and system crashes. If an
23189 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23190 it before trying again.
23191 .endlist olist
23192
23193 .next
23194 A call is made to &[lstat()]& to discover whether the main file exists, and if
23195 so, what its characteristics are. If &[lstat()]& fails for any reason other
23196 than non-existence, delivery is deferred.
23197
23198 .next
23199 .cindex "symbolic link" "to mailbox"
23200 .cindex "mailbox" "symbolic link"
23201 If the file does exist and is a symbolic link, delivery is deferred, unless the
23202 &%allow_symlink%& option is set, in which case the ownership of the link is
23203 checked, and then &[stat()]& is called to find out about the real file, which
23204 is then subjected to the checks below. The check on the top-level link
23205 ownership prevents one user creating a link for another's mailbox in a sticky
23206 directory, though allowing symbolic links in this case is definitely not a good
23207 idea. If there is a chain of symbolic links, the intermediate ones are not
23208 checked.
23209
23210 .next
23211 If the file already exists but is not a regular file, or if the file's owner
23212 and group (if the group is being checked &-- see &%check_group%& above) are
23213 different from the user and group under which the delivery is running,
23214 delivery is deferred.
23215
23216 .next
23217 If the file's permissions are more generous than specified, they are reduced.
23218 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23219 is set false, in which case the delivery is tried using the existing
23220 permissions.
23221
23222 .next
23223 The file's inode number is saved, and the file is then opened for appending.
23224 If this fails because the file has vanished, &(appendfile)& behaves as if it
23225 hadn't existed (see below). For any other failures, delivery is deferred.
23226
23227 .next
23228 If the file is opened successfully, check that the inode number hasn't
23229 changed, that it is still a regular file, and that the owner and permissions
23230 have not changed. If anything is wrong, defer delivery and freeze the message.
23231
23232 .next
23233 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23234 option is set. Otherwise, check that the file is being created in a permitted
23235 directory if the &%create_file%& option is set (deferring on failure), and then
23236 open for writing as a new file, with the O_EXCL and O_CREAT options,
23237 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23238 set). In this case, which can happen if the link points to a non-existent file,
23239 the file is opened for writing using O_CREAT but not O_EXCL, because
23240 that prevents link following.
23241
23242 .next
23243 .cindex "loop" "while file testing"
23244 If opening fails because the file exists, obey the tests given above for
23245 existing files. However, to avoid looping in a situation where the file is
23246 being continuously created and destroyed, the exists/not-exists loop is broken
23247 after 10 repetitions, and the message is then frozen.
23248
23249 .next
23250 If opening fails with any other error, defer delivery.
23251
23252 .next
23253 .cindex "file" "locking"
23254 .cindex "locking files"
23255 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23256 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23257 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23258 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23259 file, and an exclusive lock on the file whose name is
23260 .code
23261 /tmp/.<device-number>.<inode-number>
23262 .endd
23263 using the device and inode numbers of the open mailbox file, in accordance with
23264 the MBX locking rules. This file is created with a mode that is specified by
23265 the &%lockfile_mode%& option.
23266
23267 If Exim fails to lock the file, there are two possible courses of action,
23268 depending on the value of the locking timeout. This is obtained from
23269 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23270
23271 If the timeout value is zero, the file is closed, Exim waits for
23272 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23273 to lock it again. This happens up to &%lock_retries%& times, after which the
23274 delivery is deferred.
23275
23276 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23277 &[flock()]& are used (with the given timeout), so there has already been some
23278 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23279 immediately. It retries up to
23280 .code
23281 (lock_retries * lock_interval) / <timeout>
23282 .endd
23283 times (rounded up).
23284 .endlist
23285
23286 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23287 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23288
23289
23290 .section "Operational details for delivery to a new file" "SECTopdir"
23291 .cindex "delivery" "to single file"
23292 .cindex "&""From""& line"
23293 When the &%directory%& option is set instead of &%file%&, each message is
23294 delivered into a newly-created file or set of files. When &(appendfile)& is
23295 activated directly from a &(redirect)& router, neither &%file%& nor
23296 &%directory%& is normally set, because the path for delivery is supplied by the
23297 router. (See for example, the &(address_file)& transport in the default
23298 configuration.) In this case, delivery is to a new file if either the path name
23299 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23300
23301 No locking is required while writing the message to a new file, so the various
23302 locking options of the transport are ignored. The &"From"& line that by default
23303 separates messages in a single file is not normally needed, nor is the escaping
23304 of message lines that start with &"From"&, and there is no need to ensure a
23305 newline at the end of each message. Consequently, the default values for
23306 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23307 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23308
23309 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23310 the files in the delivery directory by default. However, you can specify a
23311 different directory by setting &%quota_directory%&. Also, for maildir
23312 deliveries (see below) the &_maildirfolder_& convention is honoured.
23313
23314
23315 .cindex "maildir format"
23316 .cindex "mailstore format"
23317 There are three different ways in which delivery to individual files can be
23318 done, controlled by the settings of the &%maildir_format%& and
23319 &%mailstore_format%& options. Note that code to support maildir or mailstore
23320 formats is not included in the binary unless SUPPORT_MAILDIR or
23321 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23322
23323 .cindex "directory creation"
23324 In all three cases an attempt is made to create the directory and any necessary
23325 sub-directories if they do not exist, provided that the &%create_directory%&
23326 option is set (the default). The location of a created directory can be
23327 constrained by setting &%create_file%&. A created directory's mode is given by
23328 the &%directory_mode%& option. If creation fails, or if the
23329 &%create_directory%& option is not set when creation is required, delivery is
23330 deferred.
23331
23332
23333
23334 .section "Maildir delivery" "SECTmaildirdelivery"
23335 .cindex "maildir format" "description of"
23336 If the &%maildir_format%& option is true, Exim delivers each message by writing
23337 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23338 directory that is defined by the &%directory%& option (the &"delivery
23339 directory"&). If the delivery is successful, the file is renamed into the
23340 &_new_& subdirectory.
23341
23342 In the filename, <&'stime'&> is the current time of day in seconds, and
23343 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23344 Exim checks that the time-of-day clock has moved on by at least one microsecond
23345 before terminating the delivery process. This guarantees uniqueness for the
23346 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23347 opening it. If any response other than ENOENT (does not exist) is given,
23348 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23349
23350 Before Exim carries out a maildir delivery, it ensures that subdirectories
23351 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23352 do not exist, Exim tries to create them and any superior directories in their
23353 path, subject to the &%create_directory%& and &%create_file%& options. If the
23354 &%maildirfolder_create_regex%& option is set, and the regular expression it
23355 contains matches the delivery directory, Exim also ensures that a file called
23356 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23357 &_maildirfolder_& file cannot be created, delivery is deferred.
23358
23359 These features make it possible to use Exim to create all the necessary files
23360 and directories in a maildir mailbox, including subdirectories for maildir++
23361 folders. Consider this example:
23362 .code
23363 maildir_format = true
23364 directory = /var/mail/$local_part\
23365            ${if eq{$local_part_suffix}{}{}\
23366            {/.${substr_1:$local_part_suffix}}}
23367 maildirfolder_create_regex = /\.[^/]+$
23368 .endd
23369 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23370 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23371 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23372 not match this name, so Exim will not look for or create the file
23373 &_/var/mail/pimbo/maildirfolder_&, though it will create
23374 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23375
23376 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23377 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23378 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23379 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23380 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23381
23382 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23383 not inadvertently match the toplevel maildir directory, because a
23384 &_maildirfolder_& file at top level would completely break quota calculations.
23385
23386 .cindex "quota" "in maildir delivery"
23387 .cindex "maildir++"
23388 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23389 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23390 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23391 Exim assumes the directory is a maildir++ folder directory, which is one level
23392 down from the user's top level mailbox directory. This causes it to start at
23393 the parent directory instead of the current directory when calculating the
23394 amount of space used.
23395
23396 One problem with delivering into a multi-file mailbox is that it is
23397 computationally expensive to compute the size of the mailbox for quota
23398 checking. Various approaches have been taken to reduce the amount of work
23399 needed. The next two sections describe two of them. A third alternative is to
23400 use some external process for maintaining the size data, and use the expansion
23401 of the &%mailbox_size%& option as a way of importing it into Exim.
23402
23403
23404
23405
23406 .section "Using tags to record message sizes" "SECID135"
23407 If &%maildir_tag%& is set, the string is expanded for each delivery.
23408 When the maildir file is renamed into the &_new_& sub-directory, the
23409 tag is added to its name. However, if adding the tag takes the length of the
23410 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23411 the tag is dropped and the maildir file is created with no tag.
23412
23413
23414 .vindex "&$message_size$&"
23415 Tags can be used to encode the size of files in their names; see
23416 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23417 happens after the message has been written. The value of the &$message_size$&
23418 variable is set to the number of bytes actually written. If the expansion is
23419 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23420 be deferred. The expanded tag may contain any printing characters except &"/"&.
23421 Non-printing characters in the string are ignored; if the resulting string is
23422 empty, it is ignored. If it starts with an alphanumeric character, a leading
23423 colon is inserted; this default has not proven to be the path that popular
23424 maildir implementations have chosen (but changing it in Exim would break
23425 backwards compatibility).
23426
23427 For one common implementation, you might set:
23428 .code
23429 maildir_tag = ,S=${message_size}
23430 .endd
23431 but you should check the documentation of the other software to be sure.
23432
23433 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23434 as this allows Exim to extract the size from your tag, instead of having to
23435 &[stat()]& each message file.
23436
23437
23438 .section "Using a maildirsize file" "SECID136"
23439 .cindex "quota" "in maildir delivery"
23440 .cindex "maildir format" "&_maildirsize_& file"
23441 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23442 storing quota and message size information in a file called &_maildirsize_&
23443 within the toplevel maildir directory. If this file does not exist, Exim
23444 creates it, setting the quota from the &%quota%& option of the transport. If
23445 the maildir directory itself does not exist, it is created before any attempt
23446 to write a &_maildirsize_& file.
23447
23448 The &_maildirsize_& file is used to hold information about the sizes of
23449 messages in the maildir, thus speeding up quota calculations. The quota value
23450 in the file is just a cache; if the quota is changed in the transport, the new
23451 value overrides the cached value when the next message is delivered. The cache
23452 is maintained for the benefit of other programs that access the maildir and
23453 need to know the quota.
23454
23455 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23456 file is maintained (with a zero quota setting), but no quota is imposed.
23457
23458 A regular expression is available for controlling which directories in the
23459 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23460 See the description of the &%maildir_quota_directory_regex%& option above for
23461 details.
23462
23463
23464 .section "Mailstore delivery" "SECID137"
23465 .cindex "mailstore format" "description of"
23466 If the &%mailstore_format%& option is true, each message is written as two
23467 files in the given directory. A unique base name is constructed from the
23468 message id and the current delivery process, and the files that are written use
23469 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23470 contains the message's envelope, and the &_.msg_& file contains the message
23471 itself. The base name is placed in the variable &$mailstore_basename$&.
23472
23473 During delivery, the envelope is first written to a file with the suffix
23474 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23475 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23476 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23477 file before accessing either of them. An alternative approach is to wait for
23478 the absence of a &_.tmp_& file.
23479
23480 The envelope file starts with any text defined by the &%mailstore_prefix%&
23481 option, expanded and terminated by a newline if there isn't one. Then follows
23482 the sender address on one line, then all the recipient addresses, one per line.
23483 There can be more than one recipient only if the &%batch_max%& option is set
23484 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23485 appended to the file, followed by a newline if it does not end with one.
23486
23487 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23488 failure, it is ignored. Other expansion errors are treated as serious
23489 configuration errors, and delivery is deferred. The variable
23490 &$mailstore_basename$& is available for use during these expansions.
23491
23492
23493 .section "Non-special new file delivery" "SECID138"
23494 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23495 file is created directly in the named directory. For example, when delivering
23496 messages into files in batched SMTP format for later delivery to some host (see
23497 section &<<SECTbatchSMTP>>&), a setting such as
23498 .code
23499 directory = /var/bsmtp/$host
23500 .endd
23501 might be used. A message is written to a file with a temporary name, which is
23502 then renamed when the delivery is complete. The final name is obtained by
23503 expanding the contents of the &%directory_file%& option.
23504 .ecindex IIDapptra1
23505 .ecindex IIDapptra2
23506
23507
23508
23509
23510
23511
23512 . ////////////////////////////////////////////////////////////////////////////
23513 . ////////////////////////////////////////////////////////////////////////////
23514
23515 .chapter "The autoreply transport" "CHID8"
23516 .scindex IIDauttra1 "transports" "&(autoreply)&"
23517 .scindex IIDauttra2 "&(autoreply)& transport"
23518 The &(autoreply)& transport is not a true transport in that it does not cause
23519 the message to be transmitted. Instead, it generates a new mail message as an
23520 automatic reply to the incoming message. &'References:'& and
23521 &'Auto-Submitted:'& header lines are included. These are constructed according
23522 to the rules in RFCs 2822 and 3834, respectively.
23523
23524 If the router that passes the message to this transport does not have the
23525 &%unseen%& option set, the original message (for the current recipient) is not
23526 delivered anywhere. However, when the &%unseen%& option is set on the router
23527 that passes the message to this transport, routing of the address continues, so
23528 another router can set up a normal message delivery.
23529
23530
23531 The &(autoreply)& transport is usually run as the result of mail filtering, a
23532 &"vacation"& message being the standard example. However, it can also be run
23533 directly from a router like any other transport. To reduce the possibility of
23534 message cascades, messages created by the &(autoreply)& transport always have
23535 empty envelope sender addresses, like bounce messages.
23536
23537 The parameters of the message to be sent can be specified in the configuration
23538 by options described below. However, these are used only when the address
23539 passed to the transport does not contain its own reply information. When the
23540 transport is run as a consequence of a
23541 &%mail%&
23542 or &%vacation%& command in a filter file, the parameters of the message are
23543 supplied by the filter, and passed with the address. The transport's options
23544 that define the message are then ignored (so they are not usually set in this
23545 case). The message is specified entirely by the filter or by the transport; it
23546 is never built from a mixture of options. However, the &%file_optional%&,
23547 &%mode%&, and &%return_message%& options apply in all cases.
23548
23549 &(Autoreply)& is implemented as a local transport. When used as a result of a
23550 command in a user's filter file, &(autoreply)& normally runs under the uid and
23551 gid of the user, and with appropriate current and home directories (see chapter
23552 &<<CHAPenvironment>>&).
23553
23554 There is a subtle difference between routing a message to a &(pipe)& transport
23555 that generates some text to be returned to the sender, and routing it to an
23556 &(autoreply)& transport. This difference is noticeable only if more than one
23557 address from the same message is so handled. In the case of a pipe, the
23558 separate outputs from the different addresses are gathered up and returned to
23559 the sender in a single message, whereas if &(autoreply)& is used, a separate
23560 message is generated for each address that is passed to it.
23561
23562 Non-printing characters are not permitted in the header lines generated for the
23563 message that &(autoreply)& creates, with the exception of newlines that are
23564 immediately followed by white space. If any non-printing characters are found,
23565 the transport defers.
23566 Whether characters with the top bit set count as printing characters or not is
23567 controlled by the &%print_topbitchars%& global option.
23568
23569 If any of the generic options for manipulating headers (for example,
23570 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23571 of the original message that is included in the generated message when
23572 &%return_message%& is set. They do not apply to the generated message itself.
23573
23574 .vindex "&$sender_address$&"
23575 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23576 the message, indicating that there were no recipients, it does not treat this
23577 as an error. This means that autoreplies sent to &$sender_address$& when this
23578 is empty (because the incoming message is a bounce message) do not cause
23579 problems. They are just discarded.
23580
23581
23582
23583 .section "Private options for autoreply" "SECID139"
23584 .cindex "options" "&(autoreply)& transport"
23585
23586 .option bcc autoreply string&!! unset
23587 This specifies the addresses that are to receive &"blind carbon copies"& of the
23588 message when the message is specified by the transport.
23589
23590
23591 .option cc autoreply string&!! unset
23592 This specifies recipients of the message and the contents of the &'Cc:'& header
23593 when the message is specified by the transport.
23594
23595
23596 .option file autoreply string&!! unset
23597 The contents of the file are sent as the body of the message when the message
23598 is specified by the transport. If both &%file%& and &%text%& are set, the text
23599 string comes first.
23600
23601
23602 .option file_expand autoreply boolean false
23603 If this is set, the contents of the file named by the &%file%& option are
23604 subjected to string expansion as they are added to the message.
23605
23606
23607 .option file_optional autoreply boolean false
23608 If this option is true, no error is generated if the file named by the &%file%&
23609 option or passed with the address does not exist or cannot be read.
23610
23611
23612 .option from autoreply string&!! unset
23613 This specifies the contents of the &'From:'& header when the message is
23614 specified by the transport.
23615
23616
23617 .option headers autoreply string&!! unset
23618 This specifies additional RFC 2822 headers that are to be added to the message
23619 when the message is specified by the transport. Several can be given by using
23620 &"\n"& to separate them. There is no check on the format.
23621
23622
23623 .option log autoreply string&!! unset
23624 This option names a file in which a record of every message sent is logged when
23625 the message is specified by the transport.
23626
23627
23628 .option mode autoreply "octal integer" 0600
23629 If either the log file or the &"once"& file has to be created, this mode is
23630 used.
23631
23632
23633 .option never_mail autoreply "address list&!!" unset
23634 If any run of the transport creates a message with a recipient that matches any
23635 item in the list, that recipient is quietly discarded. If all recipients are
23636 discarded, no message is created. This applies both when the recipients are
23637 generated by a filter and when they are specified in the transport.
23638
23639
23640
23641 .option once autoreply string&!! unset
23642 This option names a file or DBM database in which a record of each &'To:'&
23643 recipient is kept when the message is specified by the transport. &*Note*&:
23644 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23645
23646 If &%once%& is unset, or is set to an empty string, the message is always sent.
23647 By default, if &%once%& is set to a non-empty filename, the message
23648 is not sent if a potential recipient is already listed in the database.
23649 However, if the &%once_repeat%& option specifies a time greater than zero, the
23650 message is sent if that much time has elapsed since a message was last sent to
23651 this recipient. A setting of zero time for &%once_repeat%& (the default)
23652 prevents a message from being sent a second time &-- in this case, zero means
23653 infinity.
23654
23655 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23656 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23657 greater than zero, it changes the way Exim implements the &%once%& option.
23658 Instead of using a DBM file to record every recipient it sends to, it uses a
23659 regular file, whose size will never get larger than the given value.
23660
23661 In the file, Exim keeps a linear list of recipient addresses and the times at
23662 which they were sent messages. If the file is full when a new address needs to
23663 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23664 means that a given recipient may receive multiple messages, but at
23665 unpredictable intervals that depend on the rate of turnover of addresses in the
23666 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23667
23668
23669 .option once_file_size autoreply integer 0
23670 See &%once%& above.
23671
23672
23673 .option once_repeat autoreply time&!! 0s
23674 See &%once%& above.
23675 After expansion, the value of this option must be a valid time value.
23676
23677
23678 .option reply_to autoreply string&!! unset
23679 This specifies the contents of the &'Reply-To:'& header when the message is
23680 specified by the transport.
23681
23682
23683 .option return_message autoreply boolean false
23684 If this is set, a copy of the original message is returned with the new
23685 message, subject to the maximum size set in the &%return_size_limit%& global
23686 configuration option.
23687
23688
23689 .option subject autoreply string&!! unset
23690 This specifies the contents of the &'Subject:'& header when the message is
23691 specified by the transport. It is tempting to quote the original subject in
23692 automatic responses. For example:
23693 .code
23694 subject = Re: $h_subject:
23695 .endd
23696 There is a danger in doing this, however. It may allow a third party to
23697 subscribe your users to an opt-in mailing list, provided that the list accepts
23698 bounce messages as subscription confirmations. Well-managed lists require a
23699 non-bounce message to confirm a subscription, so the danger is relatively
23700 small.
23701
23702
23703
23704 .option text autoreply string&!! unset
23705 This specifies a single string to be used as the body of the message when the
23706 message is specified by the transport. If both &%text%& and &%file%& are set,
23707 the text comes first.
23708
23709
23710 .option to autoreply string&!! unset
23711 This specifies recipients of the message and the contents of the &'To:'& header
23712 when the message is specified by the transport.
23713 .ecindex IIDauttra1
23714 .ecindex IIDauttra2
23715
23716
23717
23718
23719 . ////////////////////////////////////////////////////////////////////////////
23720 . ////////////////////////////////////////////////////////////////////////////
23721
23722 .chapter "The lmtp transport" "CHAPLMTP"
23723 .cindex "transports" "&(lmtp)&"
23724 .cindex "&(lmtp)& transport"
23725 .cindex "LMTP" "over a pipe"
23726 .cindex "LMTP" "over a socket"
23727 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23728 specified command
23729 or by interacting with a Unix domain socket.
23730 This transport is something of a cross between the &(pipe)& and &(smtp)&
23731 transports. Exim also has support for using LMTP over TCP/IP; this is
23732 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23733 to be of minority interest, the default build-time configure in &_src/EDITME_&
23734 has it commented out. You need to ensure that
23735 .code
23736 TRANSPORT_LMTP=yes
23737 .endd
23738 .cindex "options" "&(lmtp)& transport"
23739 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23740 included in the Exim binary. The private options of the &(lmtp)& transport are
23741 as follows:
23742
23743 .option batch_id lmtp string&!! unset
23744 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23745
23746
23747 .option batch_max lmtp integer 1
23748 This limits the number of addresses that can be handled in a single delivery.
23749 Most LMTP servers can handle several addresses at once, so it is normally a
23750 good idea to increase this value. See the description of local delivery
23751 batching in chapter &<<CHAPbatching>>&.
23752
23753
23754 .option command lmtp string&!! unset
23755 This option must be set if &%socket%& is not set. The string is a command which
23756 is run in a separate process. It is split up into a command name and list of
23757 arguments, each of which is separately expanded (so expansion cannot change the
23758 number of arguments). The command is run directly, not via a shell. The message
23759 is passed to the new process using the standard input and output to operate the
23760 LMTP protocol.
23761
23762 .option ignore_quota lmtp boolean false
23763 .cindex "LMTP" "ignoring quota errors"
23764 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23765 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23766 in its response to the LHLO command.
23767
23768 .option socket lmtp string&!! unset
23769 This option must be set if &%command%& is not set. The result of expansion must
23770 be the name of a Unix domain socket. The transport connects to the socket and
23771 delivers the message to it using the LMTP protocol.
23772
23773
23774 .option timeout lmtp time 5m
23775 The transport is aborted if the created process or Unix domain socket does not
23776 respond to LMTP commands or message input within this timeout. Delivery
23777 is deferred, and will be tried again later. Here is an example of a typical
23778 LMTP transport:
23779 .code
23780 lmtp:
23781   driver = lmtp
23782   command = /some/local/lmtp/delivery/program
23783   batch_max = 20
23784   user = exim
23785 .endd
23786 This delivers up to 20 addresses at a time, in a mixture of domains if
23787 necessary, running as the user &'exim'&.
23788
23789
23790
23791 . ////////////////////////////////////////////////////////////////////////////
23792 . ////////////////////////////////////////////////////////////////////////////
23793
23794 .chapter "The pipe transport" "CHAPpipetransport"
23795 .scindex IIDpiptra1 "transports" "&(pipe)&"
23796 .scindex IIDpiptra2 "&(pipe)& transport"
23797 The &(pipe)& transport is used to deliver messages via a pipe to a command
23798 running in another process. One example is the use of &(pipe)& as a
23799 pseudo-remote transport for passing messages to some other delivery mechanism
23800 (such as UUCP). Another is the use by individual users to automatically process
23801 their incoming messages. The &(pipe)& transport can be used in one of the
23802 following ways:
23803
23804 .ilist
23805 .vindex "&$local_part$&"
23806 A router routes one address to a transport in the normal way, and the
23807 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23808 contains the local part of the address (as usual), and the command that is run
23809 is specified by the &%command%& option on the transport.
23810 .next
23811 .vindex "&$pipe_addresses$&"
23812 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23813 transport can handle more than one address in a single run. In this case, when
23814 more than one address is routed to the transport, &$local_part$& is not set
23815 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23816 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23817 that are routed to the transport.
23818 .next
23819 .vindex "&$address_pipe$&"
23820 A router redirects an address directly to a pipe command (for example, from an
23821 alias or forward file). In this case, &$address_pipe$& contains the text of the
23822 pipe command, and the &%command%& option on the transport is ignored unless
23823 &%force_command%& is set. If only one address is being transported
23824 (&%batch_max%& is not greater than one, or only one address was redirected to
23825 this pipe command), &$local_part$& contains the local part that was redirected.
23826 .endlist
23827
23828
23829 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23830 deliver messages over pipes using the LMTP interactive protocol. This is
23831 implemented by the &(lmtp)& transport.
23832
23833 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23834 &_.forward_& file, the command runs under the uid and gid of that user. In
23835 other cases, the uid and gid have to be specified explicitly, either on the
23836 transport or on the router that handles the address. Current and &"home"&
23837 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23838 details of the local delivery environment and chapter &<<CHAPbatching>>&
23839 for a discussion of local delivery batching.
23840
23841 .new
23842 .cindex "tainted data" "in pipe command"
23843 .cindex pipe "tainted data"
23844 Tainted data may not be used for the command name.
23845 .wen
23846
23847
23848 .section "Concurrent delivery" "SECID140"
23849 If two messages arrive at almost the same time, and both are routed to a pipe
23850 delivery, the two pipe transports may be run concurrently. You must ensure that
23851 any pipe commands you set up are robust against this happening. If the commands
23852 write to a file, the &%exim_lock%& utility might be of use.
23853 Alternatively the &%max_parallel%& option could be used with a value
23854 of "1" to enforce serialization.
23855
23856
23857
23858
23859 .section "Returned status and data" "SECID141"
23860 .cindex "&(pipe)& transport" "returned data"
23861 If the command exits with a non-zero return code, the delivery is deemed to
23862 have failed, unless either the &%ignore_status%& option is set (in which case
23863 the return code is treated as zero), or the return code is one of those listed
23864 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23865 later"&. In this case, delivery is deferred. Details of a permanent failure are
23866 logged, but are not included in the bounce message, which merely contains
23867 &"local delivery failed"&.
23868
23869 If the command exits on a signal and the &%freeze_signal%& option is set then
23870 the message will be frozen in the queue. If that option is not set, a bounce
23871 will be sent as normal.
23872
23873 If the return code is greater than 128 and the command being run is a shell
23874 script, it normally means that the script was terminated by a signal whose
23875 value is the return code minus 128. The &%freeze_signal%& option does not
23876 apply in this case.
23877
23878 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23879 return code is set to 127. This is the value that a shell returns if it is
23880 asked to run a non-existent command. The wording for the log line suggests that
23881 a non-existent command may be the problem.
23882
23883 The &%return_output%& option can affect the result of a pipe delivery. If it is
23884 set and the command produces any output on its standard output or standard
23885 error streams, the command is considered to have failed, even if it gave a zero
23886 return code or if &%ignore_status%& is set. The output from the command is
23887 included as part of the bounce message. The &%return_fail_output%& option is
23888 similar, except that output is returned only when the command exits with a
23889 failure return code, that is, a value other than zero or a code that matches
23890 &%temp_errors%&.
23891
23892
23893
23894 .section "How the command is run" "SECThowcommandrun"
23895 .cindex "&(pipe)& transport" "path for command"
23896 The command line is (by default) broken down into a command name and arguments
23897 by the &(pipe)& transport itself. The &%allow_commands%& and
23898 &%restrict_to_path%& options can be used to restrict the commands that may be
23899 run.
23900
23901 .cindex "quoting" "in pipe command"
23902 Unquoted arguments are delimited by white space. If an argument appears in
23903 double quotes, backslash is interpreted as an escape character in the usual
23904 way. If an argument appears in single quotes, no escaping is done.
23905
23906 String expansion is applied to the command line except when it comes from a
23907 traditional &_.forward_& file (commands from a filter file are expanded). The
23908 expansion is applied to each argument in turn rather than to the whole line.
23909 For this reason, any string expansion item that contains white space must be
23910 quoted so as to be contained within a single argument. A setting such as
23911 .code
23912 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23913 .endd
23914 will not work, because the expansion item gets split between several
23915 arguments. You have to write
23916 .code
23917 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23918 .endd
23919 to ensure that it is all in one argument. The expansion is done in this way,
23920 argument by argument, so that the number of arguments cannot be changed as a
23921 result of expansion, and quotes or backslashes in inserted variables do not
23922 interact with external quoting. However, this leads to problems if you want to
23923 generate multiple arguments (or the command name plus arguments) from a single
23924 expansion. In this situation, the simplest solution is to use a shell. For
23925 example:
23926 .code
23927 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23928 .endd
23929
23930 .cindex "transport" "filter"
23931 .cindex "filter" "transport filter"
23932 .vindex "&$pipe_addresses$&"
23933 Special handling takes place when an argument consists of precisely the text
23934 &`$pipe_addresses`& (no quotes).
23935 This is not a general expansion variable; the only
23936 place this string is recognized is when it appears as an argument for a pipe or
23937 transport filter command. It causes each address that is being handled to be
23938 inserted in the argument list at that point &'as a separate argument'&. This
23939 avoids any problems with spaces or shell metacharacters, and is of use when a
23940 &(pipe)& transport is handling groups of addresses in a batch.
23941
23942 If &%force_command%& is enabled on the transport, special handling takes place
23943 for an argument that consists of precisely the text &`$address_pipe`&.  It
23944 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23945 argument is inserted in the argument list at that point
23946 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23947 the only item in the argument; in fact, if it were then &%force_command%&
23948 should behave as a no-op.  Rather, it should be used to adjust the command
23949 run while preserving the argument vector separation.
23950
23951 After splitting up into arguments and expansion, the resulting command is run
23952 in a subprocess directly from the transport, &'not'& under a shell. The
23953 message that is being delivered is supplied on the standard input, and the
23954 standard output and standard error are both connected to a single pipe that is
23955 read by Exim. The &%max_output%& option controls how much output the command
23956 may produce, and the &%return_output%& and &%return_fail_output%& options
23957 control what is done with it.
23958
23959 Not running the command under a shell (by default) lessens the security risks
23960 in cases when a command from a user's filter file is built out of data that was
23961 taken from an incoming message. If a shell is required, it can of course be
23962 explicitly specified as the command to be run. However, there are circumstances
23963 where existing commands (for example, in &_.forward_& files) expect to be run
23964 under a shell and cannot easily be modified. To allow for these cases, there is
23965 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23966 works. Instead of breaking up the command line as just described, it expands it
23967 as a single string and passes the result to &_/bin/sh_&. The
23968 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23969 with &%use_shell%&, and the whole mechanism is inherently less secure.
23970
23971
23972
23973 .section "Environment variables" "SECTpipeenv"
23974 .cindex "&(pipe)& transport" "environment for command"
23975 .cindex "environment" "&(pipe)& transport"
23976 The environment variables listed below are set up when the command is invoked.
23977 This list is a compromise for maximum compatibility with other MTAs. Note that
23978 the &%environment%& option can be used to add additional variables to this
23979 environment. The environment for the &(pipe)& transport is not subject
23980 to the &%add_environment%& and &%keep_environment%& main config options.
23981 .display
23982 &`DOMAIN            `&   the domain of the address
23983 &`HOME              `&   the home directory, if set
23984 &`HOST              `&   the host name when called from a router (see below)
23985 &`LOCAL_PART        `&   see below
23986 &`LOCAL_PART_PREFIX `&   see below
23987 &`LOCAL_PART_SUFFIX `&   see below
23988 &`LOGNAME           `&   see below
23989 &`MESSAGE_ID        `&   Exim's local ID for the message
23990 &`PATH              `&   as specified by the &%path%& option below
23991 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23992 &`RECIPIENT         `&   the complete recipient address
23993 &`SENDER            `&   the sender of the message (empty if a bounce)
23994 &`SHELL             `&   &`/bin/sh`&
23995 &`TZ                `&   the value of the &%timezone%& option, if set
23996 &`USER              `&   see below
23997 .endd
23998 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23999 router, LOCAL_PART is set to the local part of the address. When it is
24000 called as a result of a forward or alias expansion, LOCAL_PART is set to
24001 the local part of the address that was expanded. In both cases, any affixes are
24002 removed from the local part, and made available in LOCAL_PART_PREFIX and
24003 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24004 same value as LOCAL_PART for compatibility with other MTAs.
24005
24006 .cindex "HOST"
24007 HOST is set only when a &(pipe)& transport is called from a router that
24008 associates hosts with an address, typically when using &(pipe)& as a
24009 pseudo-remote transport. HOST is set to the first host name specified by
24010 the router.
24011
24012 .cindex "HOME"
24013 If the transport's generic &%home_directory%& option is set, its value is used
24014 for the HOME environment variable. Otherwise, a home directory may be set
24015 by the router's &%transport_home_directory%& option, which defaults to the
24016 user's home directory if &%check_local_user%& is set.
24017
24018
24019 .section "Private options for pipe" "SECID142"
24020 .cindex "options" "&(pipe)& transport"
24021
24022
24023
24024 .option allow_commands pipe "string list&!!" unset
24025 .cindex "&(pipe)& transport" "permitted commands"
24026 The string is expanded, and is then interpreted as a colon-separated list of
24027 permitted commands. If &%restrict_to_path%& is not set, the only commands
24028 permitted are those in the &%allow_commands%& list. They need not be absolute
24029 paths; the &%path%& option is still used for relative paths. If
24030 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24031 in the &%allow_commands%& list, or a name without any slashes that is found on
24032 the path. In other words, if neither &%allow_commands%& nor
24033 &%restrict_to_path%& is set, there is no restriction on the command, but
24034 otherwise only commands that are permitted by one or the other are allowed. For
24035 example, if
24036 .code
24037 allow_commands = /usr/bin/vacation
24038 .endd
24039 and &%restrict_to_path%& is not set, the only permitted command is
24040 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24041 &%use_shell%& is set.
24042
24043
24044 .option batch_id pipe string&!! unset
24045 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24046
24047
24048 .option batch_max pipe integer 1
24049 This limits the number of addresses that can be handled in a single delivery.
24050 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24051
24052
24053 .option check_string pipe string unset
24054 As &(pipe)& writes the message, the start of each line is tested for matching
24055 &%check_string%&, and if it does, the initial matching characters are replaced
24056 by the contents of &%escape_string%&, provided both are set. The value of
24057 &%check_string%& is a literal string, not a regular expression, and the case of
24058 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24059 of &%check_string%& and &%escape_string%& are forced to values that implement
24060 the SMTP escaping protocol. Any settings made in the configuration file are
24061 ignored.
24062
24063
24064 .option command pipe string&!! unset
24065 This option need not be set when &(pipe)& is being used to deliver to pipes
24066 obtained directly from address redirections. In other cases, the option must be
24067 set, to provide a command to be run. It need not yield an absolute path (see
24068 the &%path%& option below). The command is split up into separate arguments by
24069 Exim, and each argument is separately expanded, as described in section
24070 &<<SECThowcommandrun>>& above.
24071
24072
24073 .option environment pipe string&!! unset
24074 .cindex "&(pipe)& transport" "environment for command"
24075 .cindex "environment" "&(pipe)& transport"
24076 This option is used to add additional variables to the environment in which the
24077 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24078 a string which is expanded, and then interpreted as a colon-separated list of
24079 environment settings of the form <&'name'&>=<&'value'&>.
24080
24081
24082 .option escape_string pipe string unset
24083 See &%check_string%& above.
24084
24085
24086 .option freeze_exec_fail pipe boolean false
24087 .cindex "exec failure"
24088 .cindex "failure of exec"
24089 .cindex "&(pipe)& transport" "failure of exec"
24090 Failure to exec the command in a pipe transport is by default treated like
24091 any other failure while running the command. However, if &%freeze_exec_fail%&
24092 is set, failure to exec is treated specially, and causes the message to be
24093 frozen, whatever the setting of &%ignore_status%&.
24094
24095
24096 .option freeze_signal pipe boolean false
24097 .cindex "signal exit"
24098 .cindex "&(pipe)& transport", "signal exit"
24099 Normally if the process run by a command in a pipe transport exits on a signal,
24100 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24101 frozen in Exim's queue instead.
24102
24103
24104 .option force_command pipe boolean false
24105 .cindex "force command"
24106 .cindex "&(pipe)& transport", "force command"
24107 Normally when a router redirects an address directly to a pipe command
24108 the &%command%& option on the transport is ignored.  If &%force_command%&
24109 is set, the &%command%& option will used. This is especially
24110 useful for forcing a wrapper or additional argument to be added to the
24111 command. For example:
24112 .code
24113 command = /usr/bin/remote_exec myhost -- $address_pipe
24114 force_command
24115 .endd
24116
24117 Note that &$address_pipe$& is handled specially in &%command%& when
24118 &%force_command%& is set, expanding out to the original argument vector as
24119 separate items, similarly to a Unix shell &`"$@"`& construct.
24120
24121
24122 .option ignore_status pipe boolean false
24123 If this option is true, the status returned by the subprocess that is set up to
24124 run the command is ignored, and Exim behaves as if zero had been returned.
24125 Otherwise, a non-zero status or termination by signal causes an error return
24126 from the transport unless the status value is one of those listed in
24127 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24128
24129 &*Note*&: This option does not apply to timeouts, which do not return a status.
24130 See the &%timeout_defer%& option for how timeouts are handled.
24131
24132
24133 .option log_defer_output pipe boolean false
24134 .cindex "&(pipe)& transport" "logging output"
24135 If this option is set, and the status returned by the command is
24136 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24137 and any output was produced on stdout or stderr, the first line of it is
24138 written to the main log.
24139
24140
24141 .option log_fail_output pipe boolean false
24142 If this option is set, and the command returns any output on stdout or
24143 stderr, and also ends with a return code that is neither zero nor one of
24144 the return codes listed in &%temp_errors%& (that is, the delivery
24145 failed), the first line of output is written to the main log. This
24146 option and &%log_output%& are mutually exclusive.  Only one of them may
24147 be set.
24148
24149
24150 .option log_output pipe boolean false
24151 If this option is set and the command returns any output on stdout or
24152 stderr, the first line of output is written to the main log, whatever
24153 the return code. This option and &%log_fail_output%& are mutually
24154 exclusive. Only one of them may be set.
24155
24156
24157 .option max_output pipe integer 20K
24158 This specifies the maximum amount of output that the command may produce on its
24159 standard output and standard error file combined. If the limit is exceeded, the
24160 process running the command is killed. This is intended as a safety measure to
24161 catch runaway processes. The limit is applied independently of the settings of
24162 the options that control what is done with such output (for example,
24163 &%return_output%&). Because of buffering effects, the amount of output may
24164 exceed the limit by a small amount before Exim notices.
24165
24166
24167 .option message_prefix pipe string&!! "see below"
24168 The string specified here is expanded and output at the start of every message.
24169 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24170 .code
24171 message_prefix = \
24172   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24173   ${tod_bsdinbox}\n
24174 .endd
24175 .cindex "Cyrus"
24176 .cindex "&%tmail%&"
24177 .cindex "&""From""& line"
24178 This is required by the commonly used &_/usr/bin/vacation_& program.
24179 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24180 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24181 setting
24182 .code
24183 message_prefix =
24184 .endd
24185 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24186 &`\n`& to &`\r\n`& in &%message_prefix%&.
24187
24188
24189 .option message_suffix pipe string&!! "see below"
24190 The string specified here is expanded and output at the end of every message.
24191 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24192 The suffix can be suppressed by setting
24193 .code
24194 message_suffix =
24195 .endd
24196 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24197 &`\n`& to &`\r\n`& in &%message_suffix%&.
24198
24199
24200 .option path pipe string&!! "/bin:/usr/bin"
24201 This option is expanded and
24202 specifies the string that is set up in the PATH environment
24203 variable of the subprocess.
24204 If the &%command%& option does not yield an absolute path name, the command is
24205 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24206 apply to a command specified as a transport filter.
24207
24208
24209 .option permit_coredump pipe boolean false
24210 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24211 a core-dump of a pipe command, enable this command.  This enables core-dumps
24212 during delivery and affects both the Exim binary and the pipe command run.
24213 It is recommended that this option remain off unless and until you have a need
24214 for it and that this only be enabled when needed, as the risk of excessive
24215 resource consumption can be quite high.  Note also that Exim is typically
24216 installed as a setuid binary and most operating systems will inhibit coredumps
24217 of these by default, so further OS-specific action may be required.
24218
24219
24220 .option pipe_as_creator pipe boolean false
24221 .cindex "uid (user id)" "local delivery"
24222 If the generic &%user%& option is not set and this option is true, the delivery
24223 process is run under the uid that was in force when Exim was originally called
24224 to accept the message. If the group id is not otherwise set (via the generic
24225 &%group%& option), the gid that was in force when Exim was originally called to
24226 accept the message is used.
24227
24228
24229 .option restrict_to_path pipe boolean false
24230 When this option is set, any command name not listed in &%allow_commands%& must
24231 contain no slashes. The command is searched for only in the directories listed
24232 in the &%path%& option. This option is intended for use in the case when a pipe
24233 command has been generated from a user's &_.forward_& file. This is usually
24234 handled by a &(pipe)& transport called &%address_pipe%&.
24235
24236
24237 .option return_fail_output pipe boolean false
24238 If this option is true, and the command produced any output and ended with a
24239 return code other than zero or one of the codes listed in &%temp_errors%& (that
24240 is, the delivery failed), the output is returned in the bounce message.
24241 However, if the message has a null sender (that is, it is itself a bounce
24242 message), output from the command is discarded. This option and
24243 &%return_output%& are mutually exclusive. Only one of them may be set.
24244
24245
24246
24247 .option return_output pipe boolean false
24248 If this option is true, and the command produced any output, the delivery is
24249 deemed to have failed whatever the return code from the command, and the output
24250 is returned in the bounce message. Otherwise, the output is just discarded.
24251 However, if the message has a null sender (that is, it is a bounce message),
24252 output from the command is always discarded, whatever the setting of this
24253 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24254 of them may be set.
24255
24256
24257
24258 .option temp_errors pipe "string list" "see below"
24259 .cindex "&(pipe)& transport" "temporary failure"
24260 This option contains either a colon-separated list of numbers, or a single
24261 asterisk. If &%ignore_status%& is false
24262 and &%return_output%& is not set,
24263 and the command exits with a non-zero return code, the failure is treated as
24264 temporary and the delivery is deferred if the return code matches one of the
24265 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24266 codes are treated as permanent errors. The default setting contains the codes
24267 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24268 compiled on a system that does not define these macros, it assumes values of 75
24269 and 73, respectively.
24270
24271
24272 .option timeout pipe time 1h
24273 If the command fails to complete within this time, it is killed. This normally
24274 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24275 specifies no timeout. In order to ensure that any subprocesses created by the
24276 command are also killed, Exim makes the initial process a process group leader,
24277 and kills the whole process group on a timeout. However, this can be defeated
24278 if one of the processes starts a new process group.
24279
24280 .option timeout_defer pipe boolean false
24281 A timeout in a &(pipe)& transport, either in the command that the transport
24282 runs, or in a transport filter that is associated with it, is by default
24283 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24284 is set true, both kinds of timeout become temporary errors, causing the
24285 delivery to be deferred.
24286
24287 .option umask pipe "octal integer" 022
24288 This specifies the umask setting for the subprocess that runs the command.
24289
24290
24291 .option use_bsmtp pipe boolean false
24292 .cindex "envelope sender"
24293 If this option is set true, the &(pipe)& transport writes messages in &"batch
24294 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24295 commands. If you want to include a leading HELO command with such messages,
24296 you can do so by setting the &%message_prefix%& option. See section
24297 &<<SECTbatchSMTP>>& for details of batch SMTP.
24298
24299 .option use_classresources pipe boolean false
24300 .cindex "class resources (BSD)"
24301 This option is available only when Exim is running on FreeBSD, NetBSD, or
24302 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24303 resource limits when a &(pipe)& transport is run to perform a delivery. The
24304 limits for the uid under which the pipe is to run are obtained from the login
24305 class database.
24306
24307
24308 .option use_crlf pipe boolean false
24309 .cindex "carriage return"
24310 .cindex "linefeed"
24311 This option causes lines to be terminated with the two-character CRLF sequence
24312 (carriage return, linefeed) instead of just a linefeed character. In the case
24313 of batched SMTP, the byte sequence written to the pipe is then an exact image
24314 of what would be sent down a real SMTP connection.
24315
24316 The contents of the &%message_prefix%& and &%message_suffix%& options are
24317 written verbatim, so must contain their own carriage return characters if these
24318 are needed. When &%use_bsmtp%& is not set, the default values for both
24319 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24320 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24321
24322
24323 .option use_shell pipe boolean false
24324 .vindex "&$pipe_addresses$&"
24325 If this option is set, it causes the command to be passed to &_/bin/sh_&
24326 instead of being run directly from the transport, as described in section
24327 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24328 where the command is expected to be run under a shell and cannot easily be
24329 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24330 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24331 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24332 its &%-c%& option.
24333
24334
24335
24336 .section "Using an external local delivery agent" "SECID143"
24337 .cindex "local delivery" "using an external agent"
24338 .cindex "&'procmail'&"
24339 .cindex "external local delivery"
24340 .cindex "delivery" "&'procmail'&"
24341 .cindex "delivery" "by external agent"
24342 The &(pipe)& transport can be used to pass all messages that require local
24343 delivery to a separate local delivery agent such as &%procmail%&. When doing
24344 this, care must be taken to ensure that the pipe is run under an appropriate
24345 uid and gid. In some configurations one wants this to be a uid that is trusted
24346 by the delivery agent to supply the correct sender of the message. It may be
24347 necessary to recompile or reconfigure the delivery agent so that it trusts an
24348 appropriate user. The following is an example transport and router
24349 configuration for &%procmail%&:
24350 .code
24351 # transport
24352 procmail_pipe:
24353   driver = pipe
24354   command = /usr/local/bin/procmail -d $local_part
24355   return_path_add
24356   delivery_date_add
24357   envelope_to_add
24358   check_string = "From "
24359   escape_string = ">From "
24360   umask = 077
24361   user = $local_part
24362   group = mail
24363
24364 # router
24365 procmail:
24366   driver = accept
24367   check_local_user
24368   transport = procmail_pipe
24369 .endd
24370 In this example, the pipe is run as the local user, but with the group set to
24371 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24372 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24373 user to supply a correct sender address. If you do not specify either a
24374 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24375 home directory is the user's home directory by default.
24376
24377 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24378 .code
24379 IFS=" "
24380 .endd
24381 as shown in some &%procmail%& documentation, because Exim does not by default
24382 use a shell to run pipe commands.
24383
24384 .cindex "Cyrus"
24385 The next example shows a transport and a router for a system where local
24386 deliveries are handled by the Cyrus IMAP server.
24387 .code
24388 # transport
24389 local_delivery_cyrus:
24390   driver = pipe
24391   command = /usr/cyrus/bin/deliver \
24392             -m ${substr_1:$local_part_suffix} -- $local_part
24393   user = cyrus
24394   group = mail
24395   return_output
24396   log_output
24397   message_prefix =
24398   message_suffix =
24399
24400 # router
24401 local_user_cyrus:
24402   driver = accept
24403   check_local_user
24404   local_part_suffix = .*
24405   transport = local_delivery_cyrus
24406 .endd
24407 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24408 &%return_output%& to cause any text written by Cyrus to be returned to the
24409 sender.
24410 .ecindex IIDpiptra1
24411 .ecindex IIDpiptra2
24412
24413
24414 . ////////////////////////////////////////////////////////////////////////////
24415 . ////////////////////////////////////////////////////////////////////////////
24416
24417 .chapter "The smtp transport" "CHAPsmtptrans"
24418 .scindex IIDsmttra1 "transports" "&(smtp)&"
24419 .scindex IIDsmttra2 "&(smtp)& transport"
24420 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24421 or LMTP protocol. The list of hosts to try can either be taken from the address
24422 that is being processed (having been set up by the router), or specified
24423 explicitly for the transport. Timeout and retry processing (see chapter
24424 &<<CHAPretry>>&) is applied to each IP address independently.
24425
24426
24427 .section "Multiple messages on a single connection" "SECID144"
24428 The sending of multiple messages over a single TCP/IP connection can arise in
24429 two ways:
24430
24431 .ilist
24432 If a message contains more than &%max_rcpt%& (see below) addresses that are
24433 routed to the same host, more than one copy of the message has to be sent to
24434 that host. In this situation, multiple copies may be sent in a single run of
24435 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24436 does when it has too many addresses to send in one message also depends on the
24437 value of the global &%remote_max_parallel%& option. Details are given in
24438 section &<<SECToutSMTPTCP>>&.)
24439 .next
24440 .cindex "hints database" "remembering routing"
24441 When a message has been successfully delivered over a TCP/IP connection, Exim
24442 looks in its hints database to see if there are any other messages awaiting a
24443 connection to the same host. If there are, a new delivery process is started
24444 for one of them, and the current TCP/IP connection is passed on to it. The new
24445 process may in turn send multiple copies and possibly create yet another
24446 process.
24447 .endlist
24448
24449
24450 For each copy sent over the same TCP/IP connection, a sequence counter is
24451 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24452 no further messages are sent over that connection.
24453
24454
24455
24456 .section "Use of the $host and $host_address variables" "SECID145"
24457 .vindex "&$host$&"
24458 .vindex "&$host_address$&"
24459 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24460 &$host_address$& are the name and IP address of the first host on the host list
24461 passed by the router. However, when the transport is about to connect to a
24462 specific host, and while it is connected to that host, &$host$& and
24463 &$host_address$& are set to the values for that host. These are the values
24464 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24465 &%serialize_hosts%&, and the various TLS options are expanded.
24466
24467
24468 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24469 .vindex &$tls_bits$&
24470 .vindex &$tls_cipher$&
24471 .vindex &$tls_peerdn$&
24472 .vindex &$tls_sni$&
24473 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24474 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24475 are the values that were set when the message was received.
24476 These are the values that are used for options that are expanded before any
24477 SMTP connections are made. Just before each connection is made, these four
24478 variables are emptied. If TLS is subsequently started, they are set to the
24479 appropriate values for the outgoing connection, and these are the values that
24480 are in force when any authenticators are run and when the
24481 &%authenticated_sender%& option is expanded.
24482
24483 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24484 and will be removed in a future release.
24485
24486
24487 .section "Private options for smtp" "SECID146"
24488 .cindex "options" "&(smtp)& transport"
24489 The private options of the &(smtp)& transport are as follows:
24490
24491
24492 .option address_retry_include_sender smtp boolean true
24493 .cindex "4&'xx'& responses" "retrying after"
24494 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24495 is the combination of sender and recipient that is delayed in subsequent queue
24496 runs until the retry time is reached. You can delay the recipient without
24497 reference to the sender (which is what earlier versions of Exim did), by
24498 setting &%address_retry_include_sender%& false. However, this can lead to
24499 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24500
24501 .option allow_localhost smtp boolean false
24502 .cindex "local host" "sending to"
24503 .cindex "fallback" "hosts specified on transport"
24504 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24505 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24506 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24507 the delivery anyway. This should be used only in special cases when the
24508 configuration ensures that no looping will result (for example, a differently
24509 configured Exim is listening on the port to which the message is sent).
24510
24511
24512 .option authenticated_sender smtp string&!! unset
24513 .cindex "Cyrus"
24514 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24515 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24516 overriding any existing authenticated sender value. If the string expansion is
24517 forced to fail, the option is ignored. Other expansion failures cause delivery
24518 to be deferred. If the result of expansion is an empty string, that is also
24519 ignored.
24520
24521 The expansion happens after the outgoing connection has been made and TLS
24522 started, if required. This means that the &$host$&, &$host_address$&,
24523 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24524 particular connection.
24525
24526 If the SMTP session is not authenticated, the expansion of
24527 &%authenticated_sender%& still happens (and can cause the delivery to be
24528 deferred if it fails), but no AUTH= item is added to MAIL commands
24529 unless &%authenticated_sender_force%& is true.
24530
24531 This option allows you to use the &(smtp)& transport in LMTP mode to
24532 deliver mail to Cyrus IMAP and provide the proper local part as the
24533 &"authenticated sender"&, via a setting such as:
24534 .code
24535 authenticated_sender = $local_part
24536 .endd
24537 This removes the need for IMAP subfolders to be assigned special ACLs to
24538 allow direct delivery to those subfolders.
24539
24540 Because of expected uses such as that just described for Cyrus (when no
24541 domain is involved), there is no checking on the syntax of the provided
24542 value.
24543
24544
24545 .option authenticated_sender_force smtp boolean false
24546 If this option is set true, the &%authenticated_sender%& option's value
24547 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24548 authenticated as a client.
24549
24550
24551 .option command_timeout smtp time 5m
24552 This sets a timeout for receiving a response to an SMTP command that has been
24553 sent out. It is also used when waiting for the initial banner line from the
24554 remote host. Its value must not be zero.
24555
24556
24557 .option connect_timeout smtp time 5m
24558 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24559 to a remote host. A setting of zero allows the system timeout (typically
24560 several minutes) to act. To have any effect, the value of this option must be
24561 less than the system timeout. However, it has been observed that on some
24562 systems there is no system timeout, which is why the default value for this
24563 option is 5 minutes, a value recommended by RFC 1123.
24564
24565
24566 .option connection_max_messages smtp integer 500
24567 .cindex "SMTP" "passed connection"
24568 .cindex "SMTP" "multiple deliveries"
24569 .cindex "multiple SMTP deliveries"
24570 This controls the maximum number of separate message deliveries that are sent
24571 over a single TCP/IP connection. If the value is zero, there is no limit.
24572 For testing purposes, this value can be overridden by the &%-oB%& command line
24573 option.
24574
24575
24576 .option dane_require_tls_ciphers smtp string&!! unset
24577 .cindex "TLS" "requiring specific ciphers for DANE"
24578 .cindex "cipher" "requiring specific"
24579 .cindex DANE "TLS ciphers"
24580 This option may be used to override &%tls_require_ciphers%& for connections
24581 where DANE has been determined to be in effect.
24582 If not set, then &%tls_require_ciphers%& will be used.
24583 Normal SMTP delivery is not able to make strong demands of TLS cipher
24584 configuration, because delivery will fall back to plaintext.  Once DANE has
24585 been determined to be in effect, there is no plaintext fallback and making the
24586 TLS cipherlist configuration stronger will increase security, rather than
24587 counter-intuitively decreasing it.
24588 If the option expands to be empty or is forced to fail, then it will
24589 be treated as unset and &%tls_require_ciphers%& will be used instead.
24590
24591
24592 .option data_timeout smtp time 5m
24593 This sets a timeout for the transmission of each block in the data portion of
24594 the message. As a result, the overall timeout for a message depends on the size
24595 of the message. Its value must not be zero. See also &%final_timeout%&.
24596
24597
24598 .option dkim_canon smtp string&!! unset
24599 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24600 .option dkim_domain smtp string list&!! unset
24601 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24602 .option dkim_hash smtp string&!! sha256
24603 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24604 .option dkim_identity smtp string&!! unset
24605 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24606 .option dkim_private_key smtp string&!! unset
24607 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24608 .option dkim_selector smtp string&!! unset
24609 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24610 .option dkim_strict smtp string&!! unset
24611 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24612 .option dkim_sign_headers smtp string&!! "per RFC"
24613 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24614 .option dkim_timestamps smtp string&!! unset
24615 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24616
24617
24618 .option delay_after_cutoff smtp boolean true
24619 .cindex "final cutoff" "retries, controlling"
24620 .cindex retry "final cutoff"
24621 This option controls what happens when all remote IP addresses for a given
24622 domain have been inaccessible for so long that they have passed their retry
24623 cutoff times.
24624
24625 In the default state, if the next retry time has not been reached for any of
24626 them, the address is bounced without trying any deliveries. In other words,
24627 Exim delays retrying an IP address after the final cutoff time until a new
24628 retry time is reached, and can therefore bounce an address without ever trying
24629 a delivery, when machines have been down for a long time. Some people are
24630 unhappy at this prospect, so...
24631
24632 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24633 addresses are past their final cutoff time, Exim tries to deliver to those
24634 IP addresses that have not been tried since the message arrived. If there are
24635 none, of if they all fail, the address is bounced. In other words, it does not
24636 delay when a new message arrives, but immediately tries those expired IP
24637 addresses that haven't been tried since the message arrived. If there is a
24638 continuous stream of messages for the dead hosts, unsetting
24639 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24640 to them.
24641
24642
24643 .option dns_qualify_single smtp boolean true
24644 If the &%hosts%& or &%fallback_hosts%& option is being used,
24645 and the &%gethostbyname%& option is false,
24646 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24647 in chapter &<<CHAPdnslookup>>& for more details.
24648
24649
24650 .option dns_search_parents smtp boolean false
24651 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24652 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24653 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24654 details.
24655
24656
24657 .option dnssec_request_domains smtp "domain list&!!" *
24658 .cindex "MX record" "security"
24659 .cindex "DNSSEC" "MX lookup"
24660 .cindex "security" "MX lookup"
24661 .cindex "DNS" "DNSSEC"
24662 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24663 the dnssec request bit set. Setting this transport option is only useful if the
24664 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24665 router option.
24666
24667
24668
24669 .option dnssec_require_domains smtp "domain list&!!" unset
24670 .cindex "MX record" "security"
24671 .cindex "DNSSEC" "MX lookup"
24672 .cindex "security" "MX lookup"
24673 .cindex "DNS" "DNSSEC"
24674 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24675 the dnssec request bit set.  Setting this transport option is only
24676 useful if the transport overrides or sets the host names. See the
24677 &%dnssec_require_domains%& router option.
24678
24679
24680
24681 .option dscp smtp string&!! unset
24682 .cindex "DCSP" "outbound"
24683 This option causes the DSCP value associated with a socket to be set to one
24684 of a number of fixed strings or to numeric value.
24685 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24686 Common values include &`throughput`&, &`mincost`&, and on newer systems
24687 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24688
24689 The outbound packets from Exim will be marked with this value in the header
24690 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24691 that these values will have any effect, not be stripped by networking
24692 equipment, or do much of anything without cooperation with your Network
24693 Engineer and those of all network operators between the source and destination.
24694
24695
24696 .option fallback_hosts smtp "string list" unset
24697 .cindex "fallback" "hosts specified on transport"
24698 String expansion is not applied to this option. The argument must be a
24699 colon-separated list of host names or IP addresses, optionally also including
24700 port numbers, though the separator can be changed, as described in section
24701 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24702 item in a &%route_list%& setting for the &(manualroute)& router, as described
24703 in section &<<SECTformatonehostitem>>&.
24704
24705 Fallback hosts can also be specified on routers, which associate them with the
24706 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24707 &%fallback_hosts%& specified on the transport is used only if the address does
24708 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24709 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24710 However, &%hosts_randomize%& does apply to fallback host lists.
24711
24712 If Exim is unable to deliver to any of the hosts for a particular address, and
24713 the errors are not permanent rejections, the address is put on a separate
24714 transport queue with its host list replaced by the fallback hosts, unless the
24715 address was routed via MX records and the current host was in the original MX
24716 list. In that situation, the fallback host list is not used.
24717
24718 Once normal deliveries are complete, the fallback queue is delivered by
24719 re-running the same transports with the new host lists. If several failing
24720 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24721 copy of the message is sent.
24722
24723 The resolution of the host names on the fallback list is controlled by the
24724 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24725 both to cases when the host list comes with the address and when it is taken
24726 from &%hosts%&. This option provides a &"use a smart host only if delivery
24727 fails"& facility.
24728
24729
24730 .option final_timeout smtp time 10m
24731 This is the timeout that applies while waiting for the response to the final
24732 line containing just &"."& that terminates a message. Its value must not be
24733 zero.
24734
24735 .option gethostbyname smtp boolean false
24736 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24737 being used, names are looked up using &[gethostbyname()]&
24738 (or &[getipnodebyname()]& when available)
24739 instead of using the DNS. Of course, that function may in fact use the DNS, but
24740 it may also consult other sources of information such as &_/etc/hosts_&.
24741
24742 .option gnutls_compat_mode smtp boolean unset
24743 This option controls whether GnuTLS is used in compatibility mode in an Exim
24744 server. This reduces security slightly, but improves interworking with older
24745 implementations of TLS.
24746
24747 .option helo_data smtp string&!! "see below"
24748 .cindex "HELO" "argument, setting"
24749 .cindex "EHLO" "argument, setting"
24750 .cindex "LHLO argument setting"
24751 The value of this option is expanded after a connection to a another host has
24752 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24753 command that starts the outgoing SMTP or LMTP session. The default value of the
24754 option is:
24755 .code
24756 $primary_hostname
24757 .endd
24758 During the expansion, the variables &$host$& and &$host_address$& are set to
24759 the identity of the remote host, and the variables &$sending_ip_address$& and
24760 &$sending_port$& are set to the local IP address and port number that are being
24761 used. These variables can be used to generate different values for different
24762 servers or different local IP addresses. For example, if you want the string
24763 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24764 interface address, you could use this:
24765 .code
24766 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24767   {$primary_hostname}}
24768 .endd
24769 The use of &%helo_data%& applies both to sending messages and when doing
24770 callouts.
24771
24772 .option hosts smtp "string list&!!" unset
24773 Hosts are associated with an address by a router such as &(dnslookup)&, which
24774 finds the hosts by looking up the address domain in the DNS, or by
24775 &(manualroute)&, which has lists of hosts in its configuration. However,
24776 email addresses can be passed to the &(smtp)& transport by any router, and not
24777 all of them can provide an associated list of hosts.
24778
24779 The &%hosts%& option specifies a list of hosts to be used if the address being
24780 processed does not have any hosts associated with it. The hosts specified by
24781 &%hosts%& are also used, whether or not the address has its own hosts, if
24782 &%hosts_override%& is set.
24783
24784 The string is first expanded, before being interpreted as a colon-separated
24785 list of host names or IP addresses, possibly including port numbers. The
24786 separator may be changed to something other than colon, as described in section
24787 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24788 item in a &%route_list%& setting for the &(manualroute)& router, as described
24789 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24790 of the &(manualroute)& router is not available here.
24791
24792 If the expansion fails, delivery is deferred. Unless the failure was caused by
24793 the inability to complete a lookup, the error is logged to the panic log as
24794 well as the main log. Host names are looked up either by searching directly for
24795 address records in the DNS or by calling &[gethostbyname()]& (or
24796 &[getipnodebyname()]& when available), depending on the setting of the
24797 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24798 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24799 address are used.
24800
24801 During delivery, the hosts are tried in order, subject to their retry status,
24802 unless &%hosts_randomize%& is set.
24803
24804
24805 .option hosts_avoid_esmtp smtp "host list&!!" unset
24806 .cindex "ESMTP, avoiding use of"
24807 .cindex "HELO" "forcing use of"
24808 .cindex "EHLO" "avoiding use of"
24809 .cindex "PIPELINING" "avoiding the use of"
24810 This option is for use with broken hosts that announce ESMTP facilities (for
24811 example, PIPELINING) and then fail to implement them properly. When a host
24812 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24813 start of the SMTP session. This means that it cannot use any of the ESMTP
24814 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24815
24816
24817 .option hosts_avoid_pipelining smtp "host list&!!" unset
24818 .cindex "PIPELINING" "avoiding the use of"
24819 Exim will not use the SMTP PIPELINING extension when delivering to any host
24820 that matches this list, even if the server host advertises PIPELINING support.
24821
24822 .option hosts_pipe_connect smtp "host list&!!" unset
24823 .cindex "pipelining" "early connection"
24824 .cindex "pipelining" PIPE_CONNECT
24825 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24826 this option controls which to hosts the facility watched for
24827 and recorded, and used for subsequent connections.
24828
24829 The retry hints database is used for the record,
24830 and records are subject to the &%retry_data_expire%& option.
24831 When used, the pipelining saves on roundtrip times.
24832 It also turns SMTP into a client-first protocol
24833 so combines well with TCP Fast Open.
24834
24835 See also the &%pipelining_connect_advertise_hosts%& main option.
24836
24837 Note:
24838 When the facility is used, the transport &%helo_data%& option
24839 will be expanded before the &$sending_ip_address$& variable
24840 is filled in.
24841 A check is made for the use of that variable, without the
24842 presence of a &"def:"& test on it, but suitably complex coding
24843 can avoid the check and produce unexpected results.
24844 You have been warned.
24845
24846
24847 .option hosts_avoid_tls smtp "host list&!!" unset
24848 .cindex "TLS" "avoiding for certain hosts"
24849 Exim will not try to start a TLS session when delivering to any host that
24850 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24851
24852 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24853 .cindex "TLS" "avoiding for certain hosts"
24854 Exim will not try to start a TLS session for a verify callout,
24855 or when delivering in cutthrough mode,
24856 to any host that matches this list.
24857
24858
24859 .option hosts_max_try smtp integer 5
24860 .cindex "host" "maximum number to try"
24861 .cindex "limit" "number of hosts tried"
24862 .cindex "limit" "number of MX tried"
24863 .cindex "MX record" "maximum tried"
24864 This option limits the number of IP addresses that are tried for any one
24865 delivery in cases where there are temporary delivery errors. Section
24866 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24867
24868
24869 .option hosts_max_try_hardlimit smtp integer 50
24870 This is an additional check on the maximum number of IP addresses that Exim
24871 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24872 why it exists.
24873
24874
24875
24876 .option hosts_nopass_tls smtp "host list&!!" unset
24877 .cindex "TLS" "passing connection"
24878 .cindex "multiple SMTP deliveries"
24879 .cindex "TLS" "multiple message deliveries"
24880 For any host that matches this list, a connection on which a TLS session has
24881 been started will not be passed to a new delivery process for sending another
24882 message on the same connection. See section &<<SECTmulmessam>>& for an
24883 explanation of when this might be needed.
24884
24885 .option hosts_noproxy_tls smtp "host list&!!" unset
24886 .cindex "TLS" "passing connection"
24887 .cindex "multiple SMTP deliveries"
24888 .cindex "TLS" "multiple message deliveries"
24889 For any host that matches this list, a TLS session which has
24890 been started will not be passed to a new delivery process for sending another
24891 message on the same session.
24892
24893 The traditional implementation closes down TLS and re-starts it in the new
24894 process, on the same open TCP connection, for each successive message
24895 sent.  If permitted by this option a pipe to to the new process is set up
24896 instead, and the original process maintains the TLS connection and proxies
24897 the SMTP connection from and to the new process and any subsequents.
24898 The new process has no access to TLS information, so cannot include it in
24899 logging.
24900
24901
24902
24903 .option hosts_override smtp boolean false
24904 If this option is set and the &%hosts%& option is also set, any hosts that are
24905 attached to the address are ignored, and instead the hosts specified by the
24906 &%hosts%& option are always used. This option does not apply to
24907 &%fallback_hosts%&.
24908
24909
24910 .option hosts_randomize smtp boolean false
24911 .cindex "randomized host list"
24912 .cindex "host" "list of; randomized"
24913 .cindex "fallback" "randomized hosts"
24914 If this option is set, and either the list of hosts is taken from the
24915 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24916 were not obtained from MX records (this includes fallback hosts from the
24917 router), and were not randomized by the router, the order of trying the hosts
24918 is randomized each time the transport runs. Randomizing the order of a host
24919 list can be used to do crude load sharing.
24920
24921 When &%hosts_randomize%& is true, a host list may be split into groups whose
24922 order is separately randomized. This makes it possible to set up MX-like
24923 behaviour. The boundaries between groups are indicated by an item that is just
24924 &`+`& in the host list. For example:
24925 .code
24926 hosts = host1:host2:host3:+:host4:host5
24927 .endd
24928 The order of the first three hosts and the order of the last two hosts is
24929 randomized for each use, but the first three always end up before the last two.
24930 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24931
24932 .option hosts_require_auth smtp "host list&!!" unset
24933 .cindex "authentication" "required by client"
24934 This option provides a list of servers for which authentication must succeed
24935 before Exim will try to transfer a message. If authentication fails for
24936 servers which are not in this list, Exim tries to send unauthenticated. If
24937 authentication fails for one of these servers, delivery is deferred. This
24938 temporary error is detectable in the retry rules, so it can be turned into a
24939 hard failure if required. See also &%hosts_try_auth%&, and chapter
24940 &<<CHAPSMTPAUTH>>& for details of authentication.
24941
24942
24943 .option hosts_request_ocsp smtp "host list&!!" *
24944 .cindex "TLS" "requiring for certain servers"
24945 Exim will request a Certificate Status on a
24946 TLS session for any host that matches this list.
24947 &%tls_verify_certificates%& should also be set for the transport.
24948
24949 .option hosts_require_dane smtp "host list&!!" unset
24950 .cindex DANE "transport options"
24951 .cindex DANE "requiring for certain servers"
24952 If built with DANE support, Exim  will require that a DNSSEC-validated
24953 TLSA record is present for any host matching the list,
24954 and that a DANE-verified TLS connection is made. See
24955 the &%dnssec_request_domains%& router and transport options.
24956 There will be no fallback to in-clear communication.
24957 See section &<<SECDANE>>&.
24958
24959 .option hosts_require_ocsp smtp "host list&!!" unset
24960 .cindex "TLS" "requiring for certain servers"
24961 Exim will request, and check for a valid Certificate Status being given, on a
24962 TLS session for any host that matches this list.
24963 &%tls_verify_certificates%& should also be set for the transport.
24964
24965 .option hosts_require_tls smtp "host list&!!" unset
24966 .cindex "TLS" "requiring for certain servers"
24967 Exim will insist on using a TLS session when delivering to any host that
24968 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24969 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24970 incoming messages, use an appropriate ACL.
24971
24972 .option hosts_try_auth smtp "host list&!!" unset
24973 .cindex "authentication" "optional in client"
24974 This option provides a list of servers to which, provided they announce
24975 authentication support, Exim will attempt to authenticate as a client when it
24976 connects. If authentication fails, Exim will try to transfer the message
24977 unauthenticated. See also &%hosts_require_auth%&, and chapter
24978 &<<CHAPSMTPAUTH>>& for details of authentication.
24979
24980 .option hosts_try_chunking smtp "host list&!!" *
24981 .cindex CHUNKING "enabling, in client"
24982 .cindex BDAT "SMTP command"
24983 .cindex "RFC 3030" "CHUNKING"
24984 This option provides a list of servers to which, provided they announce
24985 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24986 .new
24987 Unless DKIM signing is being done,
24988 .wen
24989 BDAT will not be used in conjunction with a transport filter.
24990
24991 .option hosts_try_dane smtp "host list&!!" *
24992 .cindex DANE "transport options"
24993 .cindex DANE "attempting for certain servers"
24994 If built with DANE support, Exim  will require that a DNSSEC-validated
24995 TLSA record is present for any host matching the list,
24996 and that a DANE-verified TLS connection is made. See
24997 the &%dnssec_request_domains%& router and transport options.
24998 There will be no fallback to in-clear communication.
24999 See section &<<SECDANE>>&.
25000
25001 .option hosts_try_fastopen smtp "host list&!!" *
25002 .cindex "fast open, TCP" "enabling, in client"
25003 .cindex "TCP Fast Open" "enabling, in client"
25004 .cindex "RFC 7413" "TCP Fast Open"
25005 This option provides a list of servers to which, provided
25006 the facility is supported by this system, Exim will attempt to
25007 perform a TCP Fast Open.
25008 No data is sent on the SYN segment but, if the remote server also
25009 supports the facility, it can send its SMTP banner immediately after
25010 the SYN,ACK segment.  This can save up to one round-trip time.
25011
25012 The facility is only active for previously-contacted servers,
25013 as the initiator must present a cookie in the SYN segment.
25014
25015 On (at least some) current Linux distributions the facility must be enabled
25016 in the kernel by the sysadmin before the support is usable.
25017 There is no option for control of the server side; if the system supports
25018 it it is always enabled.  Note that lengthy operations in the connect ACL,
25019 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25020
25021 .option hosts_try_prdr smtp "host list&!!" *
25022 .cindex "PRDR" "enabling, optional in client"
25023 This option provides a list of servers to which, provided they announce
25024 PRDR support, Exim will attempt to negotiate PRDR
25025 for multi-recipient messages.
25026 The option can usually be left as default.
25027
25028 .option interface smtp "string list&!!" unset
25029 .cindex "bind IP address"
25030 .cindex "IP address" "binding"
25031 .vindex "&$host$&"
25032 .vindex "&$host_address$&"
25033 This option specifies which interface to bind to when making an outgoing SMTP
25034 call. The value is an IP address, not an interface name such as
25035 &`eth0`&. Do not confuse this with the interface address that was used when a
25036 message was received, which is in &$received_ip_address$&, formerly known as
25037 &$interface_address$&. The name was changed to minimize confusion with the
25038 outgoing interface address. There is no variable that contains an outgoing
25039 interface address because, unless it is set by this option, its value is
25040 unknown.
25041
25042 During the expansion of the &%interface%& option the variables &$host$& and
25043 &$host_address$& refer to the host to which a connection is about to be made
25044 during the expansion of the string. Forced expansion failure, or an empty
25045 string result causes the option to be ignored. Otherwise, after expansion, the
25046 string must be a list of IP addresses, colon-separated by default, but the
25047 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25048 For example:
25049 .code
25050 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25051 .endd
25052 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25053 connection. If none of them are the correct type, the option is ignored. If
25054 &%interface%& is not set, or is ignored, the system's IP functions choose which
25055 interface to use if the host has more than one.
25056
25057
25058 .option keepalive smtp boolean true
25059 .cindex "keepalive" "on outgoing connection"
25060 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25061 connections. When set, it causes the kernel to probe idle connections
25062 periodically, by sending packets with &"old"& sequence numbers. The other end
25063 of the connection should send a acknowledgment if the connection is still okay
25064 or a reset if the connection has been aborted. The reason for doing this is
25065 that it has the beneficial effect of freeing up certain types of connection
25066 that can get stuck when the remote host is disconnected without tidying up the
25067 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25068 unreachable hosts.
25069
25070
25071 .option lmtp_ignore_quota smtp boolean false
25072 .cindex "LMTP" "ignoring quota errors"
25073 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25074 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25075 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25076
25077 .option max_rcpt smtp integer 100
25078 .cindex "RCPT" "maximum number of outgoing"
25079 This option limits the number of RCPT commands that are sent in a single
25080 SMTP message transaction. Each set of addresses is treated independently, and
25081 so can cause parallel connections to the same host if &%remote_max_parallel%&
25082 permits this.
25083
25084
25085 .option multi_domain smtp boolean&!! true
25086 .vindex "&$domain$&"
25087 When this option is set, the &(smtp)& transport can handle a number of
25088 addresses containing a mixture of different domains provided they all resolve
25089 to the same list of hosts. Turning the option off restricts the transport to
25090 handling only one domain at a time. This is useful if you want to use
25091 &$domain$& in an expansion for the transport, because it is set only when there
25092 is a single domain involved in a remote delivery.
25093
25094 It is expanded per-address and can depend on any of
25095 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25096 &$host$&, &$host_address$& and &$host_port$&.
25097
25098 .option port smtp string&!! "see below"
25099 .cindex "port" "sending TCP/IP"
25100 .cindex "TCP/IP" "setting outgoing port"
25101 This option specifies the TCP/IP port on the server to which Exim connects.
25102 &*Note:*& Do not confuse this with the port that was used when a message was
25103 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25104 The name was changed to minimize confusion with the outgoing port. There is no
25105 variable that contains an outgoing port.
25106
25107 If the value of this option begins with a digit it is taken as a port number;
25108 otherwise it is looked up using &[getservbyname()]&. The default value is
25109 normally &"smtp"&,
25110 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25111 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25112 If the expansion fails, or if a port number cannot be found, delivery
25113 is deferred.
25114
25115 Note that at least one Linux distribution has been seen failing
25116 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25117
25118
25119
25120 .option protocol smtp string smtp
25121 .cindex "LMTP" "over TCP/IP"
25122 .cindex "ssmtp protocol" "outbound"
25123 .cindex "TLS" "SSL-on-connect outbound"
25124 .vindex "&$port$&"
25125 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25126 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25127 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25128 deliveries into closed message stores. Exim also has support for running LMTP
25129 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25130
25131 If this option is set to &"smtps"&, the default value for the &%port%& option
25132 changes to &"smtps"&, and the transport initiates TLS immediately after
25133 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25134 The Internet standards bodies used to strongly discourage use of this mode,
25135 but as of RFC 8314 it is perferred over STARTTLS for message submission
25136 (as distinct from MTA-MTA communication).
25137
25138
25139 .option retry_include_ip_address smtp boolean&!! true
25140 Exim normally includes both the host name and the IP address in the key it
25141 constructs for indexing retry data after a temporary delivery failure. This
25142 means that when one of several IP addresses for a host is failing, it gets
25143 tried periodically (controlled by the retry rules), but use of the other IP
25144 addresses is not affected.
25145
25146 However, in some dialup environments hosts are assigned a different IP address
25147 each time they connect. In this situation the use of the IP address as part of
25148 the retry key leads to undesirable behaviour. Setting this option false causes
25149 Exim to use only the host name.
25150 Since it is expanded it can be made to depend on the host or domain.
25151
25152
25153 .option serialize_hosts smtp "host list&!!" unset
25154 .cindex "serializing connections"
25155 .cindex "host" "serializing connections"
25156 Because Exim operates in a distributed manner, if several messages for the same
25157 host arrive at around the same time, more than one simultaneous connection to
25158 the remote host can occur. This is not usually a problem except when there is a
25159 slow link between the hosts. In that situation it may be helpful to restrict
25160 Exim to one connection at a time. This can be done by setting
25161 &%serialize_hosts%& to match the relevant hosts.
25162
25163 .cindex "hints database" "serializing deliveries to a host"
25164 Exim implements serialization by means of a hints database in which a record is
25165 written whenever a process connects to one of the restricted hosts. The record
25166 is deleted when the connection is completed. Obviously there is scope for
25167 records to get left lying around if there is a system or program crash. To
25168 guard against this, Exim ignores any records that are more than six hours old.
25169
25170 If you set up this kind of serialization, you should also arrange to delete the
25171 relevant hints database whenever your system reboots. The names of the files
25172 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25173 may be one or two files, depending on the type of DBM in use. The same files
25174 are used for ETRN serialization.
25175
25176 See also the &%max_parallel%& generic transport option.
25177
25178
25179 .option size_addition smtp integer 1024
25180 .cindex "SMTP" "SIZE"
25181 .cindex "message" "size issue for transport filter"
25182 .cindex "size" "of message"
25183 .cindex "transport" "filter"
25184 .cindex "filter" "transport filter"
25185 If a remote SMTP server indicates that it supports the SIZE option of the
25186 MAIL command, Exim uses this to pass over the message size at the start of
25187 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25188 sends, to allow for headers and other text that may be added during delivery by
25189 configuration options or in a transport filter. It may be necessary to increase
25190 this if a lot of text is added to messages.
25191
25192 Alternatively, if the value of &%size_addition%& is set negative, it disables
25193 the use of the SIZE option altogether.
25194
25195
25196 .option socks_proxy smtp string&!! unset
25197 .cindex proxy SOCKS
25198 This option enables use of SOCKS proxies for connections made by the
25199 transport.  For details see section &<<SECTproxySOCKS>>&.
25200
25201
25202 .option tls_certificate smtp string&!! unset
25203 .cindex "TLS" "client certificate, location of"
25204 .cindex "certificate" "client, location of"
25205 .vindex "&$host$&"
25206 .vindex "&$host_address$&"
25207 The value of this option must be the absolute path to a file which contains the
25208 client's certificate, for possible use when sending a message over an encrypted
25209 connection. The values of &$host$& and &$host_address$& are set to the name and
25210 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25211 details of TLS.
25212
25213 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25214 certificate when sending messages as a client. The global option of the same
25215 name specifies the certificate for Exim as a server; it is not automatically
25216 assumed that the same certificate should be used when Exim is operating as a
25217 client.
25218
25219
25220 .option tls_crl smtp string&!! unset
25221 .cindex "TLS" "client certificate revocation list"
25222 .cindex "certificate" "revocation list for client"
25223 This option specifies a certificate revocation list. The expanded value must
25224 be the name of a file that contains a CRL in PEM format.
25225
25226
25227 .option tls_dh_min_bits smtp integer 1024
25228 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25229 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25230 key agreement is negotiated, the server will provide a large prime number
25231 for use.  This option establishes the minimum acceptable size of that number.
25232 If the parameter offered by the server is too small, then the TLS handshake
25233 will fail.
25234
25235 Only supported when using GnuTLS.
25236
25237
25238 .option tls_privatekey smtp string&!! unset
25239 .cindex "TLS" "client private key, location of"
25240 .vindex "&$host$&"
25241 .vindex "&$host_address$&"
25242 The value of this option must be the absolute path to a file which contains the
25243 client's private key. This is used when sending a message over an encrypted
25244 connection using a client certificate. The values of &$host$& and
25245 &$host_address$& are set to the name and address of the server during the
25246 expansion. If this option is unset, or the expansion is forced to fail, or the
25247 result is an empty string, the private key is assumed to be in the same file as
25248 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25249
25250
25251 .option tls_require_ciphers smtp string&!! unset
25252 .cindex "TLS" "requiring specific ciphers"
25253 .cindex "cipher" "requiring specific"
25254 .vindex "&$host$&"
25255 .vindex "&$host_address$&"
25256 The value of this option must be a list of permitted cipher suites, for use
25257 when setting up an outgoing encrypted connection. (There is a global option of
25258 the same name for controlling incoming connections.) The values of &$host$& and
25259 &$host_address$& are set to the name and address of the server during the
25260 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25261 is used in different ways by OpenSSL and GnuTLS (see sections
25262 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25263 ciphers is a preference order.
25264
25265
25266
25267 .option tls_sni smtp string&!! unset
25268 .cindex "TLS" "Server Name Indication"
25269 .vindex "&$tls_sni$&"
25270 If this option is set then it sets the $tls_out_sni variable and causes any
25271 TLS session to pass this value as the Server Name Indication extension to
25272 the remote side, which can be used by the remote side to select an appropriate
25273 certificate and private key for the session.
25274
25275 See &<<SECTtlssni>>& for more information.
25276
25277 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25278 TLS extensions.
25279
25280
25281
25282
25283 .option tls_tempfail_tryclear smtp boolean true
25284 .cindex "4&'xx'& responses" "to STARTTLS"
25285 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25286 setting up a TLS session, this option determines whether or not Exim should try
25287 to deliver the message unencrypted. If it is set false, delivery to the
25288 current host is deferred; if there are other hosts, they are tried. If this
25289 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25290 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25291 TLS negotiation fails, Exim closes the current connection (because it is in an
25292 unknown state), opens a new one to the same host, and then tries the delivery
25293 in clear.
25294
25295
25296 .option tls_try_verify_hosts smtp "host list&!!" *
25297 .cindex "TLS" "server certificate verification"
25298 .cindex "certificate" "verification of server"
25299 This option gives a list of hosts for which, on encrypted connections,
25300 certificate verification will be tried but need not succeed.
25301 The &%tls_verify_certificates%& option must also be set.
25302 Note that unless the host is in this list
25303 TLS connections will be denied to hosts using self-signed certificates
25304 when &%tls_verify_certificates%& is matched.
25305 The &$tls_out_certificate_verified$& variable is set when
25306 certificate verification succeeds.
25307
25308
25309 .option tls_verify_cert_hostnames smtp "host list&!!" *
25310 .cindex "TLS" "server certificate hostname verification"
25311 .cindex "certificate" "verification of server"
25312 This option give a list of hosts for which,
25313 while verifying the server certificate,
25314 checks will be included on the host name
25315 (note that this will generally be the result of a DNS MX lookup)
25316 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25317 limited to being the initial component of a 3-or-more component FQDN.
25318
25319 There is no equivalent checking on client certificates.
25320
25321
25322 .option tls_verify_certificates smtp string&!! system
25323 .cindex "TLS" "server certificate verification"
25324 .cindex "certificate" "verification of server"
25325 .vindex "&$host$&"
25326 .vindex "&$host_address$&"
25327 The value of this option must be either the
25328 word "system"
25329 or the absolute path to
25330 a file or directory containing permitted certificates for servers,
25331 for use when setting up an encrypted connection.
25332
25333 The "system" value for the option will use a location compiled into the SSL library.
25334 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25335 is taken as empty and an explicit location
25336 must be specified.
25337
25338 The use of a directory for the option value is not available for GnuTLS versions
25339 preceding 3.3.6 and a single file must be used.
25340
25341 With OpenSSL the certificates specified
25342 explicitly
25343 either by file or directory
25344 are added to those given by the system default location.
25345
25346 The values of &$host$& and
25347 &$host_address$& are set to the name and address of the server during the
25348 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25349
25350 For back-compatibility,
25351 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25352 (a single-colon empty list counts as being set)
25353 and certificate verification fails the TLS connection is closed.
25354
25355
25356 .option tls_verify_hosts smtp "host list&!!" unset
25357 .cindex "TLS" "server certificate verification"
25358 .cindex "certificate" "verification of server"
25359 This option gives a list of hosts for which, on encrypted connections,
25360 certificate verification must succeed.
25361 The &%tls_verify_certificates%& option must also be set.
25362 If both this option and &%tls_try_verify_hosts%& are unset
25363 operation is as if this option selected all hosts.
25364
25365 .option utf8_downconvert smtp integer!! unset
25366 .cindex utf8 "address downconversion"
25367 .cindex i18n "utf8 address downconversion"
25368 If built with internationalization support,
25369 this option controls conversion of UTF-8 in message addresses
25370 to a-label form.
25371 For details see section &<<SECTi18nMTA>>&.
25372
25373
25374
25375
25376 .section "How the limits for the number of hosts to try are used" &&&
25377          "SECTvalhosmax"
25378 .cindex "host" "maximum number to try"
25379 .cindex "limit" "hosts; maximum number tried"
25380 There are two options that are concerned with the number of hosts that are
25381 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25382 &%hosts_max_try_hardlimit%&.
25383
25384
25385 The &%hosts_max_try%& option limits the number of hosts that are tried
25386 for a single delivery. However, despite the term &"host"& in its name, the
25387 option actually applies to each IP address independently. In other words, a
25388 multihomed host is treated as several independent hosts, just as it is for
25389 retrying.
25390
25391 Many of the larger ISPs have multiple MX records which often point to
25392 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25393 created as a result of routing one of these domains.
25394
25395 Trying every single IP address on such a long list does not seem sensible; if
25396 several at the top of the list fail, it is reasonable to assume there is some
25397 problem that is likely to affect all of them. Roughly speaking, the value of
25398 &%hosts_max_try%& is the maximum number that are tried before deferring the
25399 delivery. However, the logic cannot be quite that simple.
25400
25401 Firstly, IP addresses that are skipped because their retry times have not
25402 arrived do not count, and in addition, addresses that are past their retry
25403 limits are also not counted, even when they are tried. This means that when
25404 some IP addresses are past their retry limits, more than the value of
25405 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25406 that all IP addresses are considered before timing out an email address (but
25407 see below for an exception).
25408
25409 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25410 list to see if there is a subsequent host with a different (higher valued) MX.
25411 If there is, that host is considered next, and the current IP address is used
25412 but not counted. This behaviour helps in the case of a domain with a retry rule
25413 that hardly ever delays any hosts, as is now explained:
25414
25415 Consider the case of a long list of hosts with one MX value, and a few with a
25416 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25417 hosts at the top of the list are tried at first. With the default retry rule,
25418 which specifies increasing retry times, the higher MX hosts are eventually
25419 tried when those at the top of the list are skipped because they have not
25420 reached their retry times.
25421
25422 However, it is common practice to put a fixed short retry time on domains for
25423 large ISPs, on the grounds that their servers are rarely down for very long.
25424 Unfortunately, these are exactly the domains that tend to resolve to long lists
25425 of hosts. The short retry time means that the lowest MX hosts are tried every
25426 time. The attempts may be in a different order because of random sorting, but
25427 without the special MX check, the higher MX hosts would never be tried until
25428 all the lower MX hosts had timed out (which might be several days), because
25429 there are always some lower MX hosts that have reached their retry times. With
25430 the special check, Exim considers at least one IP address from each MX value at
25431 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25432 reached.
25433
25434 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25435 particular, Exim normally eventually tries all the IP addresses before timing
25436 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25437 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25438 been set up with hundreds of IP addresses for some domains. It can
25439 take a very long time indeed for an address to time out in these cases.
25440
25441 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25442 Exim never tries more than this number of IP addresses; if it hits this limit
25443 and they are all timed out, the email address is bounced, even though not all
25444 possible IP addresses have been tried.
25445 .ecindex IIDsmttra1
25446 .ecindex IIDsmttra2
25447
25448
25449
25450
25451
25452 . ////////////////////////////////////////////////////////////////////////////
25453 . ////////////////////////////////////////////////////////////////////////////
25454
25455 .chapter "Address rewriting" "CHAPrewrite"
25456 .scindex IIDaddrew "rewriting" "addresses"
25457 There are some circumstances in which Exim automatically rewrites domains in
25458 addresses. The two most common are when an address is given without a domain
25459 (referred to as an &"unqualified address"&) or when an address contains an
25460 abbreviated domain that is expanded by DNS lookup.
25461
25462 Unqualified envelope addresses are accepted only for locally submitted
25463 messages, or for messages that are received from hosts matching
25464 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25465 appropriate. Unqualified addresses in header lines are qualified if they are in
25466 locally submitted messages, or messages from hosts that are permitted to send
25467 unqualified envelope addresses. Otherwise, unqualified addresses in header
25468 lines are neither qualified nor rewritten.
25469
25470 One situation in which Exim does &'not'& automatically rewrite a domain is
25471 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25472 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25473 do this. The new RFCs do not contain this suggestion.
25474
25475
25476 .section "Explicitly configured address rewriting" "SECID147"
25477 This chapter describes the rewriting rules that can be used in the
25478 main rewrite section of the configuration file, and also in the generic
25479 &%headers_rewrite%& option that can be set on any transport.
25480
25481 Some people believe that configured address rewriting is a Mortal Sin.
25482 Others believe that life is not possible without it. Exim provides the
25483 facility; you do not have to use it.
25484
25485 The main rewriting rules that appear in the &"rewrite"& section of the
25486 configuration file are applied to addresses in incoming messages, both envelope
25487 addresses and addresses in header lines. Each rule specifies the types of
25488 address to which it applies.
25489
25490 Whether or not addresses in header lines are rewritten depends on the origin of
25491 the headers and the type of rewriting. Global rewriting, that is, rewriting
25492 rules from the rewrite section of the configuration file, is applied only to
25493 those headers that were received with the message. Header lines that are added
25494 by ACLs or by a system filter or by individual routers or transports (which
25495 are specific to individual recipient addresses) are not rewritten by the global
25496 rules.
25497
25498 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25499 applies all headers except those added by routers and transports. That is, as
25500 well as the headers that were received with the message, it also applies to
25501 headers that were added by an ACL or a system filter.
25502
25503
25504 In general, rewriting addresses from your own system or domain has some
25505 legitimacy. Rewriting other addresses should be done only with great care and
25506 in special circumstances. The author of Exim believes that rewriting should be
25507 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25508 Although it can sometimes be used as a routing tool, this is very strongly
25509 discouraged.
25510
25511 There are two commonly encountered circumstances where rewriting is used, as
25512 illustrated by these examples:
25513
25514 .ilist
25515 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25516 exchange mail with each other behind a firewall, but there is only a single
25517 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25518 &'hitch.fict.example'& when sending mail off-site.
25519 .next
25520 A host rewrites the local parts of its own users so that, for example,
25521 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25522 .endlist
25523
25524
25525
25526 .section "When does rewriting happen?" "SECID148"
25527 .cindex "rewriting" "timing of"
25528 .cindex "&ACL;" "rewriting addresses in"
25529 Configured address rewriting can take place at several different stages of a
25530 message's processing.
25531
25532 .vindex "&$sender_address$&"
25533 At the start of an ACL for MAIL, the sender address may have been rewritten
25534 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25535 ordinary rewrite rules have yet been applied. If, however, the sender address
25536 is verified in the ACL, it is rewritten before verification, and remains
25537 rewritten thereafter. The subsequent value of &$sender_address$& is the
25538 rewritten address. This also applies if sender verification happens in a
25539 RCPT ACL. Otherwise, when the sender address is not verified, it is
25540 rewritten as soon as a message's header lines have been received.
25541
25542 .vindex "&$domain$&"
25543 .vindex "&$local_part$&"
25544 Similarly, at the start of an ACL for RCPT, the current recipient's address
25545 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25546 rewrite rules have yet been applied to it. However, the behaviour is different
25547 from the sender address when a recipient is verified. The address is rewritten
25548 for the verification, but the rewriting is not remembered at this stage. The
25549 value of &$local_part$& and &$domain$& after verification are always the same
25550 as they were before (that is, they contain the unrewritten &-- except for
25551 SMTP-time rewriting &-- address).
25552
25553 As soon as a message's header lines have been received, all the envelope
25554 recipient addresses are permanently rewritten, and rewriting is also applied to
25555 the addresses in the header lines (if configured). This happens before adding
25556 any header lines that were specified in MAIL or RCPT ACLs, and
25557 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25558 before the DATA ACL and &[local_scan()]& functions are run.
25559
25560 When an address is being routed, either for delivery or for verification,
25561 rewriting is applied immediately to child addresses that are generated by
25562 redirection, unless &%no_rewrite%& is set on the router.
25563
25564 .cindex "envelope from"
25565 .cindex "envelope sender" "rewriting at transport time"
25566 .cindex "rewriting" "at transport time"
25567 .cindex "header lines" "rewriting at transport time"
25568 At transport time, additional rewriting of addresses in header lines can be
25569 specified by setting the generic &%headers_rewrite%& option on a transport.
25570 This option contains rules that are identical in form to those in the rewrite
25571 section of the configuration file. They are applied to the original message
25572 header lines and any that were added by ACLs or a system filter. They are not
25573 applied to header lines that are added by routers or the transport.
25574
25575 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25576 transport option. However, it is not possible to rewrite envelope recipients at
25577 transport time.
25578
25579
25580
25581
25582 .section "Testing the rewriting rules that apply on input" "SECID149"
25583 .cindex "rewriting" "testing"
25584 .cindex "testing" "rewriting"
25585 Exim's input rewriting configuration appears in a part of the runtime
25586 configuration file headed by &"begin rewrite"&. It can be tested by the
25587 &%-brw%& command line option. This takes an address (which can be a full RFC
25588 2822 address) as its argument. The output is a list of how the address would be
25589 transformed by the rewriting rules for each of the different places it might
25590 appear in an incoming message, that is, for each different header and for the
25591 envelope sender and recipient fields. For example,
25592 .code
25593 exim -brw ph10@exim.workshop.example
25594 .endd
25595 might produce the output
25596 .code
25597 sender: Philip.Hazel@exim.workshop.example
25598 from: Philip.Hazel@exim.workshop.example
25599 to: ph10@exim.workshop.example
25600 cc: ph10@exim.workshop.example
25601 bcc: ph10@exim.workshop.example
25602 reply-to: Philip.Hazel@exim.workshop.example
25603 env-from: Philip.Hazel@exim.workshop.example
25604 env-to: ph10@exim.workshop.example
25605 .endd
25606 which shows that rewriting has been set up for that address when used in any of
25607 the source fields, but not when it appears as a recipient address. At the
25608 present time, there is no equivalent way of testing rewriting rules that are
25609 set for a particular transport.
25610
25611
25612 .section "Rewriting rules" "SECID150"
25613 .cindex "rewriting" "rules"
25614 The rewrite section of the configuration file consists of lines of rewriting
25615 rules in the form
25616 .display
25617 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25618 .endd
25619 Rewriting rules that are specified for the &%headers_rewrite%& generic
25620 transport option are given as a colon-separated list. Each item in the list
25621 takes the same form as a line in the main rewriting configuration (except that
25622 any colons must be doubled, of course).
25623
25624 The formats of source patterns and replacement strings are described below.
25625 Each is terminated by white space, unless enclosed in double quotes, in which
25626 case normal quoting conventions apply inside the quotes. The flags are single
25627 characters which may appear in any order. Spaces and tabs between them are
25628 ignored.
25629
25630 For each address that could potentially be rewritten, the rules are scanned in
25631 order, and replacements for the address from earlier rules can themselves be
25632 replaced by later rules (but see the &"q"& and &"R"& flags).
25633
25634 The order in which addresses are rewritten is undefined, may change between
25635 releases, and must not be relied on, with one exception: when a message is
25636 received, the envelope sender is always rewritten first, before any header
25637 lines are rewritten. For example, the replacement string for a rewrite of an
25638 address in &'To:'& must not assume that the message's address in &'From:'& has
25639 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25640 that the envelope sender has already been rewritten.
25641
25642 .vindex "&$domain$&"
25643 .vindex "&$local_part$&"
25644 The variables &$local_part$& and &$domain$& can be used in the replacement
25645 string to refer to the address that is being rewritten. Note that lookup-driven
25646 rewriting can be done by a rule of the form
25647 .code
25648 *@*   ${lookup ...
25649 .endd
25650 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25651 refer to the address that is being rewritten.
25652
25653
25654 .section "Rewriting patterns" "SECID151"
25655 .cindex "rewriting" "patterns"
25656 .cindex "address list" "in a rewriting pattern"
25657 The source pattern in a rewriting rule is any item which may appear in an
25658 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25659 single-item address list, which means that it is expanded before being tested
25660 against the address. As always, if you use a regular expression as a pattern,
25661 you must take care to escape dollar and backslash characters, or use the &`\N`&
25662 facility to suppress string expansion within the regular expression.
25663
25664 Domains in patterns should be given in lower case. Local parts in patterns are
25665 case-sensitive. If you want to do case-insensitive matching of local parts, you
25666 can use a regular expression that starts with &`^(?i)`&.
25667
25668 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25669 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25670 depending on the type of match which occurred. These can be used in the
25671 replacement string to insert portions of the incoming address. &$0$& always
25672 refers to the complete incoming address. When a regular expression is used, the
25673 numerical variables are set from its capturing subexpressions. For other types
25674 of pattern they are set as follows:
25675
25676 .ilist
25677 If a local part or domain starts with an asterisk, the numerical variables
25678 refer to the character strings matched by asterisks, with &$1$& associated with
25679 the first asterisk, and &$2$& with the second, if present. For example, if the
25680 pattern
25681 .code
25682 *queen@*.fict.example
25683 .endd
25684 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25685 .code
25686 $0 = hearts-queen@wonderland.fict.example
25687 $1 = hearts-
25688 $2 = wonderland
25689 .endd
25690 Note that if the local part does not start with an asterisk, but the domain
25691 does, it is &$1$& that contains the wild part of the domain.
25692
25693 .next
25694 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25695 of the domain are placed in the next available numerical variables. Suppose,
25696 for example, that the address &'foo@bar.baz.example'& is processed by a
25697 rewriting rule of the form
25698 .display
25699 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25700 .endd
25701 and the key in the file that matches the domain is &`*.baz.example`&. Then
25702 .code
25703 $1 = foo
25704 $2 = bar
25705 $3 = baz.example
25706 .endd
25707 If the address &'foo@baz.example'& is looked up, this matches the same
25708 wildcard file entry, and in this case &$2$& is set to the empty string, but
25709 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25710 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25711 whole domain. For non-partial domain lookups, no numerical variables are set.
25712 .endlist
25713
25714
25715 .section "Rewriting replacements" "SECID152"
25716 .cindex "rewriting" "replacements"
25717 If the replacement string for a rule is a single asterisk, addresses that
25718 match the pattern and the flags are &'not'& rewritten, and no subsequent
25719 rewriting rules are scanned. For example,
25720 .code
25721 hatta@lookingglass.fict.example  *  f
25722 .endd
25723 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25724 &'From:'& headers.
25725
25726 .vindex "&$domain$&"
25727 .vindex "&$local_part$&"
25728 If the replacement string is not a single asterisk, it is expanded, and must
25729 yield a fully qualified address. Within the expansion, the variables
25730 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25731 Any letters they contain retain their original case &-- they are not lower
25732 cased. The numerical variables are set up according to the type of pattern that
25733 matched the address, as described above. If the expansion is forced to fail by
25734 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25735 current rule is abandoned, but subsequent rules may take effect. Any other
25736 expansion failure causes the entire rewriting operation to be abandoned, and an
25737 entry written to the panic log.
25738
25739
25740
25741 .section "Rewriting flags" "SECID153"
25742 There are three different kinds of flag that may appear on rewriting rules:
25743
25744 .ilist
25745 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25746 c, f, h, r, s, t.
25747 .next
25748 A flag that specifies rewriting at SMTP time: S.
25749 .next
25750 Flags that control the rewriting process: Q, q, R, w.
25751 .endlist
25752
25753 For rules that are part of the &%headers_rewrite%& generic transport option,
25754 E, F, T, and S are not permitted.
25755
25756
25757
25758 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25759          "SECID154"
25760 .cindex "rewriting" "flags"
25761 If none of the following flag letters, nor the &"S"& flag (see section
25762 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25763 and to both the sender and recipient fields of the envelope, whereas a
25764 transport-time rewriting rule just applies to all headers. Otherwise, the
25765 rewriting rule is skipped unless the relevant addresses are being processed.
25766 .display
25767 &`E`&       rewrite all envelope fields
25768 &`F`&       rewrite the envelope From field
25769 &`T`&       rewrite the envelope To field
25770 &`b`&       rewrite the &'Bcc:'& header
25771 &`c`&       rewrite the &'Cc:'& header
25772 &`f`&       rewrite the &'From:'& header
25773 &`h`&       rewrite all headers
25774 &`r`&       rewrite the &'Reply-To:'& header
25775 &`s`&       rewrite the &'Sender:'& header
25776 &`t`&       rewrite the &'To:'& header
25777 .endd
25778 "All headers" means all of the headers listed above that can be selected
25779 individually, plus their &'Resent-'& versions. It does not include
25780 other headers such as &'Subject:'& etc.
25781
25782 You should be particularly careful about rewriting &'Sender:'& headers, and
25783 restrict this to special known cases in your own domains.
25784
25785
25786 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25787 .cindex "SMTP" "rewriting malformed addresses"
25788 .cindex "RCPT" "rewriting argument of"
25789 .cindex "MAIL" "rewriting argument of"
25790 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25791 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25792 before any other processing; even before syntax checking. The pattern is
25793 required to be a regular expression, and it is matched against the whole of the
25794 data for the command, including any surrounding angle brackets.
25795
25796 .vindex "&$domain$&"
25797 .vindex "&$local_part$&"
25798 This form of rewrite rule allows for the handling of addresses that are not
25799 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25800 input). Because the input is not required to be a syntactically valid address,
25801 the variables &$local_part$& and &$domain$& are not available during the
25802 expansion of the replacement string. The result of rewriting replaces the
25803 original address in the MAIL or RCPT command.
25804
25805
25806 .section "Flags controlling the rewriting process" "SECID155"
25807 There are four flags which control the way the rewriting process works. These
25808 take effect only when a rule is invoked, that is, when the address is of the
25809 correct type (matches the flags) and matches the pattern:
25810
25811 .ilist
25812 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25813 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25814 absence of &"Q"& the rewritten address must always include a domain.
25815 .next
25816 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25817 even if no rewriting actually takes place because of a &"fail"& in the
25818 expansion. The &"q"& flag is not effective if the address is of the wrong type
25819 (does not match the flags) or does not match the pattern.
25820 .next
25821 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25822 address, up to ten times. It can be combined with the &"q"& flag, to stop
25823 rewriting once it fails to match (after at least one successful rewrite).
25824 .next
25825 .cindex "rewriting" "whole addresses"
25826 When an address in a header is rewritten, the rewriting normally applies only
25827 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25828 left unchanged. For example, rewriting might change
25829 .code
25830 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25831 .endd
25832 into
25833 .code
25834 From: Ford Prefect <prefectf@hitch.fict.example>
25835 .endd
25836 .cindex "RFC 2047"
25837 Sometimes there is a need to replace the whole address item, and this can be
25838 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25839 causes an address in a header line to be rewritten, the entire address is
25840 replaced, not just the working part. The replacement must be a complete RFC
25841 2822 address, including the angle brackets if necessary. If text outside angle
25842 brackets contains a character whose value is greater than 126 or less than 32
25843 (except for tab), the text is encoded according to RFC 2047. The character set
25844 is taken from &%headers_charset%&, which gets its default at build time.
25845
25846 When the &"w"& flag is set on a rule that causes an envelope address to be
25847 rewritten, all but the working part of the replacement address is discarded.
25848 .endlist
25849
25850
25851 .section "Rewriting examples" "SECID156"
25852 Here is an example of the two common rewriting paradigms:
25853 .code
25854 *@*.hitch.fict.example  $1@hitch.fict.example
25855 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25856                      {$value}fail}@hitch.fict.example bctfrF
25857 .endd
25858 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25859 the string expansion to fail if the lookup does not succeed. In this context it
25860 has the effect of leaving the original address unchanged, but Exim goes on to
25861 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25862 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25863 explicitly, which would cause the rewritten address to be the same as before,
25864 at the cost of a small bit of processing. Not supplying either of these is an
25865 error, since the rewritten address would then contain no local part.
25866
25867 The first example above replaces the domain with a superior, more general
25868 domain. This may not be desirable for certain local parts. If the rule
25869 .code
25870 root@*.hitch.fict.example  *
25871 .endd
25872 were inserted before the first rule, rewriting would be suppressed for the
25873 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25874
25875 Rewriting can be made conditional on a number of tests, by making use of
25876 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25877 messages that originate outside the local host:
25878 .code
25879 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25880                          {$1@hitch.fict.example}fail}"
25881 .endd
25882 The replacement string is quoted in this example because it contains white
25883 space.
25884
25885 .cindex "rewriting" "bang paths"
25886 .cindex "bang paths" "rewriting"
25887 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25888 an address it treats it as an unqualified local part which it qualifies with
25889 the local qualification domain (if the source of the message is local or if the
25890 remote host is permitted to send unqualified addresses). Rewriting can
25891 sometimes be used to handle simple bang paths with a fixed number of
25892 components. For example, the rule
25893 .code
25894 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25895 .endd
25896 rewrites a two-component bang path &'host.name!user'& as the domain address
25897 &'user@host.name'&. However, there is a security implication in using this as
25898 a global rewriting rule for envelope addresses. It can provide a backdoor
25899 method for using your system as a relay, because the incoming addresses appear
25900 to be local. If the bang path addresses are received via SMTP, it is safer to
25901 use the &"S"& flag to rewrite them as they are received, so that relay checking
25902 can be done on the rewritten addresses.
25903 .ecindex IIDaddrew
25904
25905
25906
25907
25908
25909 . ////////////////////////////////////////////////////////////////////////////
25910 . ////////////////////////////////////////////////////////////////////////////
25911
25912 .chapter "Retry configuration" "CHAPretry"
25913 .scindex IIDretconf1 "retry" "configuration, description of"
25914 .scindex IIDregconf2 "configuration file" "retry section"
25915 The &"retry"& section of the runtime configuration file contains a list of
25916 retry rules that control how often Exim tries to deliver messages that cannot
25917 be delivered at the first attempt. If there are no retry rules (the section is
25918 empty or not present), there are no retries. In this situation, temporary
25919 errors are treated as permanent. The default configuration contains a single,
25920 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25921 line option can be used to test which retry rule will be used for a given
25922 address, domain and error.
25923
25924 The most common cause of retries is temporary failure to deliver to a remote
25925 host because the host is down, or inaccessible because of a network problem.
25926 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25927 address) basis, not on a per-message basis. Thus, if one message has recently
25928 been delayed, delivery of a new message to the same host is not immediately
25929 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25930 log selector is set, the message
25931 .cindex "retry" "time not reached"
25932 &"retry time not reached"& is written to the main log whenever a delivery is
25933 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25934 the handling of errors during remote deliveries.
25935
25936 Retry processing applies to routing as well as to delivering, except as covered
25937 in the next paragraph. The retry rules do not distinguish between these
25938 actions. It is not possible, for example, to specify different behaviour for
25939 failures to route the domain &'snark.fict.example'& and failures to deliver to
25940 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25941 added complication, so did not implement it. However, although they share the
25942 same retry rule, the actual retry times for routing and transporting a given
25943 domain are maintained independently.
25944
25945 When a delivery is not part of a queue run (typically an immediate delivery on
25946 receipt of a message), the routers are always run, and local deliveries are
25947 always attempted, even if retry times are set for them. This makes for better
25948 behaviour if one particular message is causing problems (for example, causing
25949 quota overflow, or provoking an error in a filter file). If such a delivery
25950 suffers a temporary failure, the retry data is updated as normal, and
25951 subsequent delivery attempts from queue runs occur only when the retry time for
25952 the local address is reached.
25953
25954 .section "Changing retry rules" "SECID157"
25955 If you change the retry rules in your configuration, you should consider
25956 whether or not to delete the retry data that is stored in Exim's spool area in
25957 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25958 always safe; that is why they are called &"hints"&.
25959
25960 The hints retry data contains suggested retry times based on the previous
25961 rules. In the case of a long-running problem with a remote host, it might
25962 record the fact that the host has timed out. If your new rules increase the
25963 timeout time for such a host, you should definitely remove the old retry data
25964 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25965 messages that it should now be retaining.
25966
25967
25968
25969 .section "Format of retry rules" "SECID158"
25970 .cindex "retry" "rules"
25971 Each retry rule occupies one line and consists of three or four parts,
25972 separated by white space: a pattern, an error name, an optional list of sender
25973 addresses, and a list of retry parameters. The pattern and sender lists must be
25974 enclosed in double quotes if they contain white space. The rules are searched
25975 in order until one is found where the pattern, error name, and sender list (if
25976 present) match the failing host or address, the error that occurred, and the
25977 message's sender, respectively.
25978
25979
25980 The pattern is any single item that may appear in an address list (see section
25981 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25982 which means that it is expanded before being tested against the address that
25983 has been delayed. A negated address list item is permitted. Address
25984 list processing treats a plain domain name as if it were preceded by &"*@"&,
25985 which makes it possible for many retry rules to start with just a domain. For
25986 example,
25987 .code
25988 lookingglass.fict.example        *  F,24h,30m;
25989 .endd
25990 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25991 whereas
25992 .code
25993 alice@lookingglass.fict.example  *  F,24h,30m;
25994 .endd
25995 applies only to temporary failures involving the local part &%alice%&.
25996 In practice, almost all rules start with a domain name pattern without a local
25997 part.
25998
25999 .cindex "regular expressions" "in retry rules"
26000 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26001 must match a complete address, not just a domain, because that is how regular
26002 expressions work in address lists.
26003 .display
26004 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26005 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26006 .endd
26007
26008
26009 .section "Choosing which retry rule to use for address errors" "SECID159"
26010 When Exim is looking for a retry rule after a routing attempt has failed (for
26011 example, after a DNS timeout), each line in the retry configuration is tested
26012 against the complete address only if &%retry_use_local_part%& is set for the
26013 router. Otherwise, only the domain is used, except when matching against a
26014 regular expression, when the local part of the address is replaced with &"*"&.
26015 A domain on its own can match a domain pattern, or a pattern that starts with
26016 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26017 &%check_local_user%& is true, and false for other routers.
26018
26019 Similarly, when Exim is looking for a retry rule after a local delivery has
26020 failed (for example, after a mailbox full error), each line in the retry
26021 configuration is tested against the complete address only if
26022 &%retry_use_local_part%& is set for the transport (it defaults true for all
26023 local transports).
26024
26025 .cindex "4&'xx'& responses" "retry rules for"
26026 However, when Exim is looking for a retry rule after a remote delivery attempt
26027 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26028 whole address is always used as the key when searching the retry rules. The
26029 rule that is found is used to create a retry time for the combination of the
26030 failing address and the message's sender. It is the combination of sender and
26031 recipient that is delayed in subsequent queue runs until its retry time is
26032 reached. You can delay the recipient without regard to the sender by setting
26033 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26034 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26035 commands.
26036
26037
26038
26039 .section "Choosing which retry rule to use for host and message errors" &&&
26040          "SECID160"
26041 For a temporary error that is not related to an individual address (for
26042 example, a connection timeout), each line in the retry configuration is checked
26043 twice. First, the name of the remote host is used as a domain name (preceded by
26044 &"*@"& when matching a regular expression). If this does not match the line,
26045 the domain from the email address is tried in a similar fashion. For example,
26046 suppose the MX records for &'a.b.c.example'& are
26047 .code
26048 a.b.c.example  MX  5  x.y.z.example
26049                MX  6  p.q.r.example
26050                MX  7  m.n.o.example
26051 .endd
26052 and the retry rules are
26053 .code
26054 p.q.r.example    *      F,24h,30m;
26055 a.b.c.example    *      F,4d,45m;
26056 .endd
26057 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26058 first rule matches neither the host nor the domain, so Exim looks at the second
26059 rule. This does not match the host, but it does match the domain, so it is used
26060 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26061 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26062 first retry rule is used, because it matches the host.
26063
26064 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26065 first rule to determine retry times, but for all the other hosts for the domain
26066 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26067 routing to &'a.b.c.example'& suffers a temporary failure.
26068
26069 &*Note*&: The host name is used when matching the patterns, not its IP address.
26070 However, if a message is routed directly to an IP address without the use of a
26071 host name, for example, if a &(manualroute)& router contains a setting such as:
26072 .code
26073 route_list = *.a.example  192.168.34.23
26074 .endd
26075 then the &"host name"& that is used when searching for a retry rule is the
26076 textual form of the IP address.
26077
26078 .section "Retry rules for specific errors" "SECID161"
26079 .cindex "retry" "specific errors; specifying"
26080 The second field in a retry rule is the name of a particular error, or an
26081 asterisk, which matches any error. The errors that can be tested for are:
26082
26083 .vlist
26084 .vitem &%auth_failed%&
26085 Authentication failed when trying to send to a host in the
26086 &%hosts_require_auth%& list in an &(smtp)& transport.
26087
26088 .vitem &%data_4xx%&
26089 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26090 after the command, or after sending the message's data.
26091
26092 .vitem &%mail_4xx%&
26093 A 4&'xx'& error was received for an outgoing MAIL command.
26094
26095 .vitem &%rcpt_4xx%&
26096 A 4&'xx'& error was received for an outgoing RCPT command.
26097 .endlist
26098
26099 For the three 4&'xx'& errors, either the first or both of the x's can be given
26100 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26101 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26102 and have retries every ten minutes with a one-hour timeout, you could set up a
26103 retry rule of this form:
26104 .code
26105 the.domain.name  rcpt_452   F,1h,10m
26106 .endd
26107 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26108 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26109
26110 .vlist
26111 .vitem &%lost_connection%&
26112 A server unexpectedly closed the SMTP connection. There may, of course,
26113 legitimate reasons for this (host died, network died), but if it repeats a lot
26114 for the same host, it indicates something odd.
26115
26116 .vitem &%lookup%&
26117 A DNS lookup for a host failed.
26118 Note that a &%dnslookup%& router will need to have matched
26119 its &%fail_defer_domains%& option for this retry type to be usable.
26120 Also note that a &%manualroute%& router will probably need
26121 its &%host_find_failed%& option set to &%defer%&.
26122
26123 .vitem &%refused_MX%&
26124 A connection to a host obtained from an MX record was refused.
26125
26126 .vitem &%refused_A%&
26127 A connection to a host not obtained from an MX record was refused.
26128
26129 .vitem &%refused%&
26130 A connection was refused.
26131
26132 .vitem &%timeout_connect_MX%&
26133 A connection attempt to a host obtained from an MX record timed out.
26134
26135 .vitem &%timeout_connect_A%&
26136 A connection attempt to a host not obtained from an MX record timed out.
26137
26138 .vitem &%timeout_connect%&
26139 A connection attempt timed out.
26140
26141 .vitem &%timeout_MX%&
26142 There was a timeout while connecting or during an SMTP session with a host
26143 obtained from an MX record.
26144
26145 .vitem &%timeout_A%&
26146 There was a timeout while connecting or during an SMTP session with a host not
26147 obtained from an MX record.
26148
26149 .vitem &%timeout%&
26150 There was a timeout while connecting or during an SMTP session.
26151
26152 .vitem &%tls_required%&
26153 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26154 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26155 to STARTTLS, or there was a problem setting up the TLS connection.
26156
26157 .vitem &%quota%&
26158 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26159 transport.
26160
26161 .vitem &%quota_%&<&'time'&>
26162 .cindex "quota" "error testing in retry rule"
26163 .cindex "retry" "quota error testing"
26164 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26165 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26166 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26167 for four days.
26168 .endlist
26169
26170 .cindex "mailbox" "time of last read"
26171 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26172 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26173 it should be based on the last time that the user accessed the mailbox.
26174 However, it is not always possible to determine this. Exim uses the following
26175 heuristic rules:
26176
26177 .ilist
26178 If the mailbox is a single file, the time of last access (the &"atime"&) is
26179 used. As no new messages are being delivered (because the mailbox is over
26180 quota), Exim does not access the file, so this is the time of last user access.
26181 .next
26182 .cindex "maildir format" "time of last read"
26183 For a maildir delivery, the time of last modification of the &_new_&
26184 subdirectory is used. As the mailbox is over quota, no new files are created in
26185 the &_new_& subdirectory, because no new messages are being delivered. Any
26186 change to the &_new_& subdirectory is therefore assumed to be the result of an
26187 MUA moving a new message to the &_cur_& directory when it is first read. The
26188 time that is used is therefore the last time that the user read a new message.
26189 .next
26190 For other kinds of multi-file mailbox, the time of last access cannot be
26191 obtained, so a retry rule that uses this type of error field is never matched.
26192 .endlist
26193
26194 The quota errors apply both to system-enforced quotas and to Exim's own quota
26195 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26196 when a local delivery is deferred because a partition is full (the ENOSPC
26197 error).
26198
26199
26200
26201 .section "Retry rules for specified senders" "SECID162"
26202 .cindex "retry" "rules; sender-specific"
26203 You can specify retry rules that apply only when the failing message has a
26204 specific sender. In particular, this can be used to define retry rules that
26205 apply only to bounce messages. The third item in a retry rule can be of this
26206 form:
26207 .display
26208 &`senders=`&<&'address list'&>
26209 .endd
26210 The retry timings themselves are then the fourth item. For example:
26211 .code
26212 *   rcpt_4xx   senders=:   F,1h,30m
26213 .endd
26214 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26215 host. If the address list contains white space, it must be enclosed in quotes.
26216 For example:
26217 .code
26218 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26219 .endd
26220 &*Warning*&: This facility can be unhelpful if it is used for host errors
26221 (which do not depend on the recipient). The reason is that the sender is used
26222 only to match the retry rule. Once the rule has been found for a host error,
26223 its contents are used to set a retry time for the host, and this will apply to
26224 all messages, not just those with specific senders.
26225
26226 When testing retry rules using &%-brt%&, you can supply a sender using the
26227 &%-f%& command line option, like this:
26228 .code
26229 exim -f "" -brt user@dom.ain
26230 .endd
26231 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26232 list is never matched.
26233
26234
26235
26236
26237
26238 .section "Retry parameters" "SECID163"
26239 .cindex "retry" "parameters in rules"
26240 The third (or fourth, if a senders list is present) field in a retry rule is a
26241 sequence of retry parameter sets, separated by semicolons. Each set consists of
26242 .display
26243 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26244 .endd
26245 The letter identifies the algorithm for computing a new retry time; the cutoff
26246 time is the time beyond which this algorithm no longer applies, and the
26247 arguments vary the algorithm's action. The cutoff time is measured from the
26248 time that the first failure for the domain (combined with the local part if
26249 relevant) was detected, not from the time the message was received.
26250
26251 .cindex "retry" "algorithms"
26252 .cindex "retry" "fixed intervals"
26253 .cindex "retry" "increasing intervals"
26254 .cindex "retry" "random intervals"
26255 The available algorithms are:
26256
26257 .ilist
26258 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26259 the interval.
26260 .next
26261 &'G'&: retry at geometrically increasing intervals. The first argument
26262 specifies a starting value for the interval, and the second a multiplier, which
26263 is used to increase the size of the interval at each retry.
26264 .next
26265 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26266 retry, the previous interval is multiplied by the factor in order to get a
26267 maximum for the next interval. The minimum interval is the first argument of
26268 the parameter, and an actual interval is chosen randomly between them. Such a
26269 rule has been found to be helpful in cluster configurations when all the
26270 members of the cluster restart at once, and may therefore synchronize their
26271 queue processing times.
26272 .endlist
26273
26274 When computing the next retry time, the algorithm definitions are scanned in
26275 order until one whose cutoff time has not yet passed is reached. This is then
26276 used to compute a new retry time that is later than the current time. In the
26277 case of fixed interval retries, this simply means adding the interval to the
26278 current time. For geometrically increasing intervals, retry intervals are
26279 computed from the rule's parameters until one that is greater than the previous
26280 interval is found. The main configuration variable
26281 .cindex "limit" "retry interval"
26282 .cindex "retry" "interval, maximum"
26283 .oindex "&%retry_interval_max%&"
26284 &%retry_interval_max%& limits the maximum interval between retries. It
26285 cannot be set greater than &`24h`&, which is its default value.
26286
26287 A single remote domain may have a number of hosts associated with it, and each
26288 host may have more than one IP address. Retry algorithms are selected on the
26289 basis of the domain name, but are applied to each IP address independently. If,
26290 for example, a host has two IP addresses and one is unusable, Exim will
26291 generate retry times for it and will not try to use it until its next retry
26292 time comes. Thus the good IP address is likely to be tried first most of the
26293 time.
26294
26295 .cindex "hints database" "use for retrying"
26296 Retry times are hints rather than promises. Exim does not make any attempt to
26297 run deliveries exactly at the computed times. Instead, a queue runner process
26298 starts delivery processes for delayed messages periodically, and these attempt
26299 new deliveries only for those addresses that have passed their next retry time.
26300 If a new message arrives for a deferred address, an immediate delivery attempt
26301 occurs only if the address has passed its retry time. In the absence of new
26302 messages, the minimum time between retries is the interval between queue runner
26303 processes. There is not much point in setting retry times of five minutes if
26304 your queue runners happen only once an hour, unless there are a significant
26305 number of incoming messages (which might be the case on a system that is
26306 sending everything to a smart host, for example).
26307
26308 The data in the retry hints database can be inspected by using the
26309 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26310 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26311 &'exinext'& utility script can be used to find out what the next retry times
26312 are for the hosts associated with a particular mail domain, and also for local
26313 deliveries that have been deferred.
26314
26315
26316 .section "Retry rule examples" "SECID164"
26317 Here are some example retry rules:
26318 .code
26319 alice@wonderland.fict.example quota_5d  F,7d,3h
26320 wonderland.fict.example       quota_5d
26321 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26322 lookingglass.fict.example     *         F,24h,30m;
26323 *                 refused_A   F,2h,20m;
26324 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26325 .endd
26326 The first rule sets up special handling for mail to
26327 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26328 mailbox has not been read for at least 5 days. Retries continue every three
26329 hours for 7 days. The second rule handles over-quota errors for all other local
26330 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26331 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26332 fail are bounced immediately if the mailbox has not been read for at least 5
26333 days.
26334
26335 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26336 happen every 15 minutes for an hour, then with geometrically increasing
26337 intervals until two days have passed since a delivery first failed. After the
26338 first hour there is a delay of one hour, then two hours, then four hours, and
26339 so on (this is a rather extreme example).
26340
26341 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26342 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26343 all other domains, with special action for connection refusal from hosts that
26344 were not obtained from an MX record.
26345
26346 The final rule in a retry configuration should always have asterisks in the
26347 first two fields so as to provide a general catch-all for any addresses that do
26348 not have their own special handling. This example tries every 15 minutes for 2
26349 hours, then with intervals starting at one hour and increasing by a factor of
26350 1.5 up to 16 hours, then every 8 hours up to 5 days.
26351
26352
26353
26354 .section "Timeout of retry data" "SECID165"
26355 .cindex "timeout" "of retry data"
26356 .oindex "&%retry_data_expire%&"
26357 .cindex "hints database" "data expiry"
26358 .cindex "retry" "timeout of data"
26359 Exim timestamps the data that it writes to its retry hints database. When it
26360 consults the data during a delivery it ignores any that is older than the value
26361 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26362 been tried for 7 days, Exim will try to deliver to it immediately a message
26363 arrives, and if that fails, it will calculate a retry time as if it were
26364 failing for the first time.
26365
26366 This improves the behaviour for messages routed to rarely-used hosts such as MX
26367 backups. If such a host was down at one time, and happens to be down again when
26368 Exim tries a month later, using the old retry data would imply that it had been
26369 down all the time, which is not a justified assumption.
26370
26371 If a host really is permanently dead, this behaviour causes a burst of retries
26372 every now and again, but only if messages routed to it are rare. If there is a
26373 message at least once every 7 days the retry data never expires.
26374
26375
26376
26377
26378 .section "Long-term failures" "SECID166"
26379 .cindex "delivery failure, long-term"
26380 .cindex "retry" "after long-term failure"
26381 Special processing happens when an email address has been failing for so long
26382 that the cutoff time for the last algorithm is reached. For example, using the
26383 default retry rule:
26384 .code
26385 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26386 .endd
26387 the cutoff time is four days. Reaching the retry cutoff is independent of how
26388 long any specific message has been failing; it is the length of continuous
26389 failure for the recipient address that counts.
26390
26391 When the cutoff time is reached for a local delivery, or for all the IP
26392 addresses associated with a remote delivery, a subsequent delivery failure
26393 causes Exim to give up on the address, and a bounce message is generated.
26394 In order to cater for new messages that use the failing address, a next retry
26395 time is still computed from the final algorithm, and is used as follows:
26396
26397 For local deliveries, one delivery attempt is always made for any subsequent
26398 messages. If this delivery fails, the address fails immediately. The
26399 post-cutoff retry time is not used.
26400
26401 .cindex "final cutoff" "retries, controlling"
26402 .cindex retry "final cutoff"
26403 If the delivery is remote, there are two possibilities, controlled by the
26404 .oindex "&%delay_after_cutoff%&"
26405 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26406 default. Until the post-cutoff retry time for one of the IP addresses,
26407 as set by the &%retry_data_expire%& option, is
26408 reached, the failing email address is bounced immediately, without a delivery
26409 attempt taking place. After that time, one new delivery attempt is made to
26410 those IP addresses that are past their retry times, and if that still fails,
26411 the address is bounced and new retry times are computed.
26412
26413 In other words, when all the hosts for a given email address have been failing
26414 for a long time, Exim bounces rather then defers until one of the hosts' retry
26415 times is reached. Then it tries once, and bounces if that attempt fails. This
26416 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26417 to a broken destination, but if the host does recover, Exim will eventually
26418 notice.
26419
26420 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26421 addresses are past their final cutoff time, Exim tries to deliver to those IP
26422 addresses that have not been tried since the message arrived. If there are
26423 no suitable IP addresses, or if they all fail, the address is bounced. In other
26424 words, it does not delay when a new message arrives, but tries the expired
26425 addresses immediately, unless they have been tried since the message arrived.
26426 If there is a continuous stream of messages for the failing domains, setting
26427 &%delay_after_cutoff%& false means that there will be many more attempts to
26428 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26429 true.
26430
26431 .section "Deliveries that work intermittently" "SECID167"
26432 .cindex "retry" "intermittently working deliveries"
26433 Some additional logic is needed to cope with cases where a host is
26434 intermittently available, or when a message has some attribute that prevents
26435 its delivery when others to the same address get through. In this situation,
26436 because some messages are successfully delivered, the &"retry clock"& for the
26437 host or address keeps getting reset by the successful deliveries, and so
26438 failing messages remain in the queue for ever because the cutoff time is never
26439 reached.
26440
26441 Two exceptional actions are applied to prevent this happening. The first
26442 applies to errors that are related to a message rather than a remote host.
26443 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26444 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26445 commands, and quota failures. For this type of error, if a message's arrival
26446 time is earlier than the &"first failed"& time for the error, the earlier time
26447 is used when scanning the retry rules to decide when to try next and when to
26448 time out the address.
26449
26450 The exceptional second action applies in all cases. If a message has been on
26451 the queue for longer than the cutoff time of any applicable retry rule for a
26452 given address, a delivery is attempted for that address, even if it is not yet
26453 time, and if this delivery fails, the address is timed out. A new retry time is
26454 not computed in this case, so that other messages for the same address are
26455 considered immediately.
26456 .ecindex IIDretconf1
26457 .ecindex IIDregconf2
26458
26459
26460
26461
26462
26463
26464 . ////////////////////////////////////////////////////////////////////////////
26465 . ////////////////////////////////////////////////////////////////////////////
26466
26467 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26468 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26469 .scindex IIDauthconf2 "authentication"
26470 The &"authenticators"& section of Exim's runtime configuration is concerned
26471 with SMTP authentication. This facility is an extension to the SMTP protocol,
26472 described in RFC 2554, which allows a client SMTP host to authenticate itself
26473 to a server. This is a common way for a server to recognize clients that are
26474 permitted to use it as a relay. SMTP authentication is not of relevance to the
26475 transfer of mail between servers that have no managerial connection with each
26476 other.
26477
26478 .cindex "AUTH" "description of"
26479 Very briefly, the way SMTP authentication works is as follows:
26480
26481 .ilist
26482 The server advertises a number of authentication &'mechanisms'& in response to
26483 the client's EHLO command.
26484 .next
26485 The client issues an AUTH command, naming a specific mechanism. The command
26486 may, optionally, contain some authentication data.
26487 .next
26488 The server may issue one or more &'challenges'&, to which the client must send
26489 appropriate responses. In simple authentication mechanisms, the challenges are
26490 just prompts for user names and passwords. The server does not have to issue
26491 any challenges &-- in some mechanisms the relevant data may all be transmitted
26492 with the AUTH command.
26493 .next
26494 The server either accepts or denies authentication.
26495 .next
26496 If authentication succeeds, the client may optionally make use of the AUTH
26497 option on the MAIL command to pass an authenticated sender in subsequent
26498 mail transactions. Authentication lasts for the remainder of the SMTP
26499 connection.
26500 .next
26501 If authentication fails, the client may give up, or it may try a different
26502 authentication mechanism, or it may try transferring mail over the
26503 unauthenticated connection.
26504 .endlist
26505
26506 If you are setting up a client, and want to know which authentication
26507 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26508 SMTP port) on the server, and issue an EHLO command. The response to this
26509 includes the list of supported mechanisms. For example:
26510 .display
26511 &`$ `&&*&`telnet server.example 25`&*&
26512 &`Trying 192.168.34.25...`&
26513 &`Connected to server.example.`&
26514 &`Escape character is &#x0027;^]&#x0027;.`&
26515 &`220 server.example ESMTP Exim 4.20 ...`&
26516 &*&`ehlo client.example`&*&
26517 &`250-server.example Hello client.example [10.8.4.5]`&
26518 &`250-SIZE 52428800`&
26519 &`250-PIPELINING`&
26520 &`250-AUTH PLAIN`&
26521 &`250 HELP`&
26522 .endd
26523 The second-last line of this example output shows that the server supports
26524 authentication using the PLAIN mechanism. In Exim, the different authentication
26525 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26526 routers and transports, which authenticators are included in the binary is
26527 controlled by build-time definitions. The following are currently available,
26528 included by setting
26529 .code
26530 AUTH_CRAM_MD5=yes
26531 AUTH_CYRUS_SASL=yes
26532 AUTH_DOVECOT=yes
26533 AUTH_EXTERNAL=yes
26534 AUTH_GSASL=yes
26535 AUTH_HEIMDAL_GSSAPI=yes
26536 AUTH_PLAINTEXT=yes
26537 AUTH_SPA=yes
26538 AUTH_TLS=yes
26539 .endd
26540 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26541 authentication mechanism (RFC 2195), and the second provides an interface to
26542 the Cyrus SASL authentication library.
26543 The third is an interface to Dovecot's authentication system, delegating the
26544 work via a socket interface.
26545 The fourth provides for negotiation of authentication done via non-SMTP means,
26546 as defined by RFC 4422 Appendix A.
26547 The fifth provides an interface to the GNU SASL authentication library, which
26548 provides mechanisms but typically not data sources.
26549 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26550 supporting setting a server keytab.
26551 The seventh can be configured to support
26552 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26553 not formally documented, but used by several MUAs.
26554 The eighth authenticator
26555 supports Microsoft's &'Secure Password Authentication'& mechanism.
26556 The last is an Exim authenticator but not an SMTP one;
26557 instead it can use information from a TLS negotiation.
26558
26559 The authenticators are configured using the same syntax as other drivers (see
26560 section &<<SECTfordricon>>&). If no authenticators are required, no
26561 authentication section need be present in the configuration file. Each
26562 authenticator can in principle have both server and client functions. When Exim
26563 is receiving SMTP mail, it is acting as a server; when it is sending out
26564 messages over SMTP, it is acting as a client. Authenticator configuration
26565 options are provided for use in both these circumstances.
26566
26567 To make it clear which options apply to which situation, the prefixes
26568 &%server_%& and &%client_%& are used on option names that are specific to
26569 either the server or the client function, respectively. Server and client
26570 functions are disabled if none of their options are set. If an authenticator is
26571 to be used for both server and client functions, a single definition, using
26572 both sets of options, is required. For example:
26573 .code
26574 cram:
26575   driver = cram_md5
26576   public_name = CRAM-MD5
26577   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26578   client_name = ph10
26579   client_secret = secret2
26580 .endd
26581 The &%server_%& option is used when Exim is acting as a server, and the
26582 &%client_%& options when it is acting as a client.
26583
26584 Descriptions of the individual authenticators are given in subsequent chapters.
26585 The remainder of this chapter covers the generic options for the
26586 authenticators, followed by general discussion of the way authentication works
26587 in Exim.
26588
26589 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26590 per-mechanism basis.  Please read carefully to determine which variables hold
26591 account labels such as usercodes and which hold passwords or other
26592 authenticating data.
26593
26594 Note that some mechanisms support two different identifiers for accounts: the
26595 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26596 and &'authz'& are commonly encountered.  The American spelling is standard here.
26597 Conceptually, authentication data such as passwords are tied to the identifier
26598 used to authenticate; servers may have rules to permit one user to act as a
26599 second user, so that after login the session is treated as though that second
26600 user had logged in.  That second user is the &'authorization id'&.  A robust
26601 configuration might confirm that the &'authz'& field is empty or matches the
26602 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26603 as verified data, the &'authz'& as an unverified request which the server might
26604 choose to honour.
26605
26606 A &'realm'& is a text string, typically a domain name, presented by a server
26607 to a client to help it select an account and credentials to use.  In some
26608 mechanisms, the client and server provably agree on the realm, but clients
26609 typically can not treat the realm as secure data to be blindly trusted.
26610
26611
26612
26613 .section "Generic options for authenticators" "SECID168"
26614 .cindex "authentication" "generic options"
26615 .cindex "options" "generic; for authenticators"
26616
26617 .option client_condition authenticators string&!! unset
26618 When Exim is authenticating as a client, it skips any authenticator whose
26619 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26620 used, for example, to skip plain text authenticators when the connection is not
26621 encrypted by a setting such as:
26622 .code
26623 client_condition = ${if !eq{$tls_out_cipher}{}}
26624 .endd
26625
26626
26627 .option client_set_id authenticators string&!! unset
26628 When client authentication succeeds, this condition is expanded; the
26629 result is used in the log lines for outbound messages.
26630 Typically it will be the user name used for authentication.
26631
26632
26633 .option driver authenticators string unset
26634 This option must always be set. It specifies which of the available
26635 authenticators is to be used.
26636
26637
26638 .option public_name authenticators string unset
26639 This option specifies the name of the authentication mechanism that the driver
26640 implements, and by which it is known to the outside world. These names should
26641 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26642 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26643 defaults to the driver's instance name.
26644
26645
26646 .option server_advertise_condition authenticators string&!! unset
26647 When a server is about to advertise an authentication mechanism, the condition
26648 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26649 mechanism is not advertised.
26650 If the expansion fails, the mechanism is not advertised. If the failure was not
26651 forced, and was not caused by a lookup defer, the incident is logged.
26652 See section &<<SECTauthexiser>>& below for further discussion.
26653
26654
26655 .option server_condition authenticators string&!! unset
26656 This option must be set for a &%plaintext%& server authenticator, where it
26657 is used directly to control authentication. See section &<<SECTplainserver>>&
26658 for details.
26659
26660 For the &(gsasl)& authenticator, this option is required for various
26661 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26662
26663 For the other authenticators, &%server_condition%& can be used as an additional
26664 authentication or authorization mechanism that is applied after the other
26665 authenticator conditions succeed. If it is set, it is expanded when the
26666 authenticator would otherwise return a success code. If the expansion is forced
26667 to fail, authentication fails. Any other expansion failure causes a temporary
26668 error code to be returned. If the result of a successful expansion is an empty
26669 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26670 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26671 other result, a temporary error code is returned, with the expanded string as
26672 the error text.
26673
26674
26675 .option server_debug_print authenticators string&!! unset
26676 If this option is set and authentication debugging is enabled (see the &%-d%&
26677 command line option), the string is expanded and included in the debugging
26678 output when the authenticator is run as a server. This can help with checking
26679 out the values of variables.
26680 If expansion of the string fails, the error message is written to the debugging
26681 output, and Exim carries on processing.
26682
26683
26684 .option server_set_id authenticators string&!! unset
26685 .vindex "&$authenticated_id$&"
26686 .vindex "&$authenticated_fail_id$&"
26687 When an Exim server successfully authenticates a client, this string is
26688 expanded using data from the authentication, and preserved for any incoming
26689 messages in the variable &$authenticated_id$&. It is also included in the log
26690 lines for incoming messages. For example, a user/password authenticator
26691 configuration might preserve the user name that was used to authenticate, and
26692 refer to it subsequently during delivery of the message.
26693 On a failing authentication the expansion result is instead saved in
26694 the &$authenticated_fail_id$& variable.
26695 If expansion fails, the option is ignored.
26696
26697
26698 .option server_mail_auth_condition authenticators string&!! unset
26699 This option allows a server to discard authenticated sender addresses supplied
26700 as part of MAIL commands in SMTP connections that are authenticated by the
26701 driver on which &%server_mail_auth_condition%& is set. The option is not used
26702 as part of the authentication process; instead its (unexpanded) value is
26703 remembered for later use.
26704 How it is used is described in the following section.
26705
26706
26707
26708
26709
26710 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26711 .cindex "authentication" "sender; authenticated"
26712 .cindex "AUTH" "on MAIL command"
26713 When a client supplied an AUTH= item on a MAIL command, Exim applies
26714 the following checks before accepting it as the authenticated sender of the
26715 message:
26716
26717 .ilist
26718 If the connection is not using extended SMTP (that is, HELO was used rather
26719 than EHLO), the use of AUTH= is a syntax error.
26720 .next
26721 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26722 .next
26723 .vindex "&$authenticated_sender$&"
26724 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26725 running, the value of &$authenticated_sender$& is set to the value obtained
26726 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26727 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26728 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26729 given for the MAIL command.
26730 .next
26731 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26732 is accepted and placed in &$authenticated_sender$& only if the client has
26733 authenticated.
26734 .next
26735 If the AUTH= value was accepted by either of the two previous rules, and
26736 the client has authenticated, and the authenticator has a setting for the
26737 &%server_mail_auth_condition%&, the condition is checked at this point. The
26738 valued that was saved from the authenticator is expanded. If the expansion
26739 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26740 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26741 the value of &$authenticated_sender$& is retained and passed on with the
26742 message.
26743 .endlist
26744
26745
26746 When &$authenticated_sender$& is set for a message, it is passed on to other
26747 hosts to which Exim authenticates as a client. Do not confuse this value with
26748 &$authenticated_id$&, which is a string obtained from the authentication
26749 process, and which is not usually a complete email address.
26750
26751 .vindex "&$sender_address$&"
26752 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26753 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26754 therefore make use of &$authenticated_sender$&. The converse is not true: the
26755 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26756 ACL is run.
26757
26758
26759
26760 .section "Authentication on an Exim server" "SECTauthexiser"
26761 .cindex "authentication" "on an Exim server"
26762 When Exim receives an EHLO command, it advertises the public names of those
26763 authenticators that are configured as servers, subject to the following
26764 conditions:
26765
26766 .ilist
26767 The client host must match &%auth_advertise_hosts%& (default *).
26768 .next
26769 It the &%server_advertise_condition%& option is set, its expansion must not
26770 yield the empty string, &"0"&, &"no"&, or &"false"&.
26771 .endlist
26772
26773 The order in which the authenticators are defined controls the order in which
26774 the mechanisms are advertised.
26775
26776 Some mail clients (for example, some versions of Netscape) require the user to
26777 provide a name and password for authentication whenever AUTH is advertised,
26778 even though authentication may not in fact be needed (for example, Exim may be
26779 set up to allow unconditional relaying from the client by an IP address check).
26780 You can make such clients more friendly by not advertising AUTH to them.
26781 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26782 that runs for RCPT) to relay without authentication, you should set
26783 .code
26784 auth_advertise_hosts = ! 10.9.8.0/24
26785 .endd
26786 so that no authentication mechanisms are advertised to them.
26787
26788 The &%server_advertise_condition%& controls the advertisement of individual
26789 authentication mechanisms. For example, it can be used to restrict the
26790 advertisement of a particular mechanism to encrypted connections, by a setting
26791 such as:
26792 .code
26793 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26794 .endd
26795 .vindex "&$tls_in_cipher$&"
26796 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26797 yields &"yes"&, which allows the advertisement to happen.
26798
26799 When an Exim server receives an AUTH command from a client, it rejects it
26800 immediately if AUTH was not advertised in response to an earlier EHLO
26801 command. This is the case if
26802
26803 .ilist
26804 The client host does not match &%auth_advertise_hosts%&; or
26805 .next
26806 No authenticators are configured with server options; or
26807 .next
26808 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26809 server authenticators.
26810 .endlist
26811
26812
26813 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26814 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26815 AUTH is accepted from any client host.
26816
26817 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26818 server authentication mechanism that was advertised in response to EHLO and
26819 that matches the one named in the AUTH command. If it finds one, it runs
26820 the appropriate authentication protocol, and authentication either succeeds or
26821 fails. If there is no matching advertised mechanism, the AUTH command is
26822 rejected with a 504 error.
26823
26824 .vindex "&$received_protocol$&"
26825 .vindex "&$sender_host_authenticated$&"
26826 When a message is received from an authenticated host, the value of
26827 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26828 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26829 public name) of the authenticator driver that successfully authenticated the
26830 client from which the message was received. This variable is empty if there was
26831 no successful authentication.
26832
26833 .cindex authentication "expansion item"
26834 Successful authentication sets up information used by the
26835 &%authresults%& expansion item.
26836
26837
26838
26839
26840 .section "Testing server authentication" "SECID169"
26841 .cindex "authentication" "testing a server"
26842 .cindex "AUTH" "testing a server"
26843 .cindex "base64 encoding" "creating authentication test data"
26844 Exim's &%-bh%& option can be useful for testing server authentication
26845 configurations. The data for the AUTH command has to be sent using base64
26846 encoding. A quick way to produce such data for testing is the following Perl
26847 script:
26848 .code
26849 use MIME::Base64;
26850 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26851 .endd
26852 .cindex "binary zero" "in authentication data"
26853 This interprets its argument as a Perl string, and then encodes it. The
26854 interpretation as a Perl string allows binary zeros, which are required for
26855 some kinds of authentication, to be included in the data. For example, a
26856 command line to run this script on such data might be
26857 .code
26858 encode '\0user\0password'
26859 .endd
26860 Note the use of single quotes to prevent the shell interpreting the
26861 backslashes, so that they can be interpreted by Perl to specify characters
26862 whose code value is zero.
26863
26864 &*Warning 1*&: If either of the user or password strings starts with an octal
26865 digit, you must use three zeros instead of one after the leading backslash. If
26866 you do not, the octal digit that starts your string will be incorrectly
26867 interpreted as part of the code for the first character.
26868
26869 &*Warning 2*&: If there are characters in the strings that Perl interprets
26870 specially, you must use a Perl escape to prevent them being misinterpreted. For
26871 example, a command such as
26872 .code
26873 encode '\0user@domain.com\0pas$$word'
26874 .endd
26875 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26876
26877 If you have the &%mimencode%& command installed, another way to do produce
26878 base64-encoded strings is to run the command
26879 .code
26880 echo -e -n `\0user\0password' | mimencode
26881 .endd
26882 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26883 in the argument, and the &%-n%& option specifies no newline at the end of its
26884 output. However, not all versions of &%echo%& recognize these options, so you
26885 should check your version before relying on this suggestion.
26886
26887
26888
26889 .section "Authentication by an Exim client" "SECID170"
26890 .cindex "authentication" "on an Exim client"
26891 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26892 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26893 announces support for authentication, and the host matches an entry in either
26894 of these options, Exim (as a client) tries to authenticate as follows:
26895
26896 .ilist
26897 For each authenticator that is configured as a client, in the order in which
26898 they are defined in the configuration, it searches the authentication
26899 mechanisms announced by the server for one whose name matches the public name
26900 of the authenticator.
26901 .next
26902 .vindex "&$host$&"
26903 .vindex "&$host_address$&"
26904 When it finds one that matches, it runs the authenticator's client code. The
26905 variables &$host$& and &$host_address$& are available for any string expansions
26906 that the client might do. They are set to the server's name and IP address. If
26907 any expansion is forced to fail, the authentication attempt is abandoned, and
26908 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26909 delivery to be deferred.
26910 .next
26911 If the result of the authentication attempt is a temporary error or a timeout,
26912 Exim abandons trying to send the message to the host for the moment. It will
26913 try again later. If there are any backup hosts available, they are tried in the
26914 usual way.
26915 .next
26916 If the response to authentication is a permanent error (5&'xx'& code), Exim
26917 carries on searching the list of authenticators and tries another one if
26918 possible. If all authentication attempts give permanent errors, or if there are
26919 no attempts because no mechanisms match (or option expansions force failure),
26920 what happens depends on whether the host matches &%hosts_require_auth%& or
26921 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26922 delivery is deferred. The error can be detected in the retry rules, and thereby
26923 turned into a permanent error if you wish. In the second case, Exim tries to
26924 deliver the message unauthenticated.
26925 .endlist
26926
26927 Note that the hostlist test for whether to do authentication can be
26928 confused if name-IP lookups change between the time the peer is decided
26929 upon and the time that the transport runs.  For example, with a manualroute
26930 router given a host name, and with DNS "round-robin" used by that name: if
26931 the local resolver cache times out between the router and the transport
26932 running, the transport may get an IP for the name for its authentication
26933 check which does not match the connection peer IP.
26934 No authentication will then be done, despite the names being identical.
26935
26936 For such cases use a separate transport which always authenticates.
26937
26938 .cindex "AUTH" "on MAIL command"
26939 When Exim has authenticated itself to a remote server, it adds the AUTH
26940 parameter to the MAIL commands it sends, if it has an authenticated sender for
26941 the message. If the message came from a remote host, the authenticated sender
26942 is the one that was receiving on an incoming MAIL command, provided that the
26943 incoming connection was authenticated and the &%server_mail_auth%& condition
26944 allowed the authenticated sender to be retained. If a local process calls Exim
26945 to send a message, the sender address that is built from the login name and
26946 &%qualify_domain%& is treated as authenticated. However, if the
26947 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26948 the authenticated sender that was received with the message.
26949 .ecindex IIDauthconf1
26950 .ecindex IIDauthconf2
26951
26952
26953
26954
26955
26956
26957 . ////////////////////////////////////////////////////////////////////////////
26958 . ////////////////////////////////////////////////////////////////////////////
26959
26960 .chapter "The plaintext authenticator" "CHAPplaintext"
26961 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26962 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26963 The &(plaintext)& authenticator can be configured to support the PLAIN and
26964 LOGIN authentication mechanisms, both of which transfer authentication data as
26965 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26966 security risk; you are strongly advised to insist on the use of SMTP encryption
26967 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26968 use unencrypted plain text, you should not use the same passwords for SMTP
26969 connections as you do for login accounts.
26970
26971 .section "Avoiding cleartext use" "SECTplain_TLS"
26972 The following generic option settings will disable &(plaintext)& authenticators when
26973 TLS is not being used:
26974 .code
26975   server_advertise_condition = ${if def:tls_in_cipher }
26976   client_condition =           ${if def:tls_out_cipher}
26977 .endd
26978
26979 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
26980 but is still vulnerable to a Man In The Middle attack unless certificates
26981 (including their names) have been properly verified.
26982
26983 .section "Plaintext server options" "SECID171"
26984 .cindex "options" "&(plaintext)& authenticator (server)"
26985 When configured as a server, &(plaintext)& uses the following options:
26986
26987 .option server_condition authenticators string&!! unset
26988 This is actually a global authentication option, but it must be set in order to
26989 configure the &(plaintext)& driver as a server. Its use is described below.
26990
26991 .option server_prompts plaintext "string list&!!" unset
26992 The contents of this option, after expansion, must be a colon-separated list of
26993 prompt strings. If expansion fails, a temporary authentication rejection is
26994 given.
26995
26996 .section "Using plaintext in a server" "SECTplainserver"
26997 .cindex "AUTH" "in &(plaintext)& authenticator"
26998 .cindex "binary zero" "in &(plaintext)& authenticator"
26999 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27000         "in &(plaintext)& authenticator"
27001 .vindex "&$auth1$&, &$auth2$&, etc"
27002 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27003
27004 When running as a server, &(plaintext)& performs the authentication test by
27005 expanding a string. The data sent by the client with the AUTH command, or in
27006 response to subsequent prompts, is base64 encoded, and so may contain any byte
27007 values when decoded. If any data is supplied with the command, it is treated as
27008 a list of strings, separated by NULs (binary zeros), the first three of which
27009 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27010 (neither LOGIN nor PLAIN uses more than three strings).
27011
27012 For compatibility with previous releases of Exim, the values are also placed in
27013 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27014 variables for this purpose is now deprecated, as it can lead to confusion in
27015 string expansions that also use them for other things.
27016
27017 If there are more strings in &%server_prompts%& than the number of strings
27018 supplied with the AUTH command, the remaining prompts are used to obtain more
27019 data. Each response from the client may be a list of NUL-separated strings.
27020
27021 .vindex "&$authenticated_id$&"
27022 Once a sufficient number of data strings have been received,
27023 &%server_condition%& is expanded. If the expansion is forced to fail,
27024 authentication fails. Any other expansion failure causes a temporary error code
27025 to be returned. If the result of a successful expansion is an empty string,
27026 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27027 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27028 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27029 For any other result, a temporary error code is returned, with the expanded
27030 string as the error text.
27031
27032 &*Warning*&: If you use a lookup in the expansion to find the user's
27033 password, be sure to make the authentication fail if the user is unknown.
27034 There are good and bad examples at the end of the next section.
27035
27036
27037
27038 .section "The PLAIN authentication mechanism" "SECID172"
27039 .cindex "PLAIN authentication mechanism"
27040 .cindex "authentication" "PLAIN mechanism"
27041 .cindex "binary zero" "in &(plaintext)& authenticator"
27042 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27043 sent as one item of data (that is, one combined string containing two NUL
27044 separators). The data is sent either as part of the AUTH command, or
27045 subsequently in response to an empty prompt from the server.
27046
27047 The second and third strings are a user name and a corresponding password.
27048 Using a single fixed user name and password as an example, this could be
27049 configured as follows:
27050 .code
27051 fixed_plain:
27052   driver = plaintext
27053   public_name = PLAIN
27054   server_prompts = :
27055   server_condition = \
27056     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27057   server_set_id = $auth2
27058 .endd
27059 Note that the default result strings from &%if%& (&"true"& or an empty string)
27060 are exactly what we want here, so they need not be specified. Obviously, if the
27061 password contains expansion-significant characters such as dollar, backslash,
27062 or closing brace, they have to be escaped.
27063
27064 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27065 the end of a string list are ignored). If all the data comes as part of the
27066 AUTH command, as is commonly the case, the prompt is not used. This
27067 authenticator is advertised in the response to EHLO as
27068 .code
27069 250-AUTH PLAIN
27070 .endd
27071 and a client host can authenticate itself by sending the command
27072 .code
27073 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27074 .endd
27075 As this contains three strings (more than the number of prompts), no further
27076 data is required from the client. Alternatively, the client may just send
27077 .code
27078 AUTH PLAIN
27079 .endd
27080 to initiate authentication, in which case the server replies with an empty
27081 prompt. The client must respond with the combined data string.
27082
27083 The data string is base64 encoded, as required by the RFC. This example,
27084 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27085 represents a zero byte. This is split up into three strings, the first of which
27086 is empty. The &%server_condition%& option in the authenticator checks that the
27087 second two are &`username`& and &`mysecret`& respectively.
27088
27089 Having just one fixed user name and password, as in this example, is not very
27090 realistic, though for a small organization with only a handful of
27091 authenticating clients it could make sense.
27092
27093 A more sophisticated instance of this authenticator could use the user name in
27094 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27095 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27096 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27097 This is an incorrect example:
27098 .code
27099 server_condition = \
27100   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27101 .endd
27102 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27103 which it then compares to the supplied password (&$auth3$&). Why is this example
27104 incorrect? It works fine for existing users, but consider what happens if a
27105 non-existent user name is given. The lookup fails, but as no success/failure
27106 strings are given for the lookup, it yields an empty string. Thus, to defeat
27107 the authentication, all a client has to do is to supply a non-existent user
27108 name and an empty password. The correct way of writing this test is:
27109 .code
27110 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27111   {${if eq{$value}{$auth3}}} {false}}
27112 .endd
27113 In this case, if the lookup succeeds, the result is checked; if the lookup
27114 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27115 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27116 always fails if its second argument is empty. However, the second way of
27117 writing the test makes the logic clearer.
27118
27119
27120 .section "The LOGIN authentication mechanism" "SECID173"
27121 .cindex "LOGIN authentication mechanism"
27122 .cindex "authentication" "LOGIN mechanism"
27123 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27124 in a number of programs. No data is sent with the AUTH command. Instead, a
27125 user name and password are supplied separately, in response to prompts. The
27126 plaintext authenticator can be configured to support this as in this example:
27127 .code
27128 fixed_login:
27129   driver = plaintext
27130   public_name = LOGIN
27131   server_prompts = User Name : Password
27132   server_condition = \
27133     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27134   server_set_id = $auth1
27135 .endd
27136 Because of the way plaintext operates, this authenticator accepts data supplied
27137 with the AUTH command (in contravention of the specification of LOGIN), but
27138 if the client does not supply it (as is the case for LOGIN clients), the prompt
27139 strings are used to obtain two data items.
27140
27141 Some clients are very particular about the precise text of the prompts. For
27142 example, Outlook Express is reported to recognize only &"Username:"& and
27143 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27144 strings. It uses the &%ldapauth%& expansion condition to check the user
27145 name and password by binding to an LDAP server:
27146 .code
27147 login:
27148   driver = plaintext
27149   public_name = LOGIN
27150   server_prompts = Username:: : Password::
27151   server_condition = ${if and{{ \
27152     !eq{}{$auth1} }{ \
27153     ldapauth{\
27154       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27155       pass=${quote:$auth2} \
27156       ldap://ldap.example.org/} }} }
27157   server_set_id = uid=$auth1,ou=people,o=example.org
27158 .endd
27159 We have to check that the username is not empty before using it, because LDAP
27160 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27161 operator to correctly quote the DN for authentication. However, the basic
27162 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27163 correct one to use for the password, because quoting is needed only to make
27164 the password conform to the Exim syntax. At the LDAP level, the password is an
27165 uninterpreted string.
27166
27167
27168 .section "Support for different kinds of authentication" "SECID174"
27169 A number of string expansion features are provided for the purpose of
27170 interfacing to different ways of user authentication. These include checking
27171 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27172 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27173 &<<SECTexpcond>>&.
27174
27175
27176
27177
27178 .section "Using plaintext in a client" "SECID175"
27179 .cindex "options" "&(plaintext)& authenticator (client)"
27180 The &(plaintext)& authenticator has two client options:
27181
27182 .option client_ignore_invalid_base64 plaintext boolean false
27183 If the client receives a server prompt that is not a valid base64 string,
27184 authentication is abandoned by default. However, if this option is set true,
27185 the error in the challenge is ignored and the client sends the response as
27186 usual.
27187
27188 .option client_send plaintext string&!! unset
27189 The string is a colon-separated list of authentication data strings. Each
27190 string is independently expanded before being sent to the server. The first
27191 string is sent with the AUTH command; any more strings are sent in response
27192 to prompts from the server. Before each string is expanded, the value of the
27193 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27194 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27195 way. Thus, the prompt that is received in response to sending the first string
27196 (with the AUTH command) can be used in the expansion of the second string, and
27197 so on. If an invalid base64 string is received when
27198 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27199 &$auth$&<&'n'&> variable.
27200
27201 &*Note*&: You cannot use expansion to create multiple strings, because
27202 splitting takes priority and happens first.
27203
27204 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27205 the data, further processing is applied to each string before it is sent. If
27206 there are any single circumflex characters in the string, they are converted to
27207 NULs. Should an actual circumflex be required as data, it must be doubled in
27208 the string.
27209
27210 This is an example of a client configuration that implements the PLAIN
27211 authentication mechanism with a fixed user name and password:
27212 .code
27213 fixed_plain:
27214   driver = plaintext
27215   public_name = PLAIN
27216   client_send = ^username^mysecret
27217 .endd
27218 The lack of colons means that the entire text is sent with the AUTH
27219 command, with the circumflex characters converted to NULs. A similar example
27220 that uses the LOGIN mechanism is:
27221 .code
27222 fixed_login:
27223   driver = plaintext
27224   public_name = LOGIN
27225   client_send = : username : mysecret
27226 .endd
27227 The initial colon means that the first string is empty, so no data is sent with
27228 the AUTH command itself. The remaining strings are sent in response to
27229 prompts.
27230 .ecindex IIDplaiauth1
27231 .ecindex IIDplaiauth2
27232
27233
27234
27235
27236 . ////////////////////////////////////////////////////////////////////////////
27237 . ////////////////////////////////////////////////////////////////////////////
27238
27239 .chapter "The cram_md5 authenticator" "CHID9"
27240 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27241 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27242 .cindex "CRAM-MD5 authentication mechanism"
27243 .cindex "authentication" "CRAM-MD5 mechanism"
27244 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27245 sends a challenge string to the client, and the response consists of a user
27246 name and the CRAM-MD5 digest of the challenge string combined with a secret
27247 string (password) which is known to both server and client. Thus, the secret
27248 is not sent over the network as plain text, which makes this authenticator more
27249 secure than &(plaintext)&. However, the downside is that the secret has to be
27250 available in plain text at either end.
27251
27252
27253 .section "Using cram_md5 as a server" "SECID176"
27254 .cindex "options" "&(cram_md5)& authenticator (server)"
27255 This authenticator has one server option, which must be set to configure the
27256 authenticator as a server:
27257
27258 .option server_secret cram_md5 string&!! unset
27259 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27260 When the server receives the client's response, the user name is placed in
27261 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27262 obtain the password for that user. The server then computes the CRAM-MD5 digest
27263 that the client should have sent, and checks that it received the correct
27264 string. If the expansion of &%server_secret%& is forced to fail, authentication
27265 fails. If the expansion fails for some other reason, a temporary error code is
27266 returned to the client.
27267
27268 For compatibility with previous releases of Exim, the user name is also placed
27269 in &$1$&. However, the use of this variables for this purpose is now
27270 deprecated, as it can lead to confusion in string expansions that also use
27271 numeric variables for other things.
27272
27273 For example, the following authenticator checks that the user name given by the
27274 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27275 user name, authentication fails.
27276 .code
27277 fixed_cram:
27278   driver = cram_md5
27279   public_name = CRAM-MD5
27280   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27281   server_set_id = $auth1
27282 .endd
27283 .vindex "&$authenticated_id$&"
27284 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27285 name in &$authenticated_id$&. A more typical configuration might look up the
27286 secret string in a file, using the user name as the key. For example:
27287 .code
27288 lookup_cram:
27289   driver = cram_md5
27290   public_name = CRAM-MD5
27291   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27292                   {$value}fail}
27293   server_set_id = $auth1
27294 .endd
27295 Note that this expansion explicitly forces failure if the lookup fails
27296 because &$auth1$& contains an unknown user name.
27297
27298 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27299 using the relevant libraries, you need to know the realm to specify in the
27300 lookup and then ask for the &"userPassword"& attribute for that user in that
27301 realm, with:
27302 .code
27303 cyrusless_crammd5:
27304   driver = cram_md5
27305   public_name = CRAM-MD5
27306   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27307                   dbmjz{/etc/sasldb2}{$value}fail}
27308   server_set_id = $auth1
27309 .endd
27310
27311 .section "Using cram_md5 as a client" "SECID177"
27312 .cindex "options" "&(cram_md5)& authenticator (client)"
27313 When used as a client, the &(cram_md5)& authenticator has two options:
27314
27315
27316
27317 .option client_name cram_md5 string&!! "the primary host name"
27318 This string is expanded, and the result used as the user name data when
27319 computing the response to the server's challenge.
27320
27321
27322 .option client_secret cram_md5 string&!! unset
27323 This option must be set for the authenticator to work as a client. Its value is
27324 expanded and the result used as the secret string when computing the response.
27325
27326
27327 .vindex "&$host$&"
27328 .vindex "&$host_address$&"
27329 Different user names and secrets can be used for different servers by referring
27330 to &$host$& or &$host_address$& in the options. Forced failure of either
27331 expansion string is treated as an indication that this authenticator is not
27332 prepared to handle this case. Exim moves on to the next configured client
27333 authenticator. Any other expansion failure causes Exim to give up trying to
27334 send the message to the current server.
27335
27336 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27337 strings, is:
27338 .code
27339 fixed_cram:
27340   driver = cram_md5
27341   public_name = CRAM-MD5
27342   client_name = ph10
27343   client_secret = secret
27344 .endd
27345 .ecindex IIDcramauth1
27346 .ecindex IIDcramauth2
27347
27348
27349
27350 . ////////////////////////////////////////////////////////////////////////////
27351 . ////////////////////////////////////////////////////////////////////////////
27352
27353 .chapter "The cyrus_sasl authenticator" "CHID10"
27354 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27355 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27356 .cindex "Cyrus" "SASL library"
27357 .cindex "Kerberos"
27358 The code for this authenticator was provided by Matthew Byng-Maddick while
27359 at A L Digital Ltd.
27360
27361 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27362 library implementation of the RFC 2222 (&"Simple Authentication and Security
27363 Layer"&). This library supports a number of authentication mechanisms,
27364 including PLAIN and LOGIN, but also several others that Exim does not support
27365 directly. In particular, there is support for Kerberos authentication.
27366
27367 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27368 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27369 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27370 name of the driver to determine which mechanism to support.
27371
27372 Where access to some kind of secret file is required, for example, in GSSAPI
27373 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27374 user, and that the Cyrus SASL library has no way of escalating privileges
27375 by default. You may also find you need to set environment variables,
27376 depending on the driver you are using.
27377
27378 The application name provided by Exim is &"exim"&, so various SASL options may
27379 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27380 Kerberos, note that because of limitations in the GSSAPI interface,
27381 changing the server keytab might need to be communicated down to the Kerberos
27382 layer independently. The mechanism for doing so is dependent upon the Kerberos
27383 implementation.
27384
27385 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27386 may be set to point to an alternative keytab file. Exim will pass this
27387 variable through from its own inherited environment when started as root or the
27388 Exim user. The keytab file needs to be readable by the Exim user.
27389 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27390 environment variable.  In practice, for those releases, the Cyrus authenticator
27391 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27392 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27393
27394
27395 .section "Using cyrus_sasl as a server" "SECID178"
27396 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27397 (on a successful authentication) into &$auth1$&. For compatibility with
27398 previous releases of Exim, the username is also placed in &$1$&. However, the
27399 use of this variable for this purpose is now deprecated, as it can lead to
27400 confusion in string expansions that also use numeric variables for other
27401 things.
27402
27403
27404 .option server_hostname cyrus_sasl string&!! "see below"
27405 This option selects the hostname that is used when communicating with the
27406 library. The default value is &`$primary_hostname`&. It is up to the underlying
27407 SASL plug-in what it does with this data.
27408
27409
27410 .option server_mech cyrus_sasl string "see below"
27411 This option selects the authentication mechanism this driver should use. The
27412 default is the value of the generic &%public_name%& option. This option allows
27413 you to use a different underlying mechanism from the advertised name. For
27414 example:
27415 .code
27416 sasl:
27417   driver = cyrus_sasl
27418   public_name = X-ANYTHING
27419   server_mech = CRAM-MD5
27420   server_set_id = $auth1
27421 .endd
27422
27423 .option server_realm cyrus_sasl string&!! unset
27424 This specifies the SASL realm that the server claims to be in.
27425
27426
27427 .option server_service cyrus_sasl string &`smtp`&
27428 This is the SASL service that the server claims to implement.
27429
27430
27431 For straightforward cases, you do not need to set any of the authenticator's
27432 private options. All you need to do is to specify an appropriate mechanism as
27433 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27434 PLAIN, you could have two authenticators as follows:
27435 .code
27436 sasl_cram_md5:
27437   driver = cyrus_sasl
27438   public_name = CRAM-MD5
27439   server_set_id = $auth1
27440
27441 sasl_plain:
27442   driver = cyrus_sasl
27443   public_name = PLAIN
27444   server_set_id = $auth2
27445 .endd
27446 Cyrus SASL does implement the LOGIN authentication method, even though it is
27447 not a standard method. It is disabled by default in the source distribution,
27448 but it is present in many binary distributions.
27449 .ecindex IIDcyrauth1
27450 .ecindex IIDcyrauth2
27451
27452
27453
27454
27455 . ////////////////////////////////////////////////////////////////////////////
27456 . ////////////////////////////////////////////////////////////////////////////
27457 .chapter "The dovecot authenticator" "CHAPdovecot"
27458 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27459 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27460 This authenticator is an interface to the authentication facility of the
27461 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27462 Note that Dovecot must be configured to use auth-client not auth-userdb.
27463 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27464 to use the same mechanisms for SMTP authentication. This is a server
27465 authenticator only. There is only one option:
27466
27467 .option server_socket dovecot string unset
27468
27469 This option must specify the UNIX socket that is the interface to Dovecot
27470 authentication. The &%public_name%& option must specify an authentication
27471 mechanism that Dovecot is configured to support. You can have several
27472 authenticators for different mechanisms. For example:
27473 .code
27474 dovecot_plain:
27475   driver = dovecot
27476   public_name = PLAIN
27477   server_socket = /var/run/dovecot/auth-client
27478   server_set_id = $auth1
27479
27480 dovecot_ntlm:
27481   driver = dovecot
27482   public_name = NTLM
27483   server_socket = /var/run/dovecot/auth-client
27484   server_set_id = $auth1
27485 .endd
27486 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27487 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27488 option is passed in the Dovecot authentication command. If, for a TLS
27489 connection, a client certificate has been verified, the &"valid-client-cert"&
27490 option is passed. When authentication succeeds, the identity of the user
27491 who authenticated is placed in &$auth1$&.
27492
27493 .new
27494 The Dovecot configuration to match the above wil look
27495 something like:
27496 .code
27497 conf.d/10-master.conf :-
27498
27499 service auth {
27500 ...
27501 #SASL
27502   unix_listener auth-client {
27503     mode = 0660
27504     user = mail
27505   }
27506 ...
27507 }
27508
27509 conf.d/10-auth.conf :-
27510
27511 auth_mechanisms = plain login ntlm
27512 .endd
27513 .wen
27514
27515 .ecindex IIDdcotauth1
27516 .ecindex IIDdcotauth2
27517
27518
27519 . ////////////////////////////////////////////////////////////////////////////
27520 . ////////////////////////////////////////////////////////////////////////////
27521 .chapter "The gsasl authenticator" "CHAPgsasl"
27522 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27523 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27524 .cindex "authentication" "GNU SASL"
27525 .cindex "authentication" "SASL"
27526 .cindex "authentication" "EXTERNAL"
27527 .cindex "authentication" "ANONYMOUS"
27528 .cindex "authentication" "PLAIN"
27529 .cindex "authentication" "LOGIN"
27530 .cindex "authentication" "DIGEST-MD5"
27531 .cindex "authentication" "CRAM-MD5"
27532 .cindex "authentication" "SCRAM-SHA-1"
27533 .cindex "authentication" "SCRAM-SHA-1-PLUS"
27534 .cindex "authentication" "SCRAM-SHA-256"
27535 .cindex "authentication" "SCRAM-SHA-256-PLUS"
27536 The &(gsasl)& authenticator provides integration for the GNU SASL
27537 library and the mechanisms it provides.  This is new as of the 4.80 release
27538 and there are a few areas where the library does not let Exim smoothly
27539 scale to handle future authentication mechanisms, so no guarantee can be
27540 made that any particular new authentication mechanism will be supported
27541 without code changes in Exim.
27542
27543 .new
27544 The library is expected to add support in an upcoming
27545 realease for the SCRAM-SHA-256 method.
27546 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27547 when this happens.
27548
27549
27550 .option client_authz gsasl string&!! unset
27551 This option can be used to supply an &'authorization id'&
27552 which is different to the &'authentication_id'& provided
27553 by &%client_username%& option.
27554 If unset or (after expansion) empty it is not used,
27555 which is the common case.
27556
27557 .option client_channelbinding gsasl boolean false
27558 See &%server_channelbinding%& below.
27559
27560 .option client_password gsasl string&!! unset
27561 This option is exapanded before use, and should result in
27562 the password to be used, in clear.
27563
27564 .option client_username gsasl string&!! unset
27565 This option is exapanded before use, and should result in
27566 the account name to be used.
27567 .wen
27568
27569 .new
27570 .option client_spassword gsasl string&!! unset
27571 If a SCRAM mechanism is being used and this option is set
27572 it is used in preference to &%client_password%&.
27573 The value after expansion should be
27574 a 40 (for SHA-1) or 64 (for SHA-256) character string
27575 with the PBKDF2-prepared password, hex-encoded.
27576 Note that this value will depend on the salt and iteration-count
27577 supplied by the server.
27578 .wen
27579
27580
27581
27582 .option server_channelbinding gsasl boolean false
27583 Do not set this true and rely on the properties
27584 without consulting a cryptographic engineer.
27585
27586 Some authentication mechanisms are able to use external context at both ends
27587 of the session to bind the authentication to that context, and fail the
27588 authentication process if that context differs.  Specifically, some TLS
27589 ciphersuites can provide identifying information about the cryptographic
27590 context.
27591
27592 This should have meant that certificate identity and verification becomes a
27593 non-issue, as a man-in-the-middle attack will cause the correct client and
27594 server to see different identifiers and authentication will fail.
27595
27596 .new
27597 This is
27598 only usable by mechanisms which support "channel binding"; at time of
27599 writing, that's the SCRAM family.
27600 When using this feature the "-PLUS" variants of the method names need to be used.
27601 .wen
27602
27603 This defaults off to ensure smooth upgrade across Exim releases, in case
27604 this option causes some clients to start failing.  Some future release
27605 of Exim might have switched the default to be true.
27606
27607 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27608 Do not plan to rely upon this feature for security, ever, without consulting
27609 with a subject matter expert (a cryptographic engineer).
27610
27611
27612 .option server_hostname gsasl string&!! "see below"
27613 This option selects the hostname that is used when communicating with the
27614 library. The default value is &`$primary_hostname`&.
27615 Some mechanisms will use this data.
27616
27617
27618 .option server_mech gsasl string "see below"
27619 This option selects the authentication mechanism this driver should use. The
27620 default is the value of the generic &%public_name%& option. This option allows
27621 you to use a different underlying mechanism from the advertised name. For
27622 example:
27623 .code
27624 sasl:
27625   driver = gsasl
27626   public_name = X-ANYTHING
27627   server_mech = CRAM-MD5
27628   server_set_id = $auth1
27629 .endd
27630
27631
27632 .option server_password gsasl string&!! unset
27633 Various mechanisms need access to the cleartext password on the server, so
27634 that proof-of-possession can be demonstrated on the wire, without sending
27635 the password itself.
27636
27637 The data available for lookup varies per mechanism.
27638 In all cases, &$auth1$& is set to the &'authentication id'&.
27639 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27640 if available, else the empty string.
27641 The &$auth3$& variable will always be the &'realm'& if available,
27642 else the empty string.
27643
27644 A forced failure will cause authentication to defer.
27645
27646 If using this option, it may make sense to set the &%server_condition%&
27647 option to be simply "true".
27648
27649
27650 .option server_realm gsasl string&!! unset
27651 This specifies the SASL realm that the server claims to be in.
27652 Some mechanisms will use this data.
27653
27654
27655 .option server_scram_iter gsasl string&!! 4096
27656 This option provides data for the SCRAM family of mechanisms.
27657 .new
27658 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27659 when this option is expanded.
27660
27661 The result of expansion should be a decimal number,
27662 and represents both a lower-bound on the security, and
27663 a compute cost factor imposed on the client
27664 (if it does not cache results, or the server changes
27665 either the iteration count or the salt).
27666 A minimum value of 4096 is required by the standards
27667 for all current SCRAM mechanism variants.
27668 .wen
27669
27670 .option server_scram_salt gsasl string&!! unset
27671 This option provides data for the SCRAM family of mechanisms.
27672 .new
27673 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27674 when this option is expanded.
27675 The value should be a base64-encoded string,
27676 of random data typically 4-to-16 bytes long.
27677 If unset or empty after expansion the library will provides a value for the
27678 protocol conversation.
27679 .wen
27680
27681
27682 .new
27683 .option server_key gsasl string&!! unset
27684 .option server_skey gsasl string&!! unset
27685 These options can be used for the SCRAM family of mechanisms
27686 to provide stored information related to a password,
27687 the storage of which is preferable to plaintext.
27688
27689 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
27690 &%server_skey%& is StoredKey.
27691
27692 They are only available for version 1.9.0 (or later) of the gsasl library.
27693 When this is so, the macros
27694 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
27695 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
27696 will be defined.
27697
27698 The &$authN$& variables are available when these options are expanded.
27699
27700 If set, the results of expansion should for each
27701 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
27702 of base64-coded data, and will be used in preference to the
27703 &%server_password%& option.
27704 If unset or not of the right length, &%server_password%& will be used.
27705
27706 The libgsasl library release includes a utility &'gsasl'& which can be used
27707 to generate these values.
27708 .wen
27709
27710
27711 .option server_service gsasl string &`smtp`&
27712 This is the SASL service that the server claims to implement.
27713 Some mechanisms will use this data.
27714
27715
27716 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27717 .vindex "&$auth1$&, &$auth2$&, etc"
27718 These may be set when evaluating specific options, as detailed above.
27719 They will also be set when evaluating &%server_condition%&.
27720
27721 Unless otherwise stated below, the &(gsasl)& integration will use the following
27722 meanings for these variables:
27723
27724 .ilist
27725 .vindex "&$auth1$&"
27726 &$auth1$&: the &'authentication id'&
27727 .next
27728 .vindex "&$auth2$&"
27729 &$auth2$&: the &'authorization id'&
27730 .next
27731 .vindex "&$auth3$&"
27732 &$auth3$&: the &'realm'&
27733 .endlist
27734
27735 On a per-mechanism basis:
27736
27737 .ilist
27738 .cindex "authentication" "EXTERNAL"
27739 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27740 the &%server_condition%& option must be present.
27741 .next
27742 .cindex "authentication" "ANONYMOUS"
27743 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27744 the &%server_condition%& option must be present.
27745 .next
27746 .cindex "authentication" "GSSAPI"
27747 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27748 &$auth2$& will be set to the &'authorization id'&,
27749 the &%server_condition%& option must be present.
27750 .endlist
27751
27752 An &'anonymous token'& is something passed along as an unauthenticated
27753 identifier; this is analogous to FTP anonymous authentication passing an
27754 email address, or software-identifier@, as the "password".
27755
27756
27757 An example showing the password having the realm specified in the callback
27758 and demonstrating a Cyrus SASL to GSASL migration approach is:
27759 .code
27760 gsasl_cyrusless_crammd5:
27761   driver = gsasl
27762   public_name = CRAM-MD5
27763   server_realm = imap.example.org
27764   server_password = ${lookup{$auth1:$auth3:userPassword}\
27765                     dbmjz{/etc/sasldb2}{$value}fail}
27766   server_set_id = ${quote:$auth1}
27767   server_condition = yes
27768 .endd
27769
27770
27771 . ////////////////////////////////////////////////////////////////////////////
27772 . ////////////////////////////////////////////////////////////////////////////
27773
27774 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27775 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27776 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27777 .cindex "authentication" "GSSAPI"
27778 .cindex "authentication" "Kerberos"
27779 The &(heimdal_gssapi)& authenticator provides server integration for the
27780 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27781 reliably.
27782
27783 .option server_hostname heimdal_gssapi string&!! "see below"
27784 This option selects the hostname that is used, with &%server_service%&,
27785 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27786 identifier.  The default value is &`$primary_hostname`&.
27787
27788 .option server_keytab heimdal_gssapi string&!! unset
27789 If set, then Heimdal will not use the system default keytab (typically
27790 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27791 The value should be a pathname, with no &"file:"& prefix.
27792
27793 .option server_service heimdal_gssapi string&!! "smtp"
27794 This option specifies the service identifier used, in conjunction with
27795 &%server_hostname%&, for building the identifier for finding credentials
27796 from the keytab.
27797
27798
27799 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27800 Beware that these variables will typically include a realm, thus will appear
27801 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27802 not verified, so a malicious client can set it to anything.
27803
27804 The &$auth1$& field should be safely trustable as a value from the Key
27805 Distribution Center.  Note that these are not quite email addresses.
27806 Each identifier is for a role, and so the left-hand-side may include a
27807 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27808
27809 .vindex "&$auth1$&, &$auth2$&, etc"
27810 .ilist
27811 .vindex "&$auth1$&"
27812 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27813 .next
27814 .vindex "&$auth2$&"
27815 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27816 authentication.  If that was empty, this will also be set to the
27817 GSS Display Name.
27818 .endlist
27819
27820
27821 . ////////////////////////////////////////////////////////////////////////////
27822 . ////////////////////////////////////////////////////////////////////////////
27823
27824 .chapter "The spa authenticator" "CHAPspa"
27825 .scindex IIDspaauth1 "&(spa)& authenticator"
27826 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27827 .cindex "authentication" "Microsoft Secure Password"
27828 .cindex "authentication" "NTLM"
27829 .cindex "Microsoft Secure Password Authentication"
27830 .cindex "NTLM authentication"
27831 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27832 Password Authentication'& mechanism,
27833 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27834 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27835 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27836 server side was subsequently contributed by Tom Kistner. The mechanism works as
27837 follows:
27838
27839 .ilist
27840 After the AUTH command has been accepted, the client sends an SPA
27841 authentication request based on the user name and optional domain.
27842 .next
27843 The server sends back a challenge.
27844 .next
27845 The client builds a challenge response which makes use of the user's password
27846 and sends it to the server, which then accepts or rejects it.
27847 .endlist
27848
27849 Encryption is used to protect the password in transit.
27850
27851
27852
27853 .section "Using spa as a server" "SECID179"
27854 .cindex "options" "&(spa)& authenticator (server)"
27855 The &(spa)& authenticator has just one server option:
27856
27857 .option server_password spa string&!! unset
27858 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27859 This option is expanded, and the result must be the cleartext password for the
27860 authenticating user, whose name is at this point in &$auth1$&. For
27861 compatibility with previous releases of Exim, the user name is also placed in
27862 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27863 it can lead to confusion in string expansions that also use numeric variables
27864 for other things. For example:
27865 .code
27866 spa:
27867   driver = spa
27868   public_name = NTLM
27869   server_password = \
27870     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27871 .endd
27872 If the expansion is forced to fail, authentication fails. Any other expansion
27873 failure causes a temporary error code to be returned.
27874
27875
27876
27877
27878
27879 .section "Using spa as a client" "SECID180"
27880 .cindex "options" "&(spa)& authenticator (client)"
27881 The &(spa)& authenticator has the following client options:
27882
27883
27884
27885 .option client_domain spa string&!! unset
27886 This option specifies an optional domain for the authentication.
27887
27888
27889 .option client_password spa string&!! unset
27890 This option specifies the user's password, and must be set.
27891
27892
27893 .option client_username spa string&!! unset
27894 This option specifies the user name, and must be set. Here is an example of a
27895 configuration of this authenticator for use with the mail servers at
27896 &'msn.com'&:
27897 .code
27898 msn:
27899   driver = spa
27900   public_name = MSN
27901   client_username = msn/msn_username
27902   client_password = msn_plaintext_password
27903   client_domain = DOMAIN_OR_UNSET
27904 .endd
27905 .ecindex IIDspaauth1
27906 .ecindex IIDspaauth2
27907
27908
27909
27910
27911
27912 . ////////////////////////////////////////////////////////////////////////////
27913 . ////////////////////////////////////////////////////////////////////////////
27914
27915 .chapter "The external authenticator" "CHAPexternauth"
27916 .scindex IIDexternauth1 "&(external)& authenticator"
27917 .scindex IIDexternauth2 "authenticators" "&(external)&"
27918 .cindex "authentication" "Client Certificate"
27919 .cindex "authentication" "X509"
27920 .cindex "Certificate-based authentication"
27921 The &(external)& authenticator provides support for
27922 authentication based on non-SMTP information.
27923 The specification is in RFC 4422 Appendix A
27924 (&url(https://tools.ietf.org/html/rfc4422)).
27925 It is only a transport and negotiation mechanism;
27926 the process of authentication is entirely controlled
27927 by the server configuration.
27928
27929 The client presents an identity in-clear.
27930 It is probably wise for a server to only advertise,
27931 and for clients to only attempt,
27932 this authentication method on a secure (eg. under TLS) connection.
27933
27934 One possible use, compatible with the
27935 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27936 is for using X509 client certificates.
27937
27938 It thus overlaps in function with the TLS authenticator
27939 (see &<<CHAPtlsauth>>&)
27940 but is a full SMTP SASL authenticator
27941 rather than being implicit for TLS-connection carried
27942 client certificates only.
27943
27944 The examples and discussion in this chapter assume that
27945 client-certificate authentication is being done.
27946
27947 The client must present a certificate,
27948 for which it must have been requested via the
27949 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27950 (see &<<CHAPTLS>>&).
27951 For authentication to be effective the certificate should be
27952 verifiable against a trust-anchor certificate known to the server.
27953
27954 .section "External options" "SECTexternsoptions"
27955 .cindex "options" "&(external)& authenticator (server)"
27956 The &(external)& authenticator has two server options:
27957
27958 .option server_param2 external string&!! unset
27959 .option server_param3 external string&!! unset
27960 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27961 These options are expanded before the &%server_condition%& option
27962 and the result are placed in &$auth2$& and &$auth3$& resectively.
27963 If the expansion is forced to fail, authentication fails. Any other expansion
27964 failure causes a temporary error code to be returned.
27965
27966 They can be used to clarify the coding of a complex &%server_condition%&.
27967
27968 .section "Using external in a server" "SECTexternserver"
27969 .cindex "AUTH" "in &(external)& authenticator"
27970 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27971         "in &(external)& authenticator"
27972 .vindex "&$auth1$&, &$auth2$&, etc"
27973 .cindex "base64 encoding" "in &(external)& authenticator"
27974
27975 When running as a server, &(external)& performs the authentication test by
27976 expanding a string. The data sent by the client with the AUTH command, or in
27977 response to subsequent prompts, is base64 encoded, and so may contain any byte
27978 values when decoded. The decoded value is treated as
27979 an identity for authentication and
27980 placed in the expansion variable &$auth1$&.
27981
27982 For compatibility with previous releases of Exim, the value is also placed in
27983 the expansion variable &$1$&. However, the use of this
27984 variable for this purpose is now deprecated, as it can lead to confusion in
27985 string expansions that also use them for other things.
27986
27987 .vindex "&$authenticated_id$&"
27988 Once an identity has been received,
27989 &%server_condition%& is expanded. If the expansion is forced to fail,
27990 authentication fails. Any other expansion failure causes a temporary error code
27991 to be returned. If the result of a successful expansion is an empty string,
27992 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27993 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27994 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27995 For any other result, a temporary error code is returned, with the expanded
27996 string as the error text.
27997
27998 Example:
27999 .code
28000 ext_ccert_san_mail:
28001   driver =            external
28002   public_name =       EXTERNAL
28003
28004   server_advertise_condition = $tls_in_certificate_verified
28005   server_param2 =     ${certextract {subj_altname,mail,>:} \
28006                                     {$tls_in_peercert}}
28007   server_condition =  ${if forany {$auth2} \
28008                             {eq {$item}{$auth1}}}
28009   server_set_id =     $auth1
28010 .endd
28011 This accepts a client certificate that is verifiable against any
28012 of your configured trust-anchors
28013 (which usually means the full set of public CAs)
28014 and which has a mail-SAN matching the claimed identity sent by the client.
28015
28016 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28017 The account name is therefore guessable by an opponent.
28018 TLS 1.3 protects both server and client certificates, and is not vulnerable
28019 in this way.
28020
28021
28022 .section "Using external in a client" "SECTexternclient"
28023 .cindex "options" "&(external)& authenticator (client)"
28024 The &(external)& authenticator has one client option:
28025
28026 .option client_send external string&!! unset
28027 This option is expanded and sent with the AUTH command as the
28028 identity being asserted.
28029
28030 Example:
28031 .code
28032 ext_ccert:
28033   driver =      external
28034   public_name = EXTERNAL
28035
28036   client_condition = ${if !eq{$tls_out_cipher}{}}
28037   client_send = myaccount@smarthost.example.net
28038 .endd
28039
28040
28041 .ecindex IIDexternauth1
28042 .ecindex IIDexternauth2
28043
28044
28045
28046
28047
28048 . ////////////////////////////////////////////////////////////////////////////
28049 . ////////////////////////////////////////////////////////////////////////////
28050
28051 .chapter "The tls authenticator" "CHAPtlsauth"
28052 .scindex IIDtlsauth1 "&(tls)& authenticator"
28053 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28054 .cindex "authentication" "Client Certificate"
28055 .cindex "authentication" "X509"
28056 .cindex "Certificate-based authentication"
28057 The &(tls)& authenticator provides server support for
28058 authentication based on client certificates.
28059
28060 It is not an SMTP authentication mechanism and is not
28061 advertised by the server as part of the SMTP EHLO response.
28062 It is an Exim authenticator in the sense that it affects
28063 the protocol element of the log line, can be tested for
28064 by the &%authenticated%& ACL condition, and can set
28065 the &$authenticated_id$& variable.
28066
28067 The client must present a verifiable certificate,
28068 for which it must have been requested via the
28069 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28070 (see &<<CHAPTLS>>&).
28071
28072 If an authenticator of this type is configured it is
28073 run before any SMTP-level communication is done,
28074 and can authenticate the connection.
28075 If it does, SMTP authentication is not offered.
28076
28077 A maximum of one authenticator of this type may be present.
28078
28079
28080 .cindex "options" "&(tls)& authenticator (server)"
28081 The &(tls)& authenticator has three server options:
28082
28083 .option server_param1 tls string&!! unset
28084 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28085 This option is expanded after the TLS negotiation and
28086 the result is placed in &$auth1$&.
28087 If the expansion is forced to fail, authentication fails. Any other expansion
28088 failure causes a temporary error code to be returned.
28089
28090 .option server_param2 tls string&!! unset
28091 .option server_param3 tls string&!! unset
28092 As above, for &$auth2$& and &$auth3$&.
28093
28094 &%server_param1%& may also be spelled &%server_param%&.
28095
28096
28097 Example:
28098 .code
28099 tls:
28100   driver = tls
28101   server_param1 =     ${certextract {subj_altname,mail,>:} \
28102                                     {$tls_in_peercert}}
28103   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28104                                  {forany {$auth1} \
28105                             {!= {0} \
28106                                 {${lookup ldap{ldap:///\
28107                          mailname=${quote_ldap_dn:${lc:$item}},\
28108                          ou=users,LDAP_DC?mailid} {$value}{0} \
28109                        }    }  } }}}
28110   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28111 .endd
28112 This accepts a client certificate that is verifiable against any
28113 of your configured trust-anchors
28114 (which usually means the full set of public CAs)
28115 and which has a SAN with a good account name.
28116
28117 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28118 The account name is therefore guessable by an opponent.
28119 TLS 1.3 protects both server and client certificates, and is not vulnerable
28120 in this way.
28121 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28122
28123 . An alternative might use
28124 . .code
28125 .   server_param1 = ${sha256:$tls_in_peercert}
28126 . .endd
28127 . to require one of a set of specific certs that define a given account
28128 . (the verification is still required, but mostly irrelevant).
28129 . This would help for per-device use.
28130 .
28131 . However, for the future we really need support for checking a
28132 . user cert in LDAP - which probably wants a base-64 DER.
28133
28134 .ecindex IIDtlsauth1
28135 .ecindex IIDtlsauth2
28136
28137
28138 Note that because authentication is traditionally an SMTP operation,
28139 the &%authenticated%& ACL condition cannot be used in
28140 a connect- or helo-ACL.
28141
28142
28143
28144 . ////////////////////////////////////////////////////////////////////////////
28145 . ////////////////////////////////////////////////////////////////////////////
28146
28147 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28148          "Encrypted SMTP connections"
28149 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28150 .scindex IIDencsmtp2 "SMTP" "encryption"
28151 .cindex "TLS" "on SMTP connection"
28152 .cindex "OpenSSL"
28153 .cindex "GnuTLS"
28154 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28155 Sockets Layer), is implemented by making use of the OpenSSL library or the
28156 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28157 cryptographic code in the Exim distribution itself for implementing TLS. In
28158 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28159 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28160 You also need to understand the basic concepts of encryption at a managerial
28161 level, and in particular, the way that public keys, private keys, and
28162 certificates are used.
28163
28164 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28165 connection is established, the client issues a STARTTLS command. If the
28166 server accepts this, the client and the server negotiate an encryption
28167 mechanism. If the negotiation succeeds, the data that subsequently passes
28168 between them is encrypted.
28169
28170 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28171 and if so, what cipher suite is in use, whether the client supplied a
28172 certificate, and whether or not that certificate was verified. This makes it
28173 possible for an Exim server to deny or accept certain commands based on the
28174 encryption state.
28175
28176 &*Warning*&: Certain types of firewall and certain anti-virus products can
28177 disrupt TLS connections. You need to turn off SMTP scanning for these products
28178 in order to get TLS to work.
28179
28180
28181
28182 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28183          "SECID284"
28184 .cindex "submissions protocol"
28185 .cindex "ssmtp protocol"
28186 .cindex "smtps protocol"
28187 .cindex "SMTP" "submissions protocol"
28188 .cindex "SMTP" "ssmtp protocol"
28189 .cindex "SMTP" "smtps protocol"
28190 The history of port numbers for TLS in SMTP is a little messy and has been
28191 contentious.  As of RFC 8314, the common practice of using the historically
28192 allocated port 465 for "email submission but with TLS immediately upon connect
28193 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28194 by them in preference to STARTTLS.
28195
28196 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28197 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28198 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28199
28200 This approach was, for a while, officially abandoned when encrypted SMTP was
28201 standardized, but many clients kept using it, even as the TCP port number was
28202 reassigned for other use.
28203 Thus you may encounter guidance claiming that you shouldn't enable use of
28204 this port.
28205 In practice, a number of mail-clients have only ever supported submissions,
28206 not submission with STARTTLS upgrade.
28207 Ideally, offer both submission (587) and submissions (465) service.
28208
28209 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28210 global option. Its value must be a list of port numbers;
28211 the most common use is expected to be:
28212 .code
28213 tls_on_connect_ports = 465
28214 .endd
28215 The port numbers specified by this option apply to all SMTP connections, both
28216 via the daemon and via &'inetd'&. You still need to specify all the ports that
28217 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28218 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28219 an extra port &-- rather, it specifies different behaviour on a port that is
28220 defined elsewhere.
28221
28222 There is also a &%-tls-on-connect%& command line option. This overrides
28223 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28224
28225
28226
28227
28228
28229
28230 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28231 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28232 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28233 To build Exim to use OpenSSL you need to set
28234 .code
28235 USE_OPENSSL=yes
28236 .endd
28237 in Local/Makefile.
28238
28239 To build Exim to use GnuTLS, you need to set
28240 .code
28241 USE_GNUTLS=yes
28242 .endd
28243 in Local/Makefile.
28244
28245 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28246 include files and libraries for GnuTLS can be found.
28247
28248 There are some differences in usage when using GnuTLS instead of OpenSSL:
28249
28250 .ilist
28251 The &%tls_verify_certificates%& option
28252 cannot be the path of a directory
28253 for GnuTLS versions before 3.3.6
28254 (for later versions, or OpenSSL, it can be either).
28255 .next
28256 The default value for &%tls_dhparam%& differs for historical reasons.
28257 .next
28258 .vindex "&$tls_in_peerdn$&"
28259 .vindex "&$tls_out_peerdn$&"
28260 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28261 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28262 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28263 .next
28264 OpenSSL identifies cipher suites using hyphens as separators, for example:
28265 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28266 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28267 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28268 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28269 to handle its own older variants) when processing lists of cipher suites in the
28270 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28271 option).
28272 .next
28273 The &%tls_require_ciphers%& options operate differently, as described in the
28274 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28275 .next
28276 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28277 When using OpenSSL, this option is ignored.
28278 (If an API is found to let OpenSSL be configured in this way,
28279 let the Exim Maintainers know and we'll likely use it).
28280 .next
28281 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28282 main option, it must be ordered to match the &%tls_certificate%& list.
28283 .next
28284 Some other recently added features may only be available in one or the other.
28285 This should be documented with the feature.  If the documentation does not
28286 explicitly state that the feature is infeasible in the other TLS
28287 implementation, then patches are welcome.
28288 .endlist
28289
28290
28291 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28292 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28293 an explicit path; if the latter, then the text about generation still applies,
28294 but not the chosen filename.
28295 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28296 See the documentation of &%tls_dhparam%& for more information.
28297
28298 GnuTLS uses D-H parameters that may take a substantial amount of time
28299 to compute. It is unreasonable to re-compute them for every TLS session.
28300 Therefore, Exim keeps this data in a file in its spool directory, called
28301 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28302 of bits requested.
28303 The file is owned by the Exim user and is readable only by
28304 its owner. Every Exim process that start up GnuTLS reads the D-H
28305 parameters from this file. If the file does not exist, the first Exim process
28306 that needs it computes the data and writes it to a temporary file which is
28307 renamed once it is complete. It does not matter if several Exim processes do
28308 this simultaneously (apart from wasting a few resources). Once a file is in
28309 place, new Exim processes immediately start using it.
28310
28311 For maximum security, the parameters that are stored in this file should be
28312 recalculated periodically, the frequency depending on your paranoia level.
28313 If you are avoiding using the fixed D-H primes published in RFCs, then you
28314 are concerned about some advanced attacks and will wish to do this; if you do
28315 not regenerate then you might as well stick to the standard primes.
28316
28317 Arranging this is easy in principle; just delete the file when you want new
28318 values to be computed. However, there may be a problem. The calculation of new
28319 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28320 If the system is not very active, &_/dev/random_& may delay returning data
28321 until enough randomness (entropy) is available. This may cause Exim to hang for
28322 a substantial amount of time, causing timeouts on incoming connections.
28323
28324 The solution is to generate the parameters externally to Exim. They are stored
28325 in &_gnutls-params-N_& in PEM format, which means that they can be
28326 generated externally using the &(certtool)& command that is part of GnuTLS.
28327
28328 To replace the parameters with new ones, instead of deleting the file
28329 and letting Exim re-create it, you can generate new parameters using
28330 &(certtool)& and, when this has been done, replace Exim's cache file by
28331 renaming. The relevant commands are something like this:
28332 .code
28333 # ls
28334 [ look for file; assume gnutls-params-2236 is the most recent ]
28335 # rm -f new-params
28336 # touch new-params
28337 # chown exim:exim new-params
28338 # chmod 0600 new-params
28339 # certtool --generate-dh-params --bits 2236 >>new-params
28340 # openssl dhparam -noout -text -in new-params | head
28341 [ check the first line, make sure it's not more than 2236;
28342   if it is, then go back to the start ("rm") and repeat
28343   until the size generated is at most the size requested ]
28344 # chmod 0400 new-params
28345 # mv new-params gnutls-params-2236
28346 .endd
28347 If Exim never has to generate the parameters itself, the possibility of
28348 stalling is removed.
28349
28350 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28351 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28352 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28353 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28354 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28355 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28356 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28357 which applies to all D-H usage, client or server.  If the value returned by
28358 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28359 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28360 limit, which is still much higher than Exim historically used.
28361
28362 The filename and bits used will change as the GnuTLS maintainers change the
28363 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28364 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28365 2432 bits, while NSS is limited to 2236 bits.
28366
28367 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28368 increase the chance of the generated prime actually being within acceptable
28369 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28370 procedure above.  There is no sane procedure available to Exim to double-check
28371 the size of the generated prime, so it might still be too large.
28372
28373
28374 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28375 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28376 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28377 There is a function in the OpenSSL library that can be passed a list of cipher
28378 suites before the cipher negotiation takes place. This specifies which ciphers
28379 are acceptable for TLS versions prior to 1.3.
28380 The list is colon separated and may contain names like
28381 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28382 directly to this function call.
28383 Many systems will install the OpenSSL manual-pages, so you may have
28384 &'ciphers(1)'& available to you.
28385 The following quotation from the OpenSSL
28386 documentation specifies what forms of item are allowed in the cipher string:
28387
28388 .ilist
28389 It can consist of a single cipher suite such as RC4-SHA.
28390 .next
28391 It can represent a list of cipher suites containing a certain algorithm,
28392 or cipher suites of a certain type. For example SHA1 represents all
28393 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28394 SSL v3 algorithms.
28395 .next
28396 Lists of cipher suites can be combined in a single cipher string using
28397 the + character. This is used as a logical and operation. For example
28398 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28399 algorithms.
28400 .endlist
28401
28402 Each cipher string can be optionally preceded by one of the characters &`!`&,
28403 &`-`& or &`+`&.
28404 .ilist
28405 If &`!`& is used, the ciphers are permanently deleted from the list. The
28406 ciphers deleted can never reappear in the list even if they are explicitly
28407 stated.
28408 .next
28409 If &`-`& is used, the ciphers are deleted from the list, but some or all
28410 of the ciphers can be added again by later options.
28411 .next
28412 If &`+`& is used, the ciphers are moved to the end of the list. This
28413 option does not add any new ciphers; it just moves matching existing ones.
28414 .endlist
28415
28416 If none of these characters is present, the string is interpreted as
28417 a list of ciphers to be appended to the current preference list. If the list
28418 includes any ciphers already present they will be ignored: that is, they will
28419 not be moved to the end of the list.
28420 .endlist
28421
28422 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28423 string:
28424 .code
28425 # note single-quotes to get ! past any shell history expansion
28426 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28427 .endd
28428
28429 This example will let the library defaults be permitted on the MX port, where
28430 there's probably no identity verification anyway, but ups the ante on the
28431 submission ports where the administrator might have some influence on the
28432 choice of clients used:
28433 .code
28434 # OpenSSL variant; see man ciphers(1)
28435 tls_require_ciphers = ${if =={$received_port}{25}\
28436                            {DEFAULT}\
28437                            {HIGH:!MD5:!SHA1}}
28438 .endd
28439
28440 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28441 .code
28442 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28443 .endd
28444
28445 For TLS version 1.3 the control available is less fine-grained
28446 and Exim does not provide access to it at present.
28447 The value of the &%tls_require_ciphers%& option is ignored when
28448 TLS version 1.3 is negotiated.
28449
28450 As of writing the library default cipher suite list for TLSv1.3 is
28451 .code
28452 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28453 .endd
28454
28455
28456 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28457          "SECTreqciphgnu"
28458 .cindex "GnuTLS" "specifying parameters for"
28459 .cindex "TLS" "specifying ciphers (GnuTLS)"
28460 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28461 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28462 .cindex "TLS" "specifying protocols (GnuTLS)"
28463 .cindex "TLS" "specifying priority string (GnuTLS)"
28464 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28465 The GnuTLS library allows the caller to provide a "priority string", documented
28466 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28467 ciphersuite specification in OpenSSL.
28468
28469 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28470 and controls both protocols and ciphers.
28471
28472 The &%tls_require_ciphers%& option is available both as an global option,
28473 controlling how Exim behaves as a server, and also as an option of the
28474 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28475 the value is string expanded.  The resulting string is not an Exim list and
28476 the string is given to the GnuTLS library, so that Exim does not need to be
28477 aware of future feature enhancements of GnuTLS.
28478
28479 Documentation of the strings accepted may be found in the GnuTLS manual, under
28480 "Priority strings".  This is online as
28481 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28482 but beware that this relates to GnuTLS 3, which may be newer than the version
28483 installed on your system.  If you are using GnuTLS 3,
28484 then the example code
28485 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28486 on that site can be used to test a given string.
28487
28488 For example:
28489 .code
28490 # Disable older versions of protocols
28491 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28492 .endd
28493
28494 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28495 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28496 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28497
28498 This example will let the library defaults be permitted on the MX port, where
28499 there's probably no identity verification anyway, and lowers security further
28500 by increasing compatibility; but this ups the ante on the submission ports
28501 where the administrator might have some influence on the choice of clients
28502 used:
28503 .code
28504 # GnuTLS variant
28505 tls_require_ciphers = ${if =={$received_port}{25}\
28506                            {NORMAL:%COMPAT}\
28507                            {SECURE128}}
28508 .endd
28509
28510
28511 .section "Configuring an Exim server to use TLS" "SECID182"
28512 .cindex "TLS" "configuring an Exim server"
28513 When Exim has been built with TLS support, it advertises the availability of
28514 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28515 but not to any others. The default value of this option is *, which means
28516 that STARTTLS is always advertised.  Set it to blank to never advertise;
28517 this is reasonable for systems that want to use TLS only as a client.
28518
28519 If STARTTLS is to be used you
28520 need to set some other options in order to make TLS available.
28521
28522 If a client issues a STARTTLS command and there is some configuration
28523 problem in the server, the command is rejected with a 454 error. If the client
28524 persists in trying to issue SMTP commands, all except QUIT are rejected
28525 with the error
28526 .code
28527 554 Security failure
28528 .endd
28529 If a STARTTLS command is issued within an existing TLS session, it is
28530 rejected with a 554 error code.
28531
28532 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28533 must be set to match some hosts. The default is * which matches all hosts.
28534
28535 If this is all you do, TLS encryption will be enabled but not authentication -
28536 meaning that the peer has no assurance it is actually you he is talking to.
28537 You gain protection from a passive sniffer listening on the wire but not
28538 from someone able to intercept the communication.
28539
28540 Further protection requires some further configuration at the server end.
28541
28542 To make TLS work you need to set, in the server,
28543 .code
28544 tls_certificate = /some/file/name
28545 tls_privatekey = /some/file/name
28546 .endd
28547 These options are, in fact, expanded strings, so you can make them depend on
28548 the identity of the client that is connected if you wish. The first file
28549 contains the server's X509 certificate, and the second contains the private key
28550 that goes with it. These files need to be
28551 PEM format and readable by the Exim user, and must
28552 always be given as full path names.
28553 The key must not be password-protected.
28554 They can be the same file if both the
28555 certificate and the key are contained within it. If &%tls_privatekey%& is not
28556 set, or if its expansion is forced to fail or results in an empty string, this
28557 is assumed to be the case. The certificate file may also contain intermediate
28558 certificates that need to be sent to the client to enable it to authenticate
28559 the server's certificate.
28560
28561 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28562 colon-separated lists of file paths.  Ciphers using given authentication
28563 algorithms require the presence of a suitable certificate to supply the
28564 public-key.  The server selects among the certificates to present to the
28565 client depending on the selected cipher, hence the priority ordering for
28566 ciphers will affect which certificate is used.
28567
28568 If you do not understand about certificates and keys, please try to find a
28569 source of this background information, which is not Exim-specific. (There are a
28570 few comments below in section &<<SECTcerandall>>&.)
28571
28572 &*Note*&: These options do not apply when Exim is operating as a client &--
28573 they apply only in the case of a server. If you need to use a certificate in an
28574 Exim client, you must set the options of the same names in an &(smtp)&
28575 transport.
28576
28577 With just these options, an Exim server will be able to use TLS. It does not
28578 require the client to have a certificate (but see below for how to insist on
28579 this). There is one other option that may be needed in other situations. If
28580 .code
28581 tls_dhparam = /some/file/name
28582 .endd
28583 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28584 with the parameters contained in the file.
28585 Set this to &`none`& to disable use of DH entirely, by making no prime
28586 available:
28587 .code
28588 tls_dhparam = none
28589 .endd
28590 This may also be set to a string identifying a standard prime to be used for
28591 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28592 used is &`ike23`&.  There are a few standard primes available, see the
28593 documentation for &%tls_dhparam%& for the complete list.
28594
28595 See the command
28596 .code
28597 openssl dhparam
28598 .endd
28599 for a way of generating file data.
28600
28601 The strings supplied for these three options are expanded every time a client
28602 host connects. It is therefore possible to use different certificates and keys
28603 for different hosts, if you so wish, by making use of the client's IP address
28604 in &$sender_host_address$& to control the expansion. If a string expansion is
28605 forced to fail, Exim behaves as if the option is not set.
28606
28607 .cindex "cipher" "logging"
28608 .cindex "log" "TLS cipher"
28609 .vindex "&$tls_in_cipher$&"
28610 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28611 an incoming TLS connection. It is included in the &'Received:'& header of an
28612 incoming message (by default &-- you can, of course, change this), and it is
28613 also included in the log line that records a message's arrival, keyed by
28614 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28615 condition can be used to test for specific cipher suites in ACLs.
28616
28617 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28618 can check the name of the cipher suite and vary their actions accordingly. The
28619 cipher suite names vary, depending on which TLS library is being used. For
28620 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28621 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28622 documentation for more details.
28623
28624 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28625 (again depending on the &%tls_cipher%& log selector).
28626
28627
28628 .section "Requesting and verifying client certificates" "SECID183"
28629 .cindex "certificate" "verification of client"
28630 .cindex "TLS" "client certificate verification"
28631 If you want an Exim server to request a certificate when negotiating a TLS
28632 session with a client, you must set either &%tls_verify_hosts%& or
28633 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28634 apply to all TLS connections. For any host that matches one of these options,
28635 Exim requests a certificate as part of the setup of the TLS session. The
28636 contents of the certificate are verified by comparing it with a list of
28637 expected trust-anchors or certificates.
28638 These may be the system default set (depending on library version),
28639 an explicit file or,
28640 depending on library version, a directory, identified by
28641 &%tls_verify_certificates%&.
28642
28643 A file can contain multiple certificates, concatenated end to end. If a
28644 directory is used
28645 (OpenSSL only),
28646 each certificate must be in a separate file, with a name (or a symbolic link)
28647 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28648 certificate. You can compute the relevant hash by running the command
28649 .code
28650 openssl x509 -hash -noout -in /cert/file
28651 .endd
28652 where &_/cert/file_& contains a single certificate.
28653
28654 There is no checking of names of the client against the certificate
28655 Subject Name or Subject Alternate Names.
28656
28657 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28658 what happens if the client does not supply a certificate, or if the certificate
28659 does not match any of the certificates in the collection named by
28660 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28661 attempt to set up a TLS session is aborted, and the incoming connection is
28662 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28663 session continues. ACLs that run for subsequent SMTP commands can detect the
28664 fact that no certificate was verified, and vary their actions accordingly. For
28665 example, you can insist on a certificate before accepting a message for
28666 relaying, but not when the message is destined for local delivery.
28667
28668 .vindex "&$tls_in_peerdn$&"
28669 When a client supplies a certificate (whether it verifies or not), the value of
28670 the Distinguished Name of the certificate is made available in the variable
28671 &$tls_in_peerdn$& during subsequent processing of the message.
28672
28673 .cindex "log" "distinguished name"
28674 Because it is often a long text string, it is not included in the log line or
28675 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28676 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28677 &%received_header_text%& to change the &'Received:'& header. When no
28678 certificate is supplied, &$tls_in_peerdn$& is empty.
28679
28680
28681 .section "Revoked certificates" "SECID184"
28682 .cindex "TLS" "revoked certificates"
28683 .cindex "revocation list"
28684 .cindex "certificate" "revocation list"
28685 .cindex "OCSP" "stapling"
28686 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28687 certificates are revoked. If you have such a list, you can pass it to an Exim
28688 server using the global option called &%tls_crl%& and to an Exim client using
28689 an identically named option for the &(smtp)& transport. In each case, the value
28690 of the option is expanded and must then be the name of a file that contains a
28691 CRL in PEM format.
28692 The downside is that clients have to periodically re-download a potentially huge
28693 file from every certificate authority they know of.
28694
28695 The way with most moving parts at query time is Online Certificate
28696 Status Protocol (OCSP), where the client verifies the certificate
28697 against an OCSP server run by the CA.  This lets the CA track all
28698 usage of the certs.  It requires running software with access to the
28699 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28700 is based on HTTP and can be proxied accordingly.
28701
28702 The only widespread OCSP server implementation (known to this writer)
28703 comes as part of OpenSSL and aborts on an invalid request, such as
28704 connecting to the port and then disconnecting.  This requires
28705 re-entering the passphrase each time some random client does this.
28706
28707 The third way is OCSP Stapling; in this, the server using a certificate
28708 issued by the CA periodically requests an OCSP proof of validity from
28709 the OCSP server, then serves it up inline as part of the TLS
28710 negotiation.   This approach adds no extra round trips, does not let the
28711 CA track users, scales well with number of certs issued by the CA and is
28712 resilient to temporary OCSP server failures, as long as the server
28713 starts retrying to fetch an OCSP proof some time before its current
28714 proof expires.  The downside is that it requires server support.
28715
28716 Unless Exim is built with the support disabled,
28717 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28718 support for OCSP stapling is included.
28719
28720 There is a global option called &%tls_ocsp_file%&.
28721 The file specified therein is expected to be in DER format, and contain
28722 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28723 option will be re-expanded for SNI, if the &%tls_certificate%& option
28724 contains &`tls_in_sni`&, as per other TLS options.
28725
28726 Exim does not at this time implement any support for fetching a new OCSP
28727 proof.  The burden is on the administrator to handle this, outside of
28728 Exim.  The file specified should be replaced atomically, so that the
28729 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28730 on each connection, so a new file will be handled transparently on the
28731 next connection.
28732
28733 When built with OpenSSL Exim will check for a valid next update timestamp
28734 in the OCSP proof; if not present, or if the proof has expired, it will be
28735 ignored.
28736
28737 For the client to be able to verify the stapled OCSP the server must
28738 also supply, in its stapled information, any intermediate
28739 certificates for the chain leading to the OCSP proof from the signer
28740 of the server certificate.  There may be zero or one such. These
28741 intermediate certificates should be added to the server OCSP stapling
28742 file named by &%tls_ocsp_file%&.
28743
28744 Note that the proof only covers the terminal server certificate,
28745 not any of the chain from CA to it.
28746
28747 There is no current way to staple a proof for a client certificate.
28748
28749 .code
28750   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28751   OCSP server is supplied.  The server URL may be included in the
28752   server certificate, if the CA is helpful.
28753
28754   One failure mode seen was the OCSP Signer cert expiring before the end
28755   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28756   noted this as invalid overall, but the re-fetch script did not.
28757 .endd
28758
28759
28760
28761
28762 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28763 .cindex "cipher" "logging"
28764 .cindex "log" "TLS cipher"
28765 .cindex "log" "distinguished name"
28766 .cindex "TLS" "configuring an Exim client"
28767 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28768 deliveries as well as to incoming, the latter one causing logging of the
28769 server certificate's DN. The remaining client configuration for TLS is all
28770 within the &(smtp)& transport.
28771
28772 It is not necessary to set any options to have TLS work in the &(smtp)&
28773 transport. If Exim is built with TLS support, and TLS is advertised by a
28774 server, the &(smtp)& transport always tries to start a TLS session. However,
28775 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28776 transport) to a list of server hosts for which TLS should not be used.
28777
28778 If you do not want Exim to attempt to send messages unencrypted when an attempt
28779 to set up an encrypted connection fails in any way, you can set
28780 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28781 those hosts, delivery is always deferred if an encrypted connection cannot be
28782 set up. If there are any other hosts for the address, they are tried in the
28783 usual way.
28784
28785 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28786 the message unencrypted. It always does this if the response to STARTTLS is
28787 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28788 session after a success response code, what happens is controlled by the
28789 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28790 delivery to this host is deferred, and other hosts (if available) are tried. If
28791 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28792 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28793 negotiation fails, Exim closes the current connection (because it is in an
28794 unknown state), opens a new one to the same host, and then tries the delivery
28795 unencrypted.
28796
28797 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28798 transport provide the client with a certificate, which is passed to the server
28799 if it requests it. If the server is Exim, it will request a certificate only if
28800 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28801
28802 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
28803 for client use (they are usable for server use).
28804 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
28805 in failed connections.
28806
28807 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28808 specifies a collection of expected server certificates.
28809 These may be
28810 the system default set (depending on library version),
28811 a file,
28812 or (depending on library version) a directory.
28813 The client verifies the server's certificate
28814 against this collection, taking into account any revoked certificates that are
28815 in the list defined by &%tls_crl%&.
28816 Failure to verify fails the TLS connection unless either of the
28817 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28818
28819 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28820 certificate verification to the listed servers.  Verification either must
28821 or need not succeed respectively.
28822
28823 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28824 checks are made: that the host name (the one in the DNS A record)
28825 is valid for the certificate.
28826 The option defaults to always checking.
28827
28828 The &(smtp)& transport has two OCSP-related options:
28829 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28830 is requested and required for the connection to proceed.  The default
28831 value is empty.
28832 &%hosts_request_ocsp%&; a host-list for which (additionally)
28833 a Certificate Status is requested (but not necessarily verified).  The default
28834 value is "*" meaning that requests are made unless configured
28835 otherwise.
28836
28837 The host(s) should also be in &%hosts_require_tls%&, and
28838 &%tls_verify_certificates%& configured for the transport,
28839 for OCSP to be relevant.
28840
28841 If
28842 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28843 list of permitted cipher suites. If either of these checks fails, delivery to
28844 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28845 alternative hosts, if any.
28846
28847  &*Note*&:
28848 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28849 is operating as a client. Exim does not assume that a server certificate (set
28850 by the global options of the same name) should also be used when operating as a
28851 client.
28852
28853 .vindex "&$host$&"
28854 .vindex "&$host_address$&"
28855 All the TLS options in the &(smtp)& transport are expanded before use, with
28856 &$host$& and &$host_address$& containing the name and address of the server to
28857 which the client is connected. Forced failure of an expansion causes Exim to
28858 behave as if the relevant option were unset.
28859
28860 .vindex &$tls_out_bits$&
28861 .vindex &$tls_out_cipher$&
28862 .vindex &$tls_out_peerdn$&
28863 .vindex &$tls_out_sni$&
28864 Before an SMTP connection is established, the
28865 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28866 variables are emptied. (Until the first connection, they contain the values
28867 that were set when the message was received.) If STARTTLS is subsequently
28868 successfully obeyed, these variables are set to the relevant values for the
28869 outgoing connection.
28870
28871
28872
28873 .section "Use of TLS Server Name Indication" "SECTtlssni"
28874 .cindex "TLS" "Server Name Indication"
28875 .vindex "&$tls_in_sni$&"
28876 .oindex "&%tls_in_sni%&"
28877 With TLS1.0 or above, there is an extension mechanism by which extra
28878 information can be included at various points in the protocol.  One of these
28879 extensions, documented in RFC 6066 (and before that RFC 4366) is
28880 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28881 client in the initial handshake, so that the server can examine the servername
28882 within and possibly choose to use different certificates and keys (and more)
28883 for this session.
28884
28885 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28886 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28887 address.
28888
28889 With SMTP to MX, there are the same problems here as in choosing the identity
28890 against which to validate a certificate: you can't rely on insecure DNS to
28891 provide the identity which you then cryptographically verify.  So this will
28892 be of limited use in that environment.
28893
28894 With SMTP to Submission, there is a well-defined hostname which clients are
28895 connecting to and can validate certificates against.  Thus clients &*can*&
28896 choose to include this information in the TLS negotiation.  If this becomes
28897 wide-spread, then hosters can choose to present different certificates to
28898 different clients.  Or even negotiate different cipher suites.
28899
28900 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28901 if not empty, will be sent on a TLS session as part of the handshake.  There's
28902 nothing more to it.  Choosing a sensible value not derived insecurely is the
28903 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28904 for the lifetime of the client connection (including during authentication).
28905
28906 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28907 received from a client.
28908 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28909
28910 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28911 option (prior to expansion) then the following options will be re-expanded
28912 during TLS session handshake, to permit alternative values to be chosen:
28913
28914 .ilist
28915 &%tls_certificate%&
28916 .next
28917 &%tls_crl%&
28918 .next
28919 &%tls_privatekey%&
28920 .next
28921 &%tls_verify_certificates%&
28922 .next
28923 &%tls_ocsp_file%&
28924 .endlist
28925
28926 Great care should be taken to deal with matters of case, various injection
28927 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28928 can always be referenced; it is important to remember that &$tls_in_sni$& is
28929 arbitrary unverified data provided prior to authentication.
28930 Further, the initial certificate is loaded before SNI has arrived, so
28931 an expansion for &%tls_certificate%& must have a default which is used
28932 when &$tls_in_sni$& is empty.
28933
28934 The Exim developers are proceeding cautiously and so far no other TLS options
28935 are re-expanded.
28936
28937 When Exim is built against OpenSSL, OpenSSL must have been built with support
28938 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28939 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28940 see &`-servername`& in the output, then OpenSSL has support.
28941
28942 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28943 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28944 built, then you have SNI support).
28945
28946
28947
28948 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28949          "SECTmulmessam"
28950 .cindex "multiple SMTP deliveries with TLS"
28951 .cindex "TLS" "multiple message deliveries"
28952 Exim sends multiple messages down the same TCP/IP connection by starting up
28953 an entirely new delivery process for each message, passing the socket from
28954 one process to the next. This implementation does not fit well with the use
28955 of TLS, because there is quite a lot of state information associated with a TLS
28956 connection, not just a socket identification. Passing all the state information
28957 to a new process is not feasible. Consequently, for sending using TLS Exim
28958 starts an additional proxy process for handling the encryption, piping the
28959 unencrypted data stream from and to the delivery processes.
28960
28961 An older mode of operation can be enabled on a per-host basis by the
28962 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28963 this list the proxy process described above is not used; instead Exim
28964 shuts down an existing TLS session being run by the delivery process
28965 before passing the socket to a new process. The new process may then
28966 try to start a new TLS session, and if successful, may try to re-authenticate
28967 if AUTH is in use, before sending the next message.
28968
28969 The RFC is not clear as to whether or not an SMTP session continues in clear
28970 after TLS has been shut down, or whether TLS may be restarted again later, as
28971 just described. However, if the server is Exim, this shutdown and
28972 reinitialization works. It is not known which (if any) other servers operate
28973 successfully if the client closes a TLS session and continues with unencrypted
28974 SMTP, but there are certainly some that do not work. For such servers, Exim
28975 should not pass the socket to another process, because the failure of the
28976 subsequent attempt to use it would cause Exim to record a temporary host error,
28977 and delay other deliveries to that host.
28978
28979 To test for this case, Exim sends an EHLO command to the server after
28980 closing down the TLS session. If this fails in any way, the connection is
28981 closed instead of being passed to a new delivery process, but no retry
28982 information is recorded.
28983
28984 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28985 &(smtp)& transport to match those hosts for which Exim should not pass
28986 connections to new processes if TLS has been used.
28987
28988
28989
28990
28991 .section "Certificates and all that" "SECTcerandall"
28992 .cindex "certificate" "references to discussion"
28993 In order to understand fully how TLS works, you need to know about
28994 certificates, certificate signing, and certificate authorities.
28995 This is a large topic and an introductory guide is unsuitable for the Exim
28996 reference manual, so instead we provide pointers to existing documentation.
28997
28998 The Apache web-server was for a long time the canonical guide, so their
28999 documentation is a good place to start; their SSL module's Introduction
29000 document is currently at
29001 .display
29002 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29003 .endd
29004 and their FAQ is at
29005 .display
29006 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29007 .endd
29008
29009 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29010 0-201-61598-3) in 2001, contains both introductory and more in-depth
29011 descriptions.
29012 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29013 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29014 Ivan is the author of the popular TLS testing tools at
29015 &url(https://www.ssllabs.com/).
29016
29017
29018 .section "Certificate chains" "SECID186"
29019 The file named by &%tls_certificate%& may contain more than one
29020 certificate. This is useful in the case where the certificate that is being
29021 sent is validated by an intermediate certificate which the other end does
29022 not have. Multiple certificates must be in the correct order in the file.
29023 First the host's certificate itself, then the first intermediate
29024 certificate to validate the issuer of the host certificate, then the next
29025 intermediate certificate to validate the issuer of the first intermediate
29026 certificate, and so on, until finally (optionally) the root certificate.
29027 The root certificate must already be trusted by the recipient for
29028 validation to succeed, of course, but if it's not preinstalled, sending the
29029 root certificate along with the rest makes it available for the user to
29030 install if the receiving end is a client MUA that can interact with a user.
29031
29032 Note that certificates using MD5 are unlikely to work on today's Internet;
29033 even if your libraries allow loading them for use in Exim when acting as a
29034 server, increasingly clients will not accept such certificates.  The error
29035 diagnostics in such a case can be frustratingly vague.
29036
29037
29038
29039 .section "Self-signed certificates" "SECID187"
29040 .cindex "certificate" "self-signed"
29041 You can create a self-signed certificate using the &'req'& command provided
29042 with OpenSSL, like this:
29043 . ==== Do not shorten the duration here without reading and considering
29044 . ==== the text below.  Please leave it at 9999 days.
29045 .code
29046 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29047             -days 9999 -nodes
29048 .endd
29049 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29050 delimited and so can be identified independently. The &%-days%& option
29051 specifies a period for which the certificate is valid. The &%-nodes%& option is
29052 important: if you do not set it, the key is encrypted with a passphrase
29053 that you are prompted for, and any use that is made of the key causes more
29054 prompting for the passphrase. This is not helpful if you are going to use
29055 this certificate and key in an MTA, where prompting is not possible.
29056
29057 . ==== I expect to still be working 26 years from now.  The less technical
29058 . ==== debt I create, in terms of storing up trouble for my later years, the
29059 . ==== happier I will be then.  We really have reached the point where we
29060 . ==== should start, at the very least, provoking thought and making folks
29061 . ==== pause before proceeding, instead of leaving all the fixes until two
29062 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29063 . ==== -pdp, 2012
29064 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29065 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29066 the above command might produce a date in the past.  Think carefully about
29067 the lifetime of the systems you're deploying, and either reduce the duration
29068 of the certificate or reconsider your platform deployment.  (At time of
29069 writing, reducing the duration is the most likely choice, but the inexorable
29070 progression of time takes us steadily towards an era where this will not
29071 be a sensible resolution).
29072
29073 A self-signed certificate made in this way is sufficient for testing, and
29074 may be adequate for all your requirements if you are mainly interested in
29075 encrypting transfers, and not in secure identification.
29076
29077 However, many clients require that the certificate presented by the server be a
29078 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29079 certificate. In this situation, the self-signed certificate described above
29080 must be installed on the client host as a trusted root &'certification
29081 authority'& (CA), and the certificate used by Exim must be a user certificate
29082 signed with that self-signed certificate.
29083
29084 For information on creating self-signed CA certificates and using them to sign
29085 user certificates, see the &'General implementation overview'& chapter of the
29086 Open-source PKI book, available online at
29087 &url(https://sourceforge.net/projects/ospkibook/).
29088 .ecindex IIDencsmtp1
29089 .ecindex IIDencsmtp2
29090
29091
29092
29093 .section DANE "SECDANE"
29094 .cindex DANE
29095 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29096 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29097 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29098 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29099 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29100 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29101
29102 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29103 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29104 by (a) is thought to be smaller than that of the set of root CAs.
29105
29106 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29107 fail to pass on a server's STARTTLS.
29108
29109 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29110 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29111 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29112
29113 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29114 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29115 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29116 DNSSEC.
29117 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29118 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29119
29120 There are no changes to Exim specific to server-side operation of DANE.
29121 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29122 in &_Local/Makefile_&.
29123 If it has been included, the macro "_HAVE_DANE" will be defined.
29124
29125 A TLSA record consist of 4 fields, the "Certificate Usage", the
29126 "Selector", the "Matching type", and the "Certificate Association Data".
29127 For a detailed description of the TLSA record see
29128 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29129
29130 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29131 These are the "Trust Anchor" and "End Entity" variants.
29132 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29133 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29134 this is appropriate for a single system, using a self-signed certificate.
29135 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29136 well-known one.
29137 A private CA at simplest is just a self-signed certificate (with certain
29138 attributes) which is used to sign server certificates, but running one securely
29139 does require careful arrangement.
29140 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29141 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29142 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29143 all of which point to a single TLSA record.
29144 DANE-TA and DANE-EE can both be used together.
29145
29146 Our recommendation is to use DANE with a certificate from a public CA,
29147 because this enables a variety of strategies for remote clients to verify
29148 your certificate.
29149 You can then publish information both via DANE and another technology,
29150 "MTA-STS", described below.
29151
29152 When you use DANE-TA to publish trust anchor information, you ask entities
29153 outside your administrative control to trust the Certificate Authority for
29154 connections to you.
29155 If using a private CA then you should expect others to still apply the
29156 technical criteria they'd use for a public CA to your certificates.
29157 In particular, you should probably try to follow current best practices for CA
29158 operation around hash algorithms and key sizes.
29159 Do not expect other organizations to lower their security expectations just
29160 because a particular profile might be reasonable for your own internal use.
29161
29162 When this text was last updated, this in practice means to avoid use of SHA-1
29163 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29164 than 4096, for interoperability); to use keyUsage fields correctly; to use
29165 random serial numbers.
29166 The list of requirements is subject to change as best practices evolve.
29167 If you're not already using a private CA, or it doesn't meet these
29168 requirements, then we encourage you to avoid all these issues and use a public
29169 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29170
29171 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29172 a "Matching Type" (3rd) field of SHA2-512(2).
29173
29174 For the "Certificate Authority Data" (4th) field, commands like
29175
29176 .code
29177   openssl x509 -pubkey -noout <certificate.pem \
29178   | openssl rsa -outform der -pubin 2>/dev/null \
29179   | openssl sha512 \
29180   | awk '{print $2}'
29181 .endd
29182
29183 are workable to create a hash of the certificate's public key.
29184
29185 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29186
29187 .code
29188   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29189 .endd
29190
29191 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29192 is useful for quickly generating TLSA records.
29193
29194
29195 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29196
29197 The Certificate issued by the CA published in the DANE-TA model should be
29198 issued using a strong hash algorithm.
29199 Exim, and importantly various other MTAs sending to you, will not
29200 re-enable hash algorithms which have been disabled by default in TLS
29201 libraries.
29202 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29203 interoperability (and probably the maximum too, in 2018).
29204
29205 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29206 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29207 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29208
29209 .code
29210   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29211                                  {= {4}{$tls_out_tlsa_usage}} } \
29212                          {*}{}}
29213 .endd
29214
29215 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29216 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29217 found. If the definition of &%hosts_request_ocsp%& includes the
29218 string "tls_out_tlsa_usage", they are re-expanded in time to
29219 control the OCSP request.
29220
29221 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29222 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29223
29224
29225 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29226 and &%dane_require_tls_ciphers%&.
29227 The &"require"& variant will result in failure if the target host is not
29228 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29229 the &%dnssec_request_domains%& router or transport option.
29230
29231 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29232
29233 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29234 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29235 will be required for the host.  If it does not, the host will not
29236 be used; there is no fallback to non-DANE or non-TLS.
29237
29238 If DANE is requested and usable, then the TLS cipher list configuration
29239 prefers to use the option &%dane_require_tls_ciphers%& and falls
29240 back to &%tls_require_ciphers%& only if that is unset.
29241 This lets you configure "decent crypto" for DANE and "better than nothing
29242 crypto" as the default.  Note though that while GnuTLS lets the string control
29243 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29244 limited to ciphersuite constraints.
29245
29246 If DANE is requested and useable (see above) the following transport options are ignored:
29247 .code
29248   hosts_require_tls
29249   tls_verify_hosts
29250   tls_try_verify_hosts
29251   tls_verify_certificates
29252   tls_crl
29253   tls_verify_cert_hostnames
29254 .endd
29255
29256 If DANE is not usable, whether requested or not, and CA-anchored
29257 verification evaluation is wanted, the above variables should be set appropriately.
29258
29259 The router and transport option &%dnssec_request_domains%& must not be
29260 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29261
29262 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29263
29264 There is a new variable &$tls_out_dane$& which will have "yes" if
29265 verification succeeded using DANE and "no" otherwise (only useful
29266 in combination with events; see &<<CHAPevents>>&),
29267 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29268
29269 .cindex DANE reporting
29270 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29271 to achieve DANE-verified connection, if one was either requested and offered, or
29272 required.  This is intended to support TLS-reporting as defined in
29273 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29274 The &$event_data$& will be one of the Result Types defined in
29275 Section 4.3 of that document.
29276
29277 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29278
29279 DANE is specified in published RFCs and decouples certificate authority trust
29280 selection from a "race to the bottom" of "you must trust everything for mail
29281 to get through".  There is an alternative technology called MTA-STS, which
29282 instead publishes MX trust anchor information on an HTTPS website.  At the
29283 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29284 Exim has no support for MTA-STS as a client, but Exim mail server operators
29285 can choose to publish information describing their TLS configuration using
29286 MTA-STS to let those clients who do use that protocol derive trust
29287 information.
29288
29289 The MTA-STS design requires a certificate from a public Certificate Authority
29290 which is recognized by clients sending to you.
29291 That selection of which CAs are trusted by others is outside your control.
29292
29293 The most interoperable course of action is probably to use
29294 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29295 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29296 records for DANE clients (such as Exim and Postfix) and to publish anchor
29297 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29298 domain itself (with caveats around occasionally broken MTA-STS because of
29299 incompatible specification changes prior to reaching RFC status).
29300
29301
29302
29303 . ////////////////////////////////////////////////////////////////////////////
29304 . ////////////////////////////////////////////////////////////////////////////
29305
29306 .chapter "Access control lists" "CHAPACL"
29307 .scindex IIDacl "&ACL;" "description"
29308 .cindex "control of incoming mail"
29309 .cindex "message" "controlling incoming"
29310 .cindex "policy control" "access control lists"
29311 Access Control Lists (ACLs) are defined in a separate section of the runtime
29312 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29313 name, terminated by a colon. Here is a complete ACL section that contains just
29314 one very small ACL:
29315 .code
29316 begin acl
29317 small_acl:
29318   accept   hosts = one.host.only
29319 .endd
29320 You can have as many lists as you like in the ACL section, and the order in
29321 which they appear does not matter. The lists are self-terminating.
29322
29323 The majority of ACLs are used to control Exim's behaviour when it receives
29324 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29325 when a local process submits a message using SMTP by specifying the &%-bs%&
29326 option. The most common use is for controlling which recipients are accepted
29327 in incoming messages. In addition, you can define an ACL that is used to check
29328 local non-SMTP messages. The default configuration file contains an example of
29329 a realistic ACL for checking RCPT commands. This is discussed in chapter
29330 &<<CHAPdefconfil>>&.
29331
29332
29333 .section "Testing ACLs" "SECID188"
29334 The &%-bh%& command line option provides a way of testing your ACL
29335 configuration locally by running a fake SMTP session with which you interact.
29336
29337
29338 .section "Specifying when ACLs are used" "SECID189"
29339 .cindex "&ACL;" "options for specifying"
29340 In order to cause an ACL to be used, you have to name it in one of the relevant
29341 options in the main part of the configuration. These options are:
29342 .cindex "AUTH" "ACL for"
29343 .cindex "DATA" "ACLs for"
29344 .cindex "ETRN" "ACL for"
29345 .cindex "EXPN" "ACL for"
29346 .cindex "HELO" "ACL for"
29347 .cindex "EHLO" "ACL for"
29348 .cindex "DKIM" "ACL for"
29349 .cindex "MAIL" "ACL for"
29350 .cindex "QUIT, ACL for"
29351 .cindex "RCPT" "ACL for"
29352 .cindex "STARTTLS, ACL for"
29353 .cindex "VRFY" "ACL for"
29354 .cindex "SMTP" "connection, ACL for"
29355 .cindex "non-SMTP messages" "ACLs for"
29356 .cindex "MIME content scanning" "ACL for"
29357 .cindex "PRDR" "ACL for"
29358
29359 .table2 140pt
29360 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29361 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29362 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29363 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29364 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29365 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29366 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29367 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29368 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29369 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29370 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29371 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29372 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29373 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29374 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29375 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29376 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29377 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29378 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29379 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29380 .endtable
29381
29382 For example, if you set
29383 .code
29384 acl_smtp_rcpt = small_acl
29385 .endd
29386 the little ACL defined above is used whenever Exim receives a RCPT command
29387 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29388 done when RCPT commands arrive. A rejection of RCPT should cause the
29389 sending MTA to give up on the recipient address contained in the RCPT
29390 command, whereas rejection at other times may cause the client MTA to keep on
29391 trying to deliver the message. It is therefore recommended that you do as much
29392 testing as possible at RCPT time.
29393
29394
29395 .section "The non-SMTP ACLs" "SECID190"
29396 .cindex "non-SMTP messages" "ACLs for"
29397 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29398 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29399 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29400 the state of the SMTP connection such as encryption and authentication) are not
29401 relevant and are forbidden in these ACLs. However, the sender and recipients
29402 are known, so the &%senders%& and &%sender_domains%& conditions and the
29403 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29404 &$authenticated_sender$& are also available. You can specify added header lines
29405 in any of these ACLs.
29406
29407 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29408 non-SMTP message, before any of the message has been read. (This is the
29409 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29410 batched SMTP input, it runs after the DATA command has been reached. The
29411 result of this ACL is ignored; it cannot be used to reject a message. If you
29412 really need to, you could set a value in an ACL variable here and reject based
29413 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29414 controls, and in particular, it can be used to set
29415 .code
29416 control = suppress_local_fixups
29417 .endd
29418 This cannot be used in the other non-SMTP ACLs because by the time they are
29419 run, it is too late.
29420
29421 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29422 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29423
29424 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29425 kind of rejection is treated as permanent, because there is no way of sending a
29426 temporary error for these kinds of message.
29427
29428
29429 .section "The SMTP connect ACL" "SECID191"
29430 .cindex "SMTP" "connection, ACL for"
29431 .oindex &%smtp_banner%&
29432 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29433 session, after the test specified by &%host_reject_connection%& (which is now
29434 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29435 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29436 the message override the banner message that is otherwise specified by the
29437 &%smtp_banner%& option.
29438
29439
29440 .section "The EHLO/HELO ACL" "SECID192"
29441 .cindex "EHLO" "ACL for"
29442 .cindex "HELO" "ACL for"
29443 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29444 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29445 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29446 Note that a client may issue more than one EHLO or HELO command in an SMTP
29447 session, and indeed is required to issue a new EHLO or HELO after successfully
29448 setting up encryption following a STARTTLS command.
29449
29450 Note also that a deny neither forces the client to go away nor means that
29451 mail will be refused on the connection.  Consider checking for
29452 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29453
29454 If the command is accepted by an &%accept%& verb that has a &%message%&
29455 modifier, the message may not contain more than one line (it will be truncated
29456 at the first newline and a panic logged if it does). Such a message cannot
29457 affect the EHLO options that are listed on the second and subsequent lines of
29458 an EHLO response.
29459
29460
29461 .section "The DATA ACLs" "SECID193"
29462 .cindex "DATA" "ACLs for"
29463 Two ACLs are associated with the DATA command, because it is two-stage
29464 command, with two responses being sent to the client.
29465 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29466 is obeyed. This gives you control after all the RCPT commands, but before
29467 the message itself is received. It offers the opportunity to give a negative
29468 response to the DATA command before the data is transmitted. Header lines
29469 added by MAIL or RCPT ACLs are not visible at this time, but any that
29470 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29471
29472 You cannot test the contents of the message, for example, to verify addresses
29473 in the headers, at RCPT time or when the DATA command is received. Such
29474 tests have to appear in the ACL that is run after the message itself has been
29475 received, before the final response to the DATA command is sent. This is
29476 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29477 associated with the DATA command.
29478
29479 .cindex CHUNKING "BDAT command"
29480 .cindex BDAT "SMTP command"
29481 .cindex "RFC 3030" CHUNKING
29482 If CHUNKING was advertised and a BDAT command sequence is received,
29483 the &%acl_smtp_predata%& ACL is not run.
29484 . XXX why not?  It should be possible, for the first BDAT.
29485 The &%acl_smtp_data%& is run after the last BDAT command and all of
29486 the data specified is received.
29487
29488 For both of these ACLs, it is not possible to reject individual recipients. An
29489 error response rejects the entire message. Unfortunately, it is known that some
29490 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29491 before or after the data) correctly &-- they keep the message on their queues
29492 and try again later, but that is their problem, though it does waste some of
29493 your resources.
29494
29495 The &%acl_smtp_data%& ACL is run after
29496 the &%acl_smtp_data_prdr%&,
29497 the &%acl_smtp_dkim%&
29498 and the &%acl_smtp_mime%& ACLs.
29499
29500 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29501 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29502 enabled (which is the default).
29503
29504 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29505 received, and is executed for each DKIM signature found in a message.  If not
29506 otherwise specified, the default action is to accept.
29507
29508 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29509
29510 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29511
29512
29513 .section "The SMTP MIME ACL" "SECID194"
29514 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29515 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29516
29517 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29518
29519
29520 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29521 .cindex "PRDR" "ACL for"
29522 .oindex "&%prdr_enable%&"
29523 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29524 with PRDR support enabled (which is the default).
29525 It becomes active only when the PRDR feature is negotiated between
29526 client and server for a message, and more than one recipient
29527 has been accepted.
29528
29529 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29530 has been received, and is executed once for each recipient of the message
29531 with &$local_part$& and &$domain$& valid.
29532 The test may accept, defer or deny for individual recipients.
29533 The &%acl_smtp_data%& will still be called after this ACL and
29534 can reject the message overall, even if this ACL has accepted it
29535 for some or all recipients.
29536
29537 PRDR may be used to support per-user content filtering.  Without it
29538 one must defer any recipient after the first that has a different
29539 content-filter configuration.  With PRDR, the RCPT-time check
29540 .cindex "PRDR" "variable for"
29541 for this can be disabled when the variable &$prdr_requested$&
29542 is &"yes"&.
29543 Any required difference in behaviour of the main DATA-time
29544 ACL should however depend on the PRDR-time ACL having run, as Exim
29545 will avoid doing so in some situations (e.g. single-recipient mails).
29546
29547 See also the &%prdr_enable%& global option
29548 and the &%hosts_try_prdr%& smtp transport option.
29549
29550 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29551 If the ACL is not defined, processing completes as if
29552 the feature was not requested by the client.
29553
29554 .section "The QUIT ACL" "SECTQUITACL"
29555 .cindex "QUIT, ACL for"
29556 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29557 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29558 does not in fact control any access.
29559 For this reason, it may only accept
29560 or warn as its final result.
29561
29562 This ACL can be used for tasks such as custom logging at the end of an SMTP
29563 session. For example, you can use ACL variables in other ACLs to count
29564 messages, recipients, etc., and log the totals at QUIT time using one or
29565 more &%logwrite%& modifiers on a &%warn%& verb.
29566
29567 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29568 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29569
29570 You do not need to have a final &%accept%&, but if you do, you can use a
29571 &%message%& modifier to specify custom text that is sent as part of the 221
29572 response to QUIT.
29573
29574 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29575 failure (for example, failure to open a log file, or when Exim is bombing out
29576 because it has detected an unrecoverable error), all SMTP commands from the
29577 client are given temporary error responses until QUIT is received or the
29578 connection is closed. In these special cases, the QUIT ACL does not run.
29579
29580
29581 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29582 .vindex &$acl_smtp_notquit$&
29583 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29584 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29585 trouble, such as being unable to write to its log files, this ACL is not run,
29586 because it might try to do things (such as write to log files) that make the
29587 situation even worse.
29588
29589 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29590 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29591 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29592 and &%warn%&.
29593
29594 .vindex &$smtp_notquit_reason$&
29595 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29596 to a string that indicates the reason for the termination of the SMTP
29597 connection. The possible values are:
29598 .table2
29599 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29600 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29601 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29602 .irow &`connection-lost`&          "The SMTP connection has been lost"
29603 .irow &`data-timeout`&             "Timeout while reading message data"
29604 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29605 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29606 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29607 .irow &`synchronization-error`&    "SMTP synchronization error"
29608 .irow &`tls-failed`&               "TLS failed to start"
29609 .endtable
29610 In most cases when an SMTP connection is closed without having received QUIT,
29611 Exim sends an SMTP response message before actually closing the connection.
29612 With the exception of the &`acl-drop`& case, the default message can be
29613 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29614 &%drop%& verb in another ACL, it is the message from the other ACL that is
29615 used.
29616
29617
29618 .section "Finding an ACL to use" "SECID195"
29619 .cindex "&ACL;" "finding which to use"
29620 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29621 you can use different ACLs in different circumstances. For example,
29622 .code
29623 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29624                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29625 .endd
29626 In the default configuration file there are some example settings for
29627 providing an RFC 4409 message &"submission"& service on port 587 and
29628 an RFC 8314 &"submissions"& service on port 465. You can use a string
29629 expansion like this to choose an ACL for MUAs on these ports which is
29630 more appropriate for this purpose than the default ACL on port 25.
29631
29632 The expanded string does not have to be the name of an ACL in the
29633 configuration file; there are other possibilities. Having expanded the
29634 string, Exim searches for an ACL as follows:
29635
29636 .ilist
29637 If the string begins with a slash, Exim uses it as a filename, and reads its
29638 contents as an ACL. The lines are processed in the same way as lines in the
29639 Exim configuration file. In particular, continuation lines are supported, blank
29640 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29641 If the file does not exist or cannot be read, an error occurs (typically
29642 causing a temporary failure of whatever caused the ACL to be run). For example:
29643 .code
29644 acl_smtp_data = /etc/acls/\
29645   ${lookup{$sender_host_address}lsearch\
29646   {/etc/acllist}{$value}{default}}
29647 .endd
29648 This looks up an ACL file to use on the basis of the host's IP address, falling
29649 back to a default if the lookup fails. If an ACL is successfully read from a
29650 file, it is retained in memory for the duration of the Exim process, so that it
29651 can be re-used without having to re-read the file.
29652 .next
29653 If the string does not start with a slash, and does not contain any spaces,
29654 Exim searches the ACL section of the configuration for an ACL whose name
29655 matches the string.
29656 .next
29657 If no named ACL is found, or if the string contains spaces, Exim parses
29658 the string as an inline ACL. This can save typing in cases where you just
29659 want to have something like
29660 .code
29661 acl_smtp_vrfy = accept
29662 .endd
29663 in order to allow free use of the VRFY command. Such a string may contain
29664 newlines; it is processed in the same way as an ACL that is read from a file.
29665 .endlist
29666
29667
29668
29669
29670 .section "ACL return codes" "SECID196"
29671 .cindex "&ACL;" "return codes"
29672 Except for the QUIT ACL, which does not affect the SMTP return code (see
29673 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29674 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29675 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29676 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29677 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29678 This also causes a 4&'xx'& return code.
29679
29680 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29681 &"deny"&, because there is no mechanism for passing temporary errors to the
29682 submitters of non-SMTP messages.
29683
29684
29685 ACLs that are relevant to message reception may also return &"discard"&. This
29686 has the effect of &"accept"&, but causes either the entire message or an
29687 individual recipient address to be discarded. In other words, it is a
29688 blackholing facility. Use it with care.
29689
29690 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29691 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29692 RCPT ACL is to discard just the one recipient address. If there are no
29693 recipients left when the message's data is received, the DATA ACL is not
29694 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29695 remaining recipients. The &"discard"& return is not permitted for the
29696 &%acl_smtp_predata%& ACL.
29697
29698 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29699 is done on the address and the result determines the SMTP response.
29700
29701
29702 .cindex "&[local_scan()]& function" "when all recipients discarded"
29703 The &[local_scan()]& function is always run, even if there are no remaining
29704 recipients; it may create new recipients.
29705
29706
29707
29708 .section "Unset ACL options" "SECID197"
29709 .cindex "&ACL;" "unset options"
29710 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29711 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29712 not defined at all. For any defined ACL, the default action when control
29713 reaches the end of the ACL statements is &"deny"&.
29714
29715 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29716 these two are ACLs that are used only for their side effects. They cannot be
29717 used to accept or reject anything.
29718
29719 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29720 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29721 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29722 when the ACL is not defined is &"accept"&.
29723
29724 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29725 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29726 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29727 messages over an SMTP connection. For an example, see the ACL in the default
29728 configuration file.
29729
29730
29731
29732
29733 .section "Data for message ACLs" "SECID198"
29734 .cindex "&ACL;" "data for message ACL"
29735 .vindex &$domain$&
29736 .vindex &$local_part$&
29737 .vindex &$sender_address$&
29738 .vindex &$sender_host_address$&
29739 .vindex &$smtp_command$&
29740 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29741 that contain information about the host and the message's sender (for example,
29742 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29743 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29744 &$local_part$& are set from the argument address. The entire SMTP command
29745 is available in &$smtp_command$&.
29746
29747 When an ACL for the AUTH parameter of MAIL is running, the variables that
29748 contain information about the host are set, but &$sender_address$& is not yet
29749 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29750 how it is used.
29751
29752 .vindex "&$message_size$&"
29753 The &$message_size$& variable is set to the value of the SIZE parameter on
29754 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29755 that parameter is not given. The value is updated to the true message size by
29756 the time the final DATA ACL is run (after the message data has been
29757 received).
29758
29759 .vindex "&$rcpt_count$&"
29760 .vindex "&$recipients_count$&"
29761 The &$rcpt_count$& variable increases by one for each RCPT command received.
29762 The &$recipients_count$& variable increases by one each time a RCPT command is
29763 accepted, so while an ACL for RCPT is being processed, it contains the number
29764 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29765 &$rcpt_count$& contains the total number of RCPT commands, and
29766 &$recipients_count$& contains the total number of accepted recipients.
29767
29768
29769
29770
29771
29772 .section "Data for non-message ACLs" "SECTdatfornon"
29773 .cindex "&ACL;" "data for non-message ACL"
29774 .vindex &$smtp_command_argument$&
29775 .vindex &$smtp_command$&
29776 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29777 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29778 and the entire SMTP command is available in &$smtp_command$&.
29779 These variables can be tested using a &%condition%& condition. For example,
29780 here is an ACL for use with AUTH, which insists that either the session is
29781 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29782 does not permit authentication methods that use cleartext passwords on
29783 unencrypted connections.
29784 .code
29785 acl_check_auth:
29786   accept encrypted = *
29787   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29788                      {CRAM-MD5}}
29789   deny   message   = TLS encryption or CRAM-MD5 required
29790 .endd
29791 (Another way of applying this restriction is to arrange for the authenticators
29792 that use cleartext passwords not to be advertised when the connection is not
29793 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29794 option to do this.)
29795
29796
29797
29798 .section "Format of an ACL" "SECID199"
29799 .cindex "&ACL;" "format of"
29800 .cindex "&ACL;" "verbs, definition of"
29801 An individual ACL consists of a number of statements. Each statement starts
29802 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29803 Modifiers can change the way the verb operates, define error and log messages,
29804 set variables, insert delays, and vary the processing of accepted messages.
29805
29806 If all the conditions are met, the verb is obeyed. The same condition may be
29807 used (with different arguments) more than once in the same statement. This
29808 provides a means of specifying an &"and"& conjunction between conditions. For
29809 example:
29810 .code
29811 deny  dnslists = list1.example
29812       dnslists = list2.example
29813 .endd
29814 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29815 the conditions and modifiers when it reaches a condition that fails. What
29816 happens then depends on the verb (and in one case, on a special modifier). Not
29817 all the conditions make sense at every testing point. For example, you cannot
29818 test a sender address in the ACL that is run for a VRFY command.
29819
29820
29821 .section "ACL verbs" "SECID200"
29822 The ACL verbs are as follows:
29823
29824 .ilist
29825 .cindex "&%accept%& ACL verb"
29826 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29827 of the conditions are not met, what happens depends on whether &%endpass%&
29828 appears among the conditions (for syntax see below). If the failing condition
29829 is before &%endpass%&, control is passed to the next ACL statement; if it is
29830 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29831 check a RCPT command:
29832 .code
29833 accept domains = +local_domains
29834        endpass
29835        verify = recipient
29836 .endd
29837 If the recipient domain does not match the &%domains%& condition, control
29838 passes to the next statement. If it does match, the recipient is verified, and
29839 the command is accepted if verification succeeds. However, if verification
29840 fails, the ACL yields &"deny"&, because the failing condition is after
29841 &%endpass%&.
29842
29843 The &%endpass%& feature has turned out to be confusing to many people, so its
29844 use is not recommended nowadays. It is always possible to rewrite an ACL so
29845 that &%endpass%& is not needed, and it is no longer used in the default
29846 configuration.
29847
29848 .cindex "&%message%& ACL modifier" "with &%accept%&"
29849 If a &%message%& modifier appears on an &%accept%& statement, its action
29850 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29851 (when an &%accept%& verb either accepts or passes control to the next
29852 statement), &%message%& can be used to vary the message that is sent when an
29853 SMTP command is accepted. For example, in a RCPT ACL you could have:
29854 .display
29855 &`accept  `&<&'some conditions'&>
29856 &`        message = OK, I will allow you through today`&
29857 .endd
29858 You can specify an SMTP response code, optionally followed by an &"extended
29859 response code"& at the start of the message, but the first digit must be the
29860 same as would be sent by default, which is 2 for an &%accept%& verb.
29861
29862 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29863 an error message that is used when access is denied. This behaviour is retained
29864 for backward compatibility, but current &"best practice"& is to avoid the use
29865 of &%endpass%&.
29866
29867
29868 .next
29869 .cindex "&%defer%& ACL verb"
29870 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29871 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29872 &%defer%& is the same as &%deny%&, because there is no way of sending a
29873 temporary error. For a RCPT command, &%defer%& is much the same as using a
29874 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29875 be used in any ACL, and even for a recipient it might be a simpler approach.
29876
29877
29878 .next
29879 .cindex "&%deny%& ACL verb"
29880 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29881 the conditions are not met, control is passed to the next ACL statement. For
29882 example,
29883 .code
29884 deny dnslists = blackholes.mail-abuse.org
29885 .endd
29886 rejects commands from hosts that are on a DNS black list.
29887
29888
29889 .next
29890 .cindex "&%discard%& ACL verb"
29891 &%discard%&: This verb behaves like &%accept%&, except that it returns
29892 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29893 that are concerned with receiving messages. When all the conditions are true,
29894 the sending entity receives a &"success"& response. However, &%discard%& causes
29895 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29896 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29897 message's recipients are discarded. Recipients that are discarded before DATA
29898 do not appear in the log line when the &%received_recipients%& log selector is set.
29899
29900 If the &%log_message%& modifier is set when &%discard%& operates,
29901 its contents are added to the line that is automatically written to the log.
29902 The &%message%& modifier operates exactly as it does for &%accept%&.
29903
29904
29905 .next
29906 .cindex "&%drop%& ACL verb"
29907 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29908 forcibly closed after the 5&'xx'& error message has been sent. For example:
29909 .code
29910 drop   message   = I don't take more than 20 RCPTs
29911        condition = ${if > {$rcpt_count}{20}}
29912 .endd
29913 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29914 The connection is always dropped after sending a 550 response.
29915
29916 .next
29917 .cindex "&%require%& ACL verb"
29918 &%require%&: If all the conditions are met, control is passed to the next ACL
29919 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29920 example, when checking a RCPT command,
29921 .code
29922 require message = Sender did not verify
29923         verify  = sender
29924 .endd
29925 passes control to subsequent statements only if the message's sender can be
29926 verified. Otherwise, it rejects the command. Note the positioning of the
29927 &%message%& modifier, before the &%verify%& condition. The reason for this is
29928 discussed in section &<<SECTcondmodproc>>&.
29929
29930 .next
29931 .cindex "&%warn%& ACL verb"
29932 &%warn%&: If all the conditions are true, a line specified by the
29933 &%log_message%& modifier is written to Exim's main log. Control always passes
29934 to the next ACL statement. If any condition is false, the log line is not
29935 written. If an identical log line is requested several times in the same
29936 message, only one copy is actually written to the log. If you want to force
29937 duplicates to be written, use the &%logwrite%& modifier instead.
29938
29939 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29940 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29941 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29942 first failing condition. There is more about adding header lines in section
29943 &<<SECTaddheadacl>>&.
29944
29945 If any condition on a &%warn%& statement cannot be completed (that is, there is
29946 some sort of defer), the log line specified by &%log_message%& is not written.
29947 This does not include the case of a forced failure from a lookup, which
29948 is considered to be a successful completion. After a defer, no further
29949 conditions or modifiers in the &%warn%& statement are processed. The incident
29950 is logged, and the ACL continues to be processed, from the next statement
29951 onwards.
29952
29953
29954 .vindex "&$acl_verify_message$&"
29955 When one of the &%warn%& conditions is an address verification that fails, the
29956 text of the verification failure message is in &$acl_verify_message$&. If you
29957 want this logged, you must set it up explicitly. For example:
29958 .code
29959 warn   !verify = sender
29960        log_message = sender verify failed: $acl_verify_message
29961 .endd
29962 .endlist
29963
29964 At the end of each ACL there is an implicit unconditional &%deny%&.
29965
29966 As you can see from the examples above, the conditions and modifiers are
29967 written one to a line, with the first one on the same line as the verb, and
29968 subsequent ones on following lines. If you have a very long condition, you can
29969 continue it onto several physical lines by the usual backslash continuation
29970 mechanism. It is conventional to align the conditions vertically.
29971
29972
29973
29974 .section "ACL variables" "SECTaclvariables"
29975 .cindex "&ACL;" "variables"
29976 There are some special variables that can be set during ACL processing. They
29977 can be used to pass information between different ACLs, different invocations
29978 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29979 transports, and filters that are used to deliver a message. The names of these
29980 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29981 an underscore, but the remainder of the name can be any sequence of
29982 alphanumeric characters and underscores that you choose. There is no limit on
29983 the number of ACL variables. The two sets act as follows:
29984 .ilist
29985 The values of those variables whose names begin with &$acl_c$& persist
29986 throughout an SMTP connection. They are never reset. Thus, a value that is set
29987 while receiving one message is still available when receiving the next message
29988 on the same SMTP connection.
29989 .next
29990 The values of those variables whose names begin with &$acl_m$& persist only
29991 while a message is being received. They are reset afterwards. They are also
29992 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29993 .endlist
29994
29995 When a message is accepted, the current values of all the ACL variables are
29996 preserved with the message and are subsequently made available at delivery
29997 time. The ACL variables are set by a modifier called &%set%&. For example:
29998 .code
29999 accept hosts = whatever
30000        set acl_m4 = some value
30001 accept authenticated = *
30002        set acl_c_auth = yes
30003 .endd
30004 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30005 be set. If you want to set a variable without taking any action, you can use a
30006 &%warn%& verb without any other modifiers or conditions.
30007
30008 .oindex &%strict_acl_vars%&
30009 What happens if a syntactically valid but undefined ACL variable is
30010 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30011 false (the default), an empty string is substituted; if it is true, an
30012 error is generated.
30013
30014 Versions of Exim before 4.64 have a limited set of numbered variables, but
30015 their names are compatible, so there is no problem with upgrading.
30016
30017
30018 .section "Condition and modifier processing" "SECTcondmodproc"
30019 .cindex "&ACL;" "conditions; processing"
30020 .cindex "&ACL;" "modifiers; processing"
30021 An exclamation mark preceding a condition negates its result. For example:
30022 .code
30023 deny   domains = *.dom.example
30024       !verify  = recipient
30025 .endd
30026 causes the ACL to return &"deny"& if the recipient domain ends in
30027 &'dom.example'& and the recipient address cannot be verified. Sometimes
30028 negation can be used on the right-hand side of a condition. For example, these
30029 two statements are equivalent:
30030 .code
30031 deny  hosts = !192.168.3.4
30032 deny !hosts =  192.168.3.4
30033 .endd
30034 However, for many conditions (&%verify%& being a good example), only left-hand
30035 side negation of the whole condition is possible.
30036
30037 The arguments of conditions and modifiers are expanded. A forced failure
30038 of an expansion causes a condition to be ignored, that is, it behaves as if the
30039 condition is true. Consider these two statements:
30040 .code
30041 accept  senders = ${lookup{$host_name}lsearch\
30042                   {/some/file}{$value}fail}
30043 accept  senders = ${lookup{$host_name}lsearch\
30044                   {/some/file}{$value}{}}
30045 .endd
30046 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30047 the returned list is searched, but if the lookup fails the behaviour is
30048 different in the two cases. The &%fail%& in the first statement causes the
30049 condition to be ignored, leaving no further conditions. The &%accept%& verb
30050 therefore succeeds. The second statement, however, generates an empty list when
30051 the lookup fails. No sender can match an empty list, so the condition fails,
30052 and therefore the &%accept%& also fails.
30053
30054 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30055 specify actions that are taken as the conditions for a statement are checked;
30056 others specify text for messages that are used when access is denied or a
30057 warning is generated. The &%control%& modifier affects the way an incoming
30058 message is handled.
30059
30060 The positioning of the modifiers in an ACL statement is important, because the
30061 processing of a verb ceases as soon as its outcome is known. Only those
30062 modifiers that have already been encountered will take effect. For example,
30063 consider this use of the &%message%& modifier:
30064 .code
30065 require message = Can't verify sender
30066         verify  = sender
30067         message = Can't verify recipient
30068         verify  = recipient
30069         message = This message cannot be used
30070 .endd
30071 If sender verification fails, Exim knows that the result of the statement is
30072 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30073 so its text is used as the error message. If sender verification succeeds, but
30074 recipient verification fails, the second message is used. If recipient
30075 verification succeeds, the third message becomes &"current"&, but is never used
30076 because there are no more conditions to cause failure.
30077
30078 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30079 modifier that is used, because all the conditions must be true for rejection to
30080 happen. Specifying more than one &%message%& modifier does not make sense, and
30081 the message can even be specified after all the conditions. For example:
30082 .code
30083 deny   hosts = ...
30084       !senders = *@my.domain.example
30085        message = Invalid sender from client host
30086 .endd
30087 The &"deny"& result does not happen until the end of the statement is reached,
30088 by which time Exim has set up the message.
30089
30090
30091
30092 .section "ACL modifiers" "SECTACLmodi"
30093 .cindex "&ACL;" "modifiers; list of"
30094 The ACL modifiers are as follows:
30095
30096 .vlist
30097 .vitem &*add_header*&&~=&~<&'text'&>
30098 This modifier specifies one or more header lines that are to be added to an
30099 incoming message, assuming, of course, that the message is ultimately
30100 accepted. For details, see section &<<SECTaddheadacl>>&.
30101
30102 .vitem &*continue*&&~=&~<&'text'&>
30103 .cindex "&%continue%& ACL modifier"
30104 .cindex "database" "updating in ACL"
30105 This modifier does nothing of itself, and processing of the ACL always
30106 continues with the next condition or modifier. The value of &%continue%& is in
30107 the side effects of expanding its argument. Typically this could be used to
30108 update a database. It is really just a syntactic tidiness, to avoid having to
30109 write rather ugly lines like this:
30110 .display
30111 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30112 .endd
30113 Instead, all you need is
30114 .display
30115 &`continue = `&<&'some expansion'&>
30116 .endd
30117
30118 .vitem &*control*&&~=&~<&'text'&>
30119 .cindex "&%control%& ACL modifier"
30120 This modifier affects the subsequent processing of the SMTP connection or of an
30121 incoming message that is accepted. The effect of the first type of control
30122 lasts for the duration of the connection, whereas the effect of the second type
30123 lasts only until the current message has been received. The message-specific
30124 controls always apply to the whole message, not to individual recipients,
30125 even if the &%control%& modifier appears in a RCPT ACL.
30126
30127 As there are now quite a few controls that can be applied, they are described
30128 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30129 in several different ways. For example:
30130
30131 . ==== As this is a nested list, any displays it contains must be indented
30132 . ==== as otherwise they are too far to the left. That comment applies only
30133 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30134 . ==== way.
30135
30136 .ilist
30137 It can be at the end of an &%accept%& statement:
30138 .code
30139     accept  ...some conditions
30140             control = queue_only
30141 .endd
30142 In this case, the control is applied when this statement yields &"accept"&, in
30143 other words, when the conditions are all true.
30144
30145 .next
30146 It can be in the middle of an &%accept%& statement:
30147 .code
30148     accept  ...some conditions...
30149             control = queue_only
30150             ...some more conditions...
30151 .endd
30152 If the first set of conditions are true, the control is applied, even if the
30153 statement does not accept because one of the second set of conditions is false.
30154 In this case, some subsequent statement must yield &"accept"& for the control
30155 to be relevant.
30156
30157 .next
30158 It can be used with &%warn%& to apply the control, leaving the
30159 decision about accepting or denying to a subsequent verb. For
30160 example:
30161 .code
30162     warn    ...some conditions...
30163             control = freeze
30164     accept  ...
30165 .endd
30166 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30167 &%logwrite%&, so it does not add anything to the message and does not write a
30168 log entry.
30169
30170 .next
30171 If you want to apply a control unconditionally, you can use it with a
30172 &%require%& verb. For example:
30173 .code
30174     require  control = no_multiline_responses
30175 .endd
30176 .endlist
30177
30178 .vitem &*delay*&&~=&~<&'time'&>
30179 .cindex "&%delay%& ACL modifier"
30180 .oindex "&%-bh%&"
30181 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30182 the time interval before proceeding. However, when testing Exim using the
30183 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30184 output instead). The time is given in the usual Exim notation, and the delay
30185 happens as soon as the modifier is processed. In an SMTP session, pending
30186 output is flushed before the delay is imposed.
30187
30188 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30189 example:
30190 .code
30191 deny    ...some conditions...
30192         delay = 30s
30193 .endd
30194 The delay happens if all the conditions are true, before the statement returns
30195 &"deny"&. Compare this with:
30196 .code
30197 deny    delay = 30s
30198         ...some conditions...
30199 .endd
30200 which waits for 30s before processing the conditions. The &%delay%& modifier
30201 can also be used with &%warn%& and together with &%control%&:
30202 .code
30203 warn    ...some conditions...
30204         delay = 2m
30205         control = freeze
30206 accept  ...
30207 .endd
30208
30209 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30210 responses to several commands are no longer buffered and sent in one packet (as
30211 they would normally be) because all output is flushed before imposing the
30212 delay. This optimization is disabled so that a number of small delays do not
30213 appear to the client as one large aggregated delay that might provoke an
30214 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30215 using a &%control%& modifier to set &%no_delay_flush%&.
30216
30217
30218 .vitem &*endpass*&
30219 .cindex "&%endpass%& ACL modifier"
30220 This modifier, which has no argument, is recognized only in &%accept%& and
30221 &%discard%& statements. It marks the boundary between the conditions whose
30222 failure causes control to pass to the next statement, and the conditions whose
30223 failure causes the ACL to return &"deny"&. This concept has proved to be
30224 confusing to some people, so the use of &%endpass%& is no longer recommended as
30225 &"best practice"&. See the description of &%accept%& above for more details.
30226
30227
30228 .vitem &*log_message*&&~=&~<&'text'&>
30229 .cindex "&%log_message%& ACL modifier"
30230 This modifier sets up a message that is used as part of the log message if the
30231 ACL denies access or a &%warn%& statement's conditions are true. For example:
30232 .code
30233 require log_message = wrong cipher suite $tls_in_cipher
30234         encrypted   = DES-CBC3-SHA
30235 .endd
30236 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30237 example:
30238 .display
30239 &`discard `&<&'some conditions'&>
30240 &`        log_message = Discarded $local_part@$domain because...`&
30241 .endd
30242 When access is denied, &%log_message%& adds to any underlying error message
30243 that may exist because of a condition failure. For example, while verifying a
30244 recipient address, a &':fail:'& redirection might have already set up a
30245 message.
30246
30247 The message may be defined before the conditions to which it applies, because
30248 the string expansion does not happen until Exim decides that access is to be
30249 denied. This means that any variables that are set by the condition are
30250 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30251 variables are set after a DNS black list lookup succeeds. If the expansion of
30252 &%log_message%& fails, or if the result is an empty string, the modifier is
30253 ignored.
30254
30255 .vindex "&$acl_verify_message$&"
30256 If you want to use a &%warn%& statement to log the result of an address
30257 verification, you can use &$acl_verify_message$& to include the verification
30258 error message.
30259
30260 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30261 the start of the logged message. If the same warning log message is requested
30262 more than once while receiving  a single email message, only one copy is
30263 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30264 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30265 is logged for a successful &%warn%& statement.
30266
30267 If &%log_message%& is not present and there is no underlying error message (for
30268 example, from the failure of address verification), but &%message%& is present,
30269 the &%message%& text is used for logging rejections. However, if any text for
30270 logging contains newlines, only the first line is logged. In the absence of
30271 both &%log_message%& and &%message%&, a default built-in message is used for
30272 logging rejections.
30273
30274
30275 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30276 .cindex "&%log_reject_target%& ACL modifier"
30277 .cindex "logging in ACL" "specifying which log"
30278 This modifier makes it possible to specify which logs are used for messages
30279 about ACL rejections. Its argument is a colon-separated list of words that can
30280 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30281 may be empty, in which case a rejection is not logged at all. For example, this
30282 ACL fragment writes no logging information when access is denied:
30283 .display
30284 &`deny `&<&'some conditions'&>
30285 &`     log_reject_target =`&
30286 .endd
30287 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30288 permanent and temporary rejections. Its effect lasts for the rest of the
30289 current ACL.
30290
30291
30292 .vitem &*logwrite*&&~=&~<&'text'&>
30293 .cindex "&%logwrite%& ACL modifier"
30294 .cindex "logging in ACL" "immediate"
30295 This modifier writes a message to a log file as soon as it is encountered when
30296 processing an ACL. (Compare &%log_message%&, which, except in the case of
30297 &%warn%& and &%discard%&, is used only if the ACL statement denies
30298 access.) The &%logwrite%& modifier can be used to log special incidents in
30299 ACLs. For example:
30300 .display
30301 &`accept `&<&'some special conditions'&>
30302 &`       control  = freeze`&
30303 &`       logwrite = froze message because ...`&
30304 .endd
30305 By default, the message is written to the main log. However, it may begin
30306 with a colon, followed by a comma-separated list of log names, and then
30307 another colon, to specify exactly which logs are to be written. For
30308 example:
30309 .code
30310 logwrite = :main,reject: text for main and reject logs
30311 logwrite = :panic: text for panic log only
30312 .endd
30313
30314
30315 .vitem &*message*&&~=&~<&'text'&>
30316 .cindex "&%message%& ACL modifier"
30317 This modifier sets up a text string that is expanded and used as a response
30318 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30319 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30320 there is some complication if &%endpass%& is involved; see the description of
30321 &%accept%& for details.)
30322
30323 The expansion of the message happens at the time Exim decides that the ACL is
30324 to end, not at the time it processes &%message%&. If the expansion fails, or
30325 generates an empty string, the modifier is ignored. Here is an example where
30326 &%message%& must be specified first, because the ACL ends with a rejection if
30327 the &%hosts%& condition fails:
30328 .code
30329 require  message = Host not recognized
30330          hosts = 10.0.0.0/8
30331 .endd
30332 (Once a condition has failed, no further conditions or modifiers are
30333 processed.)
30334
30335 .cindex "SMTP" "error codes"
30336 .oindex "&%smtp_banner%&
30337 For ACLs that are triggered by SMTP commands, the message is returned as part
30338 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30339 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30340 is accepted. In the case of the connect ACL, accepting with a message modifier
30341 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30342 accept message may not contain more than one line (otherwise it will be
30343 truncated at the first newline and a panic logged), and it cannot affect the
30344 EHLO options.
30345
30346 When SMTP is involved, the message may begin with an overriding response code,
30347 consisting of three digits optionally followed by an &"extended response code"&
30348 of the form &'n.n.n'&, each code being followed by a space. For example:
30349 .code
30350 deny  message = 599 1.2.3 Host not welcome
30351       hosts = 192.168.34.0/24
30352 .endd
30353 The first digit of the supplied response code must be the same as would be sent
30354 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30355 access, but for the predata ACL, note that the default success code is 354, not
30356 2&'xx'&.
30357
30358 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30359 the message modifier cannot override the 221 response code.
30360
30361 The text in a &%message%& modifier is literal; any quotes are taken as
30362 literals, but because the string is expanded, backslash escapes are processed
30363 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30364 response.
30365
30366 .vindex "&$acl_verify_message$&"
30367 For ACLs that are called by an &%acl =%& ACL condition, the message is
30368 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30369
30370 If &%message%& is used on a statement that verifies an address, the message
30371 specified overrides any message that is generated by the verification process.
30372 However, the original message is available in the variable
30373 &$acl_verify_message$&, so you can incorporate it into your message if you
30374 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30375 routers to be passed back as part of the SMTP response, you should either not
30376 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30377
30378 For compatibility with previous releases of Exim, a &%message%& modifier that
30379 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30380 modifier, but this usage is now deprecated. However, &%message%& acts only when
30381 all the conditions are true, wherever it appears in an ACL command, whereas
30382 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30383 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30384 effect.
30385
30386
30387 .vitem &*queue*&&~=&~<&'text'&>
30388 .cindex "&%queue%& ACL modifier"
30389 .cindex "named queues" "selecting in ACL"
30390 This modifier specifies the use of a named queue for spool files
30391 for the message.
30392 It can only be used before the message is received (i.e. not in
30393 the DATA ACL).
30394 This could be used, for example, for known high-volume burst sources
30395 of traffic, or for quarantine of messages.
30396 Separate queue-runner processes will be needed for named queues.
30397 If the text after expansion is empty, the default queue is used.
30398
30399
30400 .vitem &*remove_header*&&~=&~<&'text'&>
30401 This modifier specifies one or more header names in a colon-separated list
30402  that are to be removed from an incoming message, assuming, of course, that
30403 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30404
30405
30406 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30407 .cindex "&%set%& ACL modifier"
30408 This modifier puts a value into one of the ACL variables (see section
30409 &<<SECTaclvariables>>&).
30410
30411
30412 .vitem &*udpsend*&&~=&~<&'parameters'&>
30413 .cindex "UDP communications"
30414 This modifier sends a UDP packet, for purposes such as statistics
30415 collection or behaviour monitoring. The parameters are expanded, and
30416 the result of the expansion must be a colon-separated list consisting
30417 of a destination server, port number, and the packet contents. The
30418 server can be specified as a host name or IPv4 or IPv6 address. The
30419 separator can be changed with the usual angle bracket syntax. For
30420 example, you might want to collect information on which hosts connect
30421 when:
30422 .code
30423 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30424              $tod_zulu $sender_host_address
30425 .endd
30426 .endlist
30427
30428
30429
30430
30431 .section "Use of the control modifier" "SECTcontrols"
30432 .cindex "&%control%& ACL modifier"
30433 The &%control%& modifier supports the following settings:
30434
30435 .vlist
30436 .vitem &*control&~=&~allow_auth_unadvertised*&
30437 This modifier allows a client host to use the SMTP AUTH command even when it
30438 has not been advertised in response to EHLO. Furthermore, because there are
30439 apparently some really broken clients that do this, Exim will accept AUTH after
30440 HELO (rather than EHLO) when this control is set. It should be used only if you
30441 really need it, and you should limit its use to those broken clients that do
30442 not work without it. For example:
30443 .code
30444 warn hosts   = 192.168.34.25
30445      control = allow_auth_unadvertised
30446 .endd
30447 Normally, when an Exim server receives an AUTH command, it checks the name of
30448 the authentication mechanism that is given in the command to ensure that it
30449 matches an advertised mechanism. When this control is set, the check that a
30450 mechanism has been advertised is bypassed. Any configured mechanism can be used
30451 by the client. This control is permitted only in the connection and HELO ACLs.
30452
30453
30454 .vitem &*control&~=&~caseful_local_part*& &&&
30455        &*control&~=&~caselower_local_part*&
30456 .cindex "&ACL;" "case of local part in"
30457 .cindex "case of local parts"
30458 .vindex "&$local_part$&"
30459 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30460 (that is, during RCPT processing). By default, the contents of &$local_part$&
30461 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30462 any uppercase letters in the original local part are restored in &$local_part$&
30463 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30464 is encountered.
30465
30466 These controls affect only the current recipient. Moreover, they apply only to
30467 local part handling that takes place directly in the ACL (for example, as a key
30468 in lookups). If a test to verify the recipient is obeyed, the case-related
30469 handling of the local part during the verification is controlled by the router
30470 configuration (see the &%caseful_local_part%& generic router option).
30471
30472 This facility could be used, for example, to add a spam score to local parts
30473 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30474 spam score:
30475 .code
30476 warn  control = caseful_local_part
30477       set acl_m4 = ${eval:\
30478                      $acl_m4 + \
30479                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30480                     }
30481       control = caselower_local_part
30482 .endd
30483 Notice that we put back the lower cased version afterwards, assuming that
30484 is what is wanted for subsequent tests.
30485
30486
30487 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30488 .cindex "&ACL;" "cutthrough routing"
30489 .cindex "cutthrough" "requesting"
30490 This option requests delivery be attempted while the item is being received.
30491
30492 The option is usable in the RCPT ACL.
30493 If enabled for a message received via smtp and routed to an smtp transport,
30494 and only one transport, interface, destination host and port combination
30495 is used for all recipients of the message,
30496 then the delivery connection is made while the receiving connection is open
30497 and data is copied from one to the other.
30498
30499 An attempt to set this option for any recipient but the first
30500 for a mail will be quietly ignored.
30501 If a recipient-verify callout
30502 (with use_sender)
30503 connection is subsequently
30504 requested in the same ACL it is held open and used for
30505 any subsequent recipients and the data,
30506 otherwise one is made after the initial RCPT ACL completes.
30507
30508 Note that routers are used in verify mode,
30509 and cannot depend on content of received headers.
30510 Note also that headers cannot be
30511 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30512 Headers may be modified by routers (subject to the above) and transports.
30513 The &'Received-By:'& header is generated as soon as the body reception starts,
30514 rather than the traditional time after the full message is received;
30515 this will affect the timestamp.
30516
30517 All the usual ACLs are called; if one results in the message being
30518 rejected, all effort spent in delivery (including the costs on
30519 the ultimate destination) will be wasted.
30520 Note that in the case of data-time ACLs this includes the entire
30521 message body.
30522
30523 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30524 of outgoing messages is done, because it sends data to the ultimate destination
30525 before the entire message has been received from the source.
30526 It is not supported for messages received with the SMTP PRDR
30527 or CHUNKING
30528 options in use.
30529
30530 Should the ultimate destination system positively accept or reject the mail,
30531 a corresponding indication is given to the source system and nothing is queued.
30532 If the item is successfully delivered in cutthrough mode
30533 the delivery log lines are tagged with ">>" rather than "=>" and appear
30534 before the acceptance "<=" line.
30535
30536 If there is a temporary error the item is queued for later delivery in the
30537 usual fashion.
30538 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30539 to the control; the default value is &"spool"& and the alternate value
30540 &"pass"& copies an SMTP defer response from the target back to the initiator
30541 and does not queue the message.
30542 Note that this is independent of any recipient verify conditions in the ACL.
30543
30544 Delivery in this mode avoids the generation of a bounce mail to a
30545 (possibly faked)
30546 sender when the destination system is doing content-scan based rejection.
30547
30548
30549 .vitem &*control&~=&~debug/*&<&'options'&>
30550 .cindex "&ACL;" "enabling debug logging"
30551 .cindex "debugging" "enabling from an ACL"
30552 This control turns on debug logging, almost as though Exim had been invoked
30553 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30554 by default called &'debuglog'&.
30555 The filename can be adjusted with the &'tag'& option, which
30556 may access any variables already defined.  The logging may be adjusted with
30557 the &'opts'& option, which takes the same values as the &`-d`& command-line
30558 option.
30559 Logging started this way may be stopped, and the file removed,
30560 with the &'kill'& option.
30561 Some examples (which depend on variables that don't exist in all
30562 contexts):
30563 .code
30564       control = debug
30565       control = debug/tag=.$sender_host_address
30566       control = debug/opts=+expand+acl
30567       control = debug/tag=.$message_exim_id/opts=+expand
30568       control = debug/kill
30569 .endd
30570
30571
30572 .vitem &*control&~=&~dkim_disable_verify*&
30573 .cindex "disable DKIM verify"
30574 .cindex "DKIM" "disable verify"
30575 This control turns off DKIM verification processing entirely.  For details on
30576 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30577
30578
30579 .vitem &*control&~=&~dmarc_disable_verify*&
30580 .cindex "disable DMARC verify"
30581 .cindex "DMARC" "disable verify"
30582 This control turns off DMARC verification processing entirely.  For details on
30583 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30584
30585
30586 .vitem &*control&~=&~dscp/*&<&'value'&>
30587 .cindex "&ACL;" "setting DSCP value"
30588 .cindex "DSCP" "inbound"
30589 This option causes the DSCP value associated with the socket for the inbound
30590 connection to be adjusted to a given value, given as one of a number of fixed
30591 strings or to numeric value.
30592 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30593 Common values include &`throughput`&, &`mincost`&, and on newer systems
30594 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30595
30596 The outbound packets from Exim will be marked with this value in the header
30597 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30598 that these values will have any effect, not be stripped by networking
30599 equipment, or do much of anything without cooperation with your Network
30600 Engineer and those of all network operators between the source and destination.
30601
30602
30603 .vitem &*control&~=&~enforce_sync*& &&&
30604        &*control&~=&~no_enforce_sync*&
30605 .cindex "SMTP" "synchronization checking"
30606 .cindex "synchronization checking in SMTP"
30607 These controls make it possible to be selective about when SMTP synchronization
30608 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30609 state of the switch (it is true by default). See the description of this option
30610 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30611
30612 The effect of these two controls lasts for the remainder of the SMTP
30613 connection. They can appear in any ACL except the one for the non-SMTP
30614 messages. The most straightforward place to put them is in the ACL defined by
30615 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30616 before the first synchronization check. The expected use is to turn off the
30617 synchronization checks for badly-behaved hosts that you nevertheless need to
30618 work with.
30619
30620
30621 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30622 .cindex "fake defer"
30623 .cindex "defer, fake"
30624 This control works in exactly the same way as &%fakereject%& (described below)
30625 except that it causes an SMTP 450 response after the message data instead of a
30626 550 response. You must take care when using &%fakedefer%& because it causes the
30627 messages to be duplicated when the sender retries. Therefore, you should not
30628 use &%fakedefer%& if the message is to be delivered normally.
30629
30630 .vitem &*control&~=&~fakereject/*&<&'message'&>
30631 .cindex "fake rejection"
30632 .cindex "rejection, fake"
30633 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30634 words, only when an SMTP message is being received. If Exim accepts the
30635 message, instead the final 250 response, a 550 rejection message is sent.
30636 However, Exim proceeds to deliver the message as normal. The control applies
30637 only to the current message, not to any subsequent ones that may be received in
30638 the same SMTP connection.
30639
30640 The text for the 550 response is taken from the &%control%& modifier. If no
30641 message is supplied, the following is used:
30642 .code
30643 550-Your message has been rejected but is being
30644 550-kept for evaluation.
30645 550-If it was a legitimate message, it may still be
30646 550 delivered to the target recipient(s).
30647 .endd
30648 This facility should be used with extreme caution.
30649
30650 .vitem &*control&~=&~freeze*&
30651 .cindex "frozen messages" "forcing in ACL"
30652 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30653 other words, only when a message is being received. If the message is accepted,
30654 it is placed on Exim's queue and frozen. The control applies only to the
30655 current message, not to any subsequent ones that may be received in the same
30656 SMTP connection.
30657
30658 This modifier can optionally be followed by &`/no_tell`&. If the global option
30659 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30660 is told about the freezing), provided all the &*control=freeze*& modifiers that
30661 are obeyed for the current message have the &`/no_tell`& option.
30662
30663 .vitem &*control&~=&~no_delay_flush*&
30664 .cindex "SMTP" "output flushing, disabling for delay"
30665 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30666 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30667 use. This control, as long as it is encountered before the &%delay%& modifier,
30668 disables such output flushing.
30669
30670 .vitem &*control&~=&~no_callout_flush*&
30671 .cindex "SMTP" "output flushing, disabling for callout"
30672 Exim normally flushes SMTP output before performing a callout in an ACL, to
30673 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30674 use. This control, as long as it is encountered before the &%verify%& condition
30675 that causes the callout, disables such output flushing.
30676
30677 .vitem &*control&~=&~no_mbox_unspool*&
30678 This control is available when Exim is compiled with the content scanning
30679 extension. Content scanning may require a copy of the current message, or parts
30680 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30681 or spam scanner. Normally, such copies are deleted when they are no longer
30682 needed. If this control is set, the copies are not deleted. The control applies
30683 only to the current message, not to any subsequent ones that may be received in
30684 the same SMTP connection. It is provided for debugging purposes and is unlikely
30685 to be useful in production.
30686
30687 .vitem &*control&~=&~no_multiline_responses*&
30688 .cindex "multiline responses, suppressing"
30689 This control is permitted for any ACL except the one for non-SMTP messages.
30690 It seems that there are broken clients in use that cannot handle multiline
30691 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30692
30693 If this control is set, multiline SMTP responses from ACL rejections are
30694 suppressed. One way of doing this would have been to put out these responses as
30695 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30696 (&"use multiline responses for more"& it says &-- ha!), and some of the
30697 responses might get close to that. So this facility, which is after all only a
30698 sop to broken clients, is implemented by doing two very easy things:
30699
30700 .ilist
30701 Extra information that is normally output as part of a rejection caused by
30702 sender verification failure is omitted. Only the final line (typically &"sender
30703 verification failed"&) is sent.
30704 .next
30705 If a &%message%& modifier supplies a multiline response, only the first
30706 line is output.
30707 .endlist
30708
30709 The setting of the switch can, of course, be made conditional on the
30710 calling host. Its effect lasts until the end of the SMTP connection.
30711
30712 .vitem &*control&~=&~no_pipelining*&
30713 .cindex "PIPELINING" "suppressing advertising"
30714 This control turns off the advertising of the PIPELINING extension to SMTP in
30715 the current session. To be useful, it must be obeyed before Exim sends its
30716 response to an EHLO command. Therefore, it should normally appear in an ACL
30717 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30718 &%pipelining_advertise_hosts%&.
30719
30720 .vitem &*control&~=&~queue_only*&
30721 .oindex "&%queue_only%&"
30722 .cindex "queueing incoming messages"
30723 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30724 other words, only when a message is being received. If the message is accepted,
30725 it is placed on Exim's queue and left there for delivery by a subsequent queue
30726 runner. No immediate delivery process is started. In other words, it has the
30727 effect as the &%queue_only%& global option. However, the control applies only
30728 to the current message, not to any subsequent ones that may be received in the
30729 same SMTP connection.
30730
30731 .vitem &*control&~=&~submission/*&<&'options'&>
30732 .cindex "message" "submission"
30733 .cindex "submission mode"
30734 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30735 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30736 the current message is a submission from a local MUA. In this case, Exim
30737 operates in &"submission mode"&, and applies certain fixups to the message if
30738 necessary. For example, it adds a &'Date:'& header line if one is not present.
30739 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30740 late (the message has already been created).
30741
30742 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30743 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30744 submission mode; the available options for this control are described there.
30745 The control applies only to the current message, not to any subsequent ones
30746 that may be received in the same SMTP connection.
30747
30748 .vitem &*control&~=&~suppress_local_fixups*&
30749 .cindex "submission fixups, suppressing"
30750 This control applies to locally submitted (non TCP/IP) messages, and is the
30751 complement of &`control = submission`&. It disables the fixups that are
30752 normally applied to locally-submitted messages. Specifically:
30753
30754 .ilist
30755 Any &'Sender:'& header line is left alone (in this respect, it is a
30756 dynamic version of &%local_sender_retain%&).
30757 .next
30758 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30759 .next
30760 There is no check that &'From:'& corresponds to the actual sender.
30761 .endlist ilist
30762
30763 This control may be useful when a remotely-originated message is accepted,
30764 passed to some scanning program, and then re-submitted for delivery. It can be
30765 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30766 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30767 data is read.
30768
30769 &*Note:*& This control applies only to the current message, not to any others
30770 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30771
30772 .vitem &*control&~=&~utf8_downconvert*&
30773 This control enables conversion of UTF-8 in message addresses
30774 to a-label form.
30775 For details see section &<<SECTi18nMTA>>&.
30776 .endlist vlist
30777
30778
30779 .section "Summary of message fixup control" "SECTsummesfix"
30780 All four possibilities for message fixups can be specified:
30781
30782 .ilist
30783 Locally submitted, fixups applied: the default.
30784 .next
30785 Locally submitted, no fixups applied: use
30786 &`control = suppress_local_fixups`&.
30787 .next
30788 Remotely submitted, no fixups applied: the default.
30789 .next
30790 Remotely submitted, fixups applied: use &`control = submission`&.
30791 .endlist
30792
30793
30794
30795 .section "Adding header lines in ACLs" "SECTaddheadacl"
30796 .cindex "header lines" "adding in an ACL"
30797 .cindex "header lines" "position of added lines"
30798 .cindex "&%add_header%& ACL modifier"
30799 The &%add_header%& modifier can be used to add one or more extra header lines
30800 to an incoming message, as in this example:
30801 .code
30802 warn dnslists = sbl.spamhaus.org : \
30803                 dialup.mail-abuse.org
30804      add_header = X-blacklisted-at: $dnslist_domain
30805 .endd
30806 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30807 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30808 receiving a message). The message must ultimately be accepted for
30809 &%add_header%& to have any significant effect. You can use &%add_header%& with
30810 any ACL verb, including &%deny%& (though this is potentially useful only in a
30811 RCPT ACL).
30812
30813 Headers will not be added to the message if the modifier is used in
30814 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30815
30816 Leading and trailing newlines are removed from
30817 the data for the &%add_header%& modifier; if it then
30818 contains one or more newlines that
30819 are not followed by a space or a tab, it is assumed to contain multiple header
30820 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30821 front of any line that is not a valid header line.
30822
30823 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30824 They are added to the message before processing the DATA and MIME ACLs.
30825 However, if an identical header line is requested more than once, only one copy
30826 is actually added to the message. Further header lines may be accumulated
30827 during the DATA and MIME ACLs, after which they are added to the message, again
30828 with duplicates suppressed. Thus, it is possible to add two identical header
30829 lines to an SMTP message, but only if one is added before DATA and one after.
30830 In the case of non-SMTP messages, new headers are accumulated during the
30831 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30832 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30833 are included in the entry that is written to the reject log.
30834
30835 .cindex "header lines" "added; visibility of"
30836 Header lines are not visible in string expansions
30837 of message headers
30838 until they are added to the
30839 message. It follows that header lines defined in the MAIL, RCPT, and predata
30840 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30841 header lines that are added by the DATA or MIME ACLs are not visible in those
30842 ACLs. Because of this restriction, you cannot use header lines as a way of
30843 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30844 this, you can use ACL variables, as described in section
30845 &<<SECTaclvariables>>&.
30846
30847 The list of headers yet to be added is given by the &%$headers_added%& variable.
30848
30849 The &%add_header%& modifier acts immediately as it is encountered during the
30850 processing of an ACL. Notice the difference between these two cases:
30851 .display
30852 &`accept add_header = ADDED: some text`&
30853 &`       `&<&'some condition'&>
30854
30855 &`accept `&<&'some condition'&>
30856 &`       add_header = ADDED: some text`&
30857 .endd
30858 In the first case, the header line is always added, whether or not the
30859 condition is true. In the second case, the header line is added only if the
30860 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30861 ACL statement. All those that are encountered before a condition fails are
30862 honoured.
30863
30864 .cindex "&%warn%& ACL verb"
30865 For compatibility with previous versions of Exim, a &%message%& modifier for a
30866 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30867 effect only if all the conditions are true, even if it appears before some of
30868 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30869 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30870 are present on a &%warn%& verb, both are processed according to their
30871 specifications.
30872
30873 By default, new header lines are added to a message at the end of the existing
30874 header lines. However, you can specify that any particular header line should
30875 be added right at the start (before all the &'Received:'& lines), immediately
30876 after the first block of &'Received:'& lines, or immediately before any line
30877 that is not a &'Received:'& or &'Resent-something:'& header.
30878
30879 This is done by specifying &":at_start:"&, &":after_received:"&, or
30880 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30881 header line, respectively. (Header text cannot start with a colon, as there has
30882 to be a header name first.) For example:
30883 .code
30884 warn add_header = \
30885        :after_received:X-My-Header: something or other...
30886 .endd
30887 If more than one header line is supplied in a single &%add_header%& modifier,
30888 each one is treated independently and can therefore be placed differently. If
30889 you add more than one line at the start, or after the Received: block, they end
30890 up in reverse order.
30891
30892 &*Warning*&: This facility currently applies only to header lines that are
30893 added in an ACL. It does NOT work for header lines that are added in a
30894 system filter or in a router or transport.
30895
30896
30897
30898 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30899 .cindex "header lines" "removing in an ACL"
30900 .cindex "header lines" "position of removed lines"
30901 .cindex "&%remove_header%& ACL modifier"
30902 The &%remove_header%& modifier can be used to remove one or more header lines
30903 from an incoming message, as in this example:
30904 .code
30905 warn   message        = Remove internal headers
30906        remove_header  = x-route-mail1 : x-route-mail2
30907 .endd
30908 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30909 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30910 receiving a message). The message must ultimately be accepted for
30911 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30912 with any ACL verb, including &%deny%&, though this is really not useful for
30913 any verb that doesn't result in a delivered message.
30914
30915 Headers will not be removed from the message if the modifier is used in
30916 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30917
30918 More than one header can be removed at the same time by using a colon separated
30919 list of header names. The header matching is case insensitive. Wildcards are
30920 not permitted, nor is list expansion performed, so you cannot use hostlists to
30921 create a list of headers, however both connection and message variable expansion
30922 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30923 .code
30924 warn   hosts           = +internal_hosts
30925        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30926 warn   message         = Remove internal headers
30927        remove_header   = $acl_c_ihdrs
30928 .endd
30929 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30930 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30931 If multiple header lines match, all are removed.
30932 There is no harm in attempting to remove the same header twice nor in removing
30933 a non-existent header. Further header lines to be removed may be accumulated
30934 during the DATA and MIME ACLs, after which they are removed from the message,
30935 if present. In the case of non-SMTP messages, headers to be removed are
30936 accumulated during the non-SMTP ACLs, and are removed from the message after
30937 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30938 ACL, there really is no effect because there is no logging of what headers
30939 would have been removed.
30940
30941 .cindex "header lines" "removed; visibility of"
30942 Header lines are not visible in string expansions until the DATA phase when it
30943 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30944 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30945 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30946 this restriction, you cannot use header lines as a way of controlling data
30947 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30948 you should instead use ACL variables, as described in section
30949 &<<SECTaclvariables>>&.
30950
30951 The &%remove_header%& modifier acts immediately as it is encountered during the
30952 processing of an ACL. Notice the difference between these two cases:
30953 .display
30954 &`accept remove_header = X-Internal`&
30955 &`       `&<&'some condition'&>
30956
30957 &`accept `&<&'some condition'&>
30958 &`       remove_header = X-Internal`&
30959 .endd
30960 In the first case, the header line is always removed, whether or not the
30961 condition is true. In the second case, the header line is removed only if the
30962 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30963 same ACL statement. All those that are encountered before a condition fails
30964 are honoured.
30965
30966 &*Warning*&: This facility currently applies only to header lines that are
30967 present during ACL processing. It does NOT remove header lines that are added
30968 in a system filter or in a router or transport.
30969
30970
30971
30972
30973 .section "ACL conditions" "SECTaclconditions"
30974 .cindex "&ACL;" "conditions; list of"
30975 Some of the conditions listed in this section are available only when Exim is
30976 compiled with the content-scanning extension. They are included here briefly
30977 for completeness. More detailed descriptions can be found in the discussion on
30978 content scanning in chapter &<<CHAPexiscan>>&.
30979
30980 Not all conditions are relevant in all circumstances. For example, testing
30981 senders and recipients does not make sense in an ACL that is being run as the
30982 result of the arrival of an ETRN command, and checks on message headers can be
30983 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30984 can use the same condition (with different parameters) more than once in the
30985 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30986 The conditions are as follows:
30987
30988
30989 .vlist
30990 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30991 .cindex "&ACL;" "nested"
30992 .cindex "&ACL;" "indirect"
30993 .cindex "&ACL;" "arguments"
30994 .cindex "&%acl%& ACL condition"
30995 The possible values of the argument are the same as for the
30996 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30997 &"accept"& the condition is true; if it returns &"deny"& the condition is
30998 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30999 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31000 condition false. This means that further processing of the &%warn%& verb
31001 ceases, but processing of the ACL continues.
31002
31003 If the argument is a named ACL, up to nine space-separated optional values
31004 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31005 and $acl_narg is set to the count of values.
31006 Previous values of these variables are restored after the call returns.
31007 The name and values are expanded separately.
31008 Note that spaces in complex expansions which are used as arguments
31009 will act as argument separators.
31010
31011 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31012 the connection is dropped. If it returns &"discard"&, the verb must be
31013 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31014 conditions are tested.
31015
31016 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31017 loops. This condition allows you to use different ACLs in different
31018 circumstances. For example, different ACLs can be used to handle RCPT commands
31019 for different local users or different local domains.
31020
31021 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31022 .cindex "&%authenticated%& ACL condition"
31023 .cindex "authentication" "ACL checking"
31024 .cindex "&ACL;" "testing for authentication"
31025 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31026 the name of the authenticator is tested against the list. To test for
31027 authentication by any authenticator, you can set
31028 .code
31029 authenticated = *
31030 .endd
31031
31032 .vitem &*condition&~=&~*&<&'string'&>
31033 .cindex "&%condition%& ACL condition"
31034 .cindex "customizing" "ACL condition"
31035 .cindex "&ACL;" "customized test"
31036 .cindex "&ACL;" "testing, customized"
31037 This feature allows you to make up custom conditions. If the result of
31038 expanding the string is an empty string, the number zero, or one of the strings
31039 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31040 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31041 any other value, some error is assumed to have occurred, and the ACL returns
31042 &"defer"&. However, if the expansion is forced to fail, the condition is
31043 ignored. The effect is to treat it as true, whether it is positive or
31044 negative.
31045
31046 .vitem &*decode&~=&~*&<&'location'&>
31047 .cindex "&%decode%& ACL condition"
31048 This condition is available only when Exim is compiled with the
31049 content-scanning extension, and it is allowed only in the ACL defined by
31050 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31051 If all goes well, the condition is true. It is false only if there are
31052 problems such as a syntax error or a memory shortage. For more details, see
31053 chapter &<<CHAPexiscan>>&.
31054
31055 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31056 .cindex "&%dnslists%& ACL condition"
31057 .cindex "DNS list" "in ACL"
31058 .cindex "black list (DNS)"
31059 .cindex "&ACL;" "testing a DNS list"
31060 This condition checks for entries in DNS black lists. These are also known as
31061 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31062 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31063 different variants of this condition to describe briefly here. See sections
31064 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31065
31066 .vitem &*domains&~=&~*&<&'domain&~list'&>
31067 .cindex "&%domains%& ACL condition"
31068 .cindex "domain" "ACL checking"
31069 .cindex "&ACL;" "testing a recipient domain"
31070 .vindex "&$domain_data$&"
31071 This condition is relevant only after a RCPT command. It checks that the domain
31072 of the recipient address is in the domain list. If percent-hack processing is
31073 enabled, it is done before this test is done. If the check succeeds with a
31074 lookup, the result of the lookup is placed in &$domain_data$& until the next
31075 &%domains%& test.
31076
31077 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31078 use &%domains%& in a DATA ACL.
31079
31080
31081 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31082 .cindex "&%encrypted%& ACL condition"
31083 .cindex "encryption" "checking in an ACL"
31084 .cindex "&ACL;" "testing for encryption"
31085 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31086 name of the cipher suite in use is tested against the list. To test for
31087 encryption without testing for any specific cipher suite(s), set
31088 .code
31089 encrypted = *
31090 .endd
31091
31092
31093 .vitem &*hosts&~=&~*&<&'host&~list'&>
31094 .cindex "&%hosts%& ACL condition"
31095 .cindex "host" "ACL checking"
31096 .cindex "&ACL;" "testing the client host"
31097 This condition tests that the calling host matches the host list. If you have
31098 name lookups or wildcarded host names and IP addresses in the same host list,
31099 you should normally put the IP addresses first. For example, you could have:
31100 .code
31101 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31102 .endd
31103 The lookup in this example uses the host name for its key. This is implied by
31104 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31105 and it wouldn't matter which way round you had these two items.)
31106
31107 The reason for the problem with host names lies in the left-to-right way that
31108 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31109 but when it reaches an item that requires a host name, it fails if it cannot
31110 find a host name to compare with the pattern. If the above list is given in the
31111 opposite order, the &%accept%& statement fails for a host whose name cannot be
31112 found, even if its IP address is 10.9.8.7.
31113
31114 If you really do want to do the name check first, and still recognize the IP
31115 address even if the name lookup fails, you can rewrite the ACL like this:
31116 .code
31117 accept hosts = dbm;/etc/friendly/hosts
31118 accept hosts = 10.9.8.7
31119 .endd
31120 The default action on failing to find the host name is to assume that the host
31121 is not in the list, so the first &%accept%& statement fails. The second
31122 statement can then check the IP address.
31123
31124 .vindex "&$host_data$&"
31125 If a &%hosts%& condition is satisfied by means of a lookup, the result
31126 of the lookup is made available in the &$host_data$& variable. This
31127 allows you, for example, to set up a statement like this:
31128 .code
31129 deny  hosts = net-lsearch;/some/file
31130 message = $host_data
31131 .endd
31132 which gives a custom error message for each denied host.
31133
31134 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31135 .cindex "&%local_parts%& ACL condition"
31136 .cindex "local part" "ACL checking"
31137 .cindex "&ACL;" "testing a local part"
31138 .vindex "&$local_part_data$&"
31139 This condition is relevant only after a RCPT command. It checks that the local
31140 part of the recipient address is in the list. If percent-hack processing is
31141 enabled, it is done before this test. If the check succeeds with a lookup, the
31142 result of the lookup is placed in &$local_part_data$&, which remains set until
31143 the next &%local_parts%& test.
31144
31145 .vitem &*malware&~=&~*&<&'option'&>
31146 .cindex "&%malware%& ACL condition"
31147 .cindex "&ACL;" "virus scanning"
31148 .cindex "&ACL;" "scanning for viruses"
31149 This condition is available only when Exim is compiled with the
31150 content-scanning extension
31151 and only after a DATA command.
31152 It causes the incoming message to be scanned for
31153 viruses. For details, see chapter &<<CHAPexiscan>>&.
31154
31155 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31156 .cindex "&%mime_regex%& ACL condition"
31157 .cindex "&ACL;" "testing by regex matching"
31158 This condition is available only when Exim is compiled with the
31159 content-scanning extension, and it is allowed only in the ACL defined by
31160 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31161 with any of the regular expressions. For details, see chapter
31162 &<<CHAPexiscan>>&.
31163
31164 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31165 .cindex "rate limiting"
31166 This condition can be used to limit the rate at which a user or host submits
31167 messages. Details are given in section &<<SECTratelimiting>>&.
31168
31169 .vitem &*recipients&~=&~*&<&'address&~list'&>
31170 .cindex "&%recipients%& ACL condition"
31171 .cindex "recipient" "ACL checking"
31172 .cindex "&ACL;" "testing a recipient"
31173 This condition is relevant only after a RCPT command. It checks the entire
31174 recipient address against a list of recipients.
31175
31176 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31177 .cindex "&%regex%& ACL condition"
31178 .cindex "&ACL;" "testing by regex matching"
31179 This condition is available only when Exim is compiled with the
31180 content-scanning extension, and is available only in the DATA, MIME, and
31181 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31182 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31183
31184 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31185 .cindex "&%sender_domains%& ACL condition"
31186 .cindex "sender" "ACL checking"
31187 .cindex "&ACL;" "testing a sender domain"
31188 .vindex "&$domain$&"
31189 .vindex "&$sender_address_domain$&"
31190 This condition tests the domain of the sender of the message against the given
31191 domain list. &*Note*&: The domain of the sender address is in
31192 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31193 of this condition. This is an exception to the general rule for testing domain
31194 lists. It is done this way so that, if this condition is used in an ACL for a
31195 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31196 influence the sender checking.
31197
31198 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31199 relaying, because sender addresses are easily, and commonly, forged.
31200
31201 .vitem &*senders&~=&~*&<&'address&~list'&>
31202 .cindex "&%senders%& ACL condition"
31203 .cindex "sender" "ACL checking"
31204 .cindex "&ACL;" "testing a sender"
31205 This condition tests the sender of the message against the given list. To test
31206 for a bounce message, which has an empty sender, set
31207 .code
31208 senders = :
31209 .endd
31210 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31211 relaying, because sender addresses are easily, and commonly, forged.
31212
31213 .vitem &*spam&~=&~*&<&'username'&>
31214 .cindex "&%spam%& ACL condition"
31215 .cindex "&ACL;" "scanning for spam"
31216 This condition is available only when Exim is compiled with the
31217 content-scanning extension. It causes the incoming message to be scanned by
31218 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31219
31220 .vitem &*verify&~=&~certificate*&
31221 .cindex "&%verify%& ACL condition"
31222 .cindex "TLS" "client certificate verification"
31223 .cindex "certificate" "verification of client"
31224 .cindex "&ACL;" "certificate verification"
31225 .cindex "&ACL;" "testing a TLS certificate"
31226 This condition is true in an SMTP session if the session is encrypted, and a
31227 certificate was received from the client, and the certificate was verified. The
31228 server requests a certificate only if the client matches &%tls_verify_hosts%&
31229 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31230
31231 .vitem &*verify&~=&~csa*&
31232 .cindex "CSA verification"
31233 This condition checks whether the sending host (the client) is authorized to
31234 send email. Details of how this works are given in section
31235 &<<SECTverifyCSA>>&.
31236
31237 .vitem &*verify&~=&~header_names_ascii*&
31238 .cindex "&%verify%& ACL condition"
31239 .cindex "&ACL;" "verifying header names only ASCII"
31240 .cindex "header lines" "verifying header names only ASCII"
31241 .cindex "verifying" "header names only ASCII"
31242 This condition is relevant only in an ACL that is run after a message has been
31243 received, that is, in an ACL specified by &%acl_smtp_data%& or
31244 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31245 there are no non-ASCII characters, also excluding control characters.  The
31246 allowable characters are decimal ASCII values 33 through 126.
31247
31248 Exim itself will handle headers with non-ASCII characters, but it can cause
31249 problems for downstream applications, so this option will allow their
31250 detection and rejection in the DATA ACL's.
31251
31252 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31253 .cindex "&%verify%& ACL condition"
31254 .cindex "&ACL;" "verifying sender in the header"
31255 .cindex "header lines" "verifying the sender in"
31256 .cindex "sender" "verifying in header"
31257 .cindex "verifying" "sender in header"
31258 This condition is relevant only in an ACL that is run after a message has been
31259 received, that is, in an ACL specified by &%acl_smtp_data%& or
31260 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31261 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31262 is loosely thought of as a &"sender"& address (hence the name of the test).
31263 However, an address that appears in one of these headers need not be an address
31264 that accepts bounce messages; only sender addresses in envelopes are required
31265 to accept bounces. Therefore, if you use the callout option on this check, you
31266 might want to arrange for a non-empty address in the MAIL command.
31267
31268 Details of address verification and the options are given later, starting at
31269 section &<<SECTaddressverification>>& (callouts are described in section
31270 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31271 condition to restrict it to bounce messages only:
31272 .code
31273 deny    senders = :
31274         message = A valid sender header is required for bounces
31275        !verify  = header_sender
31276 .endd
31277
31278 .vitem &*verify&~=&~header_syntax*&
31279 .cindex "&%verify%& ACL condition"
31280 .cindex "&ACL;" "verifying header syntax"
31281 .cindex "header lines" "verifying syntax"
31282 .cindex "verifying" "header syntax"
31283 This condition is relevant only in an ACL that is run after a message has been
31284 received, that is, in an ACL specified by &%acl_smtp_data%& or
31285 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31286 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31287 and &'Bcc:'&), returning true if there are no problems.
31288 Unqualified addresses (local parts without domains) are
31289 permitted only in locally generated messages and from hosts that match
31290 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31291 appropriate.
31292
31293 Note that this condition is a syntax check only. However, a common spamming
31294 ploy used to be to send syntactically invalid headers such as
31295 .code
31296 To: @
31297 .endd
31298 and this condition can be used to reject such messages, though they are not as
31299 common as they used to be.
31300
31301 .vitem &*verify&~=&~helo*&
31302 .cindex "&%verify%& ACL condition"
31303 .cindex "&ACL;" "verifying HELO/EHLO"
31304 .cindex "HELO" "verifying"
31305 .cindex "EHLO" "verifying"
31306 .cindex "verifying" "EHLO"
31307 .cindex "verifying" "HELO"
31308 This condition is true if a HELO or EHLO command has been received from the
31309 client host, and its contents have been verified. If there has been no previous
31310 attempt to verify the HELO/EHLO contents, it is carried out when this
31311 condition is encountered. See the description of the &%helo_verify_hosts%& and
31312 &%helo_try_verify_hosts%& options for details of how to request verification
31313 independently of this condition, and for detail of the verification.
31314
31315 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31316 option), this condition is always true.
31317
31318
31319 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31320 .cindex "verifying" "not blind"
31321 .cindex "bcc recipients, verifying none"
31322 This condition checks that there are no blind (bcc) recipients in the message.
31323 Every envelope recipient must appear either in a &'To:'& header line or in a
31324 &'Cc:'& header line for this condition to be true. Local parts are checked
31325 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31326 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31327 used only in a DATA or non-SMTP ACL.
31328
31329 There is one possible option, &`case_insensitive`&.  If this is present then
31330 local parts are checked case-insensitively.
31331
31332 There are, of course, many legitimate messages that make use of blind (bcc)
31333 recipients. This check should not be used on its own for blocking messages.
31334
31335
31336 .vitem &*verify&~=&~recipient/*&<&'options'&>
31337 .cindex "&%verify%& ACL condition"
31338 .cindex "&ACL;" "verifying recipient"
31339 .cindex "recipient" "verifying"
31340 .cindex "verifying" "recipient"
31341 .vindex "&$address_data$&"
31342 This condition is relevant only after a RCPT command. It verifies the current
31343 recipient. Details of address verification are given later, starting at section
31344 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31345 of &$address_data$& is the last value that was set while routing the address.
31346 This applies even if the verification fails. When an address that is being
31347 verified is redirected to a single address, verification continues with the new
31348 address, and in that case, the subsequent value of &$address_data$& is the
31349 value for the child address.
31350
31351 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31352 .cindex "&%verify%& ACL condition"
31353 .cindex "&ACL;" "verifying host reverse lookup"
31354 .cindex "host" "verifying reverse lookup"
31355 This condition ensures that a verified host name has been looked up from the IP
31356 address of the client host. (This may have happened already if the host name
31357 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31358 Verification ensures that the host name obtained from a reverse DNS lookup, or
31359 one of its aliases, does, when it is itself looked up in the DNS, yield the
31360 original IP address.
31361
31362 There is one possible option, &`defer_ok`&.  If this is present and a
31363 DNS operation returns a temporary error, the verify condition succeeds.
31364
31365 If this condition is used for a locally generated message (that is, when there
31366 is no client host involved), it always succeeds.
31367
31368 .vitem &*verify&~=&~sender/*&<&'options'&>
31369 .cindex "&%verify%& ACL condition"
31370 .cindex "&ACL;" "verifying sender"
31371 .cindex "sender" "verifying"
31372 .cindex "verifying" "sender"
31373 This condition is relevant only after a MAIL or RCPT command, or after a
31374 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31375 the message's sender is empty (that is, this is a bounce message), the
31376 condition is true. Otherwise, the sender address is verified.
31377
31378 .vindex "&$address_data$&"
31379 .vindex "&$sender_address_data$&"
31380 If there is data in the &$address_data$& variable at the end of routing, its
31381 value is placed in &$sender_address_data$& at the end of verification. This
31382 value can be used in subsequent conditions and modifiers in the same ACL
31383 statement. It does not persist after the end of the current statement. If you
31384 want to preserve the value for longer, you can save it in an ACL variable.
31385
31386 Details of verification are given later, starting at section
31387 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31388 to avoid doing it more than once per message.
31389
31390 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31391 .cindex "&%verify%& ACL condition"
31392 This is a variation of the previous option, in which a modified address is
31393 verified as a sender.
31394
31395 Note that '/' is legal in local-parts; if the address may have such
31396 (eg. is generated from the received message)
31397 they must be protected from the options parsing by doubling:
31398 .code
31399 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31400 .endd
31401 .endlist
31402
31403
31404
31405 .section "Using DNS lists" "SECTmorednslists"
31406 .cindex "DNS list" "in ACL"
31407 .cindex "black list (DNS)"
31408 .cindex "&ACL;" "testing a DNS list"
31409 In its simplest form, the &%dnslists%& condition tests whether the calling host
31410 is on at least one of a number of DNS lists by looking up the inverted IP
31411 address in one or more DNS domains. (Note that DNS list domains are not mail
31412 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31413 special options instead.) For example, if the calling host's IP
31414 address is 192.168.62.43, and the ACL statement is
31415 .code
31416 deny dnslists = blackholes.mail-abuse.org : \
31417                 dialups.mail-abuse.org
31418 .endd
31419 the following records are looked up:
31420 .code
31421 43.62.168.192.blackholes.mail-abuse.org
31422 43.62.168.192.dialups.mail-abuse.org
31423 .endd
31424 As soon as Exim finds an existing DNS record, processing of the list stops.
31425 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31426 to test that a host is on more than one list (an &"and"& conjunction), you can
31427 use two separate conditions:
31428 .code
31429 deny dnslists = blackholes.mail-abuse.org
31430      dnslists = dialups.mail-abuse.org
31431 .endd
31432 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31433 behaves as if the host does not match the list item, that is, as if the DNS
31434 record does not exist. If there are further items in the DNS list, they are
31435 processed.
31436
31437 This is usually the required action when &%dnslists%& is used with &%deny%&
31438 (which is the most common usage), because it prevents a DNS failure from
31439 blocking mail. However, you can change this behaviour by putting one of the
31440 following special items in the list:
31441 .display
31442 &`+include_unknown `&   behave as if the item is on the list
31443 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31444 &`+defer_unknown   `&   give a temporary error
31445 .endd
31446 .cindex "&`+include_unknown`&"
31447 .cindex "&`+exclude_unknown`&"
31448 .cindex "&`+defer_unknown`&"
31449 Each of these applies to any subsequent items on the list. For example:
31450 .code
31451 deny dnslists = +defer_unknown : foo.bar.example
31452 .endd
31453 Testing the list of domains stops as soon as a match is found. If you want to
31454 warn for one list and block for another, you can use two different statements:
31455 .code
31456 deny  dnslists = blackholes.mail-abuse.org
31457 warn  message  = X-Warn: sending host is on dialups list
31458       dnslists = dialups.mail-abuse.org
31459 .endd
31460 .cindex caching "of dns lookup"
31461 .cindex DNS TTL
31462 DNS list lookups are cached by Exim for the duration of the SMTP session
31463 (but limited by the DNS return TTL value),
31464 so a lookup based on the IP address is done at most once for any incoming
31465 connection (assuming long-enough TTL).
31466 Exim does not share information between multiple incoming
31467 connections (but your local name server cache should be active).
31468
31469 There are a number of DNS lists to choose from, some commercial, some free,
31470 or free for small deployments.  An overview can be found at
31471 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31472
31473
31474
31475 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31476 .cindex "DNS list" "keyed by explicit IP address"
31477 By default, the IP address that is used in a DNS list lookup is the IP address
31478 of the calling host. However, you can specify another IP address by listing it
31479 after the domain name, introduced by a slash. For example:
31480 .code
31481 deny dnslists = black.list.tld/192.168.1.2
31482 .endd
31483 This feature is not very helpful with explicit IP addresses; it is intended for
31484 use with IP addresses that are looked up, for example, the IP addresses of the
31485 MX hosts or nameservers of an email sender address. For an example, see section
31486 &<<SECTmulkeyfor>>& below.
31487
31488
31489
31490
31491 .section "DNS lists keyed on domain names" "SECID202"
31492 .cindex "DNS list" "keyed by domain name"
31493 There are some lists that are keyed on domain names rather than inverted IP
31494 addresses (see, e.g., the &'domain based zones'& link at
31495 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31496 with these lists. You can change the name that is looked up in a DNS list by
31497 listing it after the domain name, introduced by a slash. For example,
31498 .code
31499 deny  message  = Sender's domain is listed at $dnslist_domain
31500       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31501 .endd
31502 This particular example is useful only in ACLs that are obeyed after the
31503 RCPT or DATA commands, when a sender address is available. If (for
31504 example) the message's sender is &'user@tld.example'& the name that is looked
31505 up by this example is
31506 .code
31507 tld.example.dsn.rfc-ignorant.org
31508 .endd
31509 A single &%dnslists%& condition can contain entries for both names and IP
31510 addresses. For example:
31511 .code
31512 deny dnslists = sbl.spamhaus.org : \
31513                 dsn.rfc-ignorant.org/$sender_address_domain
31514 .endd
31515 The first item checks the sending host's IP address; the second checks a domain
31516 name. The whole condition is true if either of the DNS lookups succeeds.
31517
31518
31519
31520
31521 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31522 .cindex "DNS list" "multiple keys for"
31523 The syntax described above for looking up explicitly-defined values (either
31524 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31525 name for the DNS list, what follows the slash can in fact be a list of items.
31526 As with all lists in Exim, the default separator is a colon. However, because
31527 this is a sublist within the list of DNS blacklist domains, it is necessary
31528 either to double the separators like this:
31529 .code
31530 dnslists = black.list.tld/name.1::name.2
31531 .endd
31532 or to change the separator character, like this:
31533 .code
31534 dnslists = black.list.tld/<;name.1;name.2
31535 .endd
31536 If an item in the list is an IP address, it is inverted before the DNS
31537 blacklist domain is appended. If it is not an IP address, no inversion
31538 occurs. Consider this condition:
31539 .code
31540 dnslists = black.list.tld/<;192.168.1.2;a.domain
31541 .endd
31542 The DNS lookups that occur are:
31543 .code
31544 2.1.168.192.black.list.tld
31545 a.domain.black.list.tld
31546 .endd
31547 Once a DNS record has been found (that matches a specific IP return
31548 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31549 are done. If there is a temporary DNS error, the rest of the sublist of domains
31550 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31551 only if no other DNS lookup in this sublist succeeds. In other words, a
31552 successful lookup for any of the items in the sublist overrides a temporary
31553 error for a previous item.
31554
31555 The ability to supply a list of items after the slash is in some sense just a
31556 syntactic convenience. These two examples have the same effect:
31557 .code
31558 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31559 dnslists = black.list.tld/a.domain::b.domain
31560 .endd
31561 However, when the data for the list is obtained from a lookup, the second form
31562 is usually much more convenient. Consider this example:
31563 .code
31564 deny message  = The mail servers for the domain \
31565                 $sender_address_domain \
31566                 are listed at $dnslist_domain ($dnslist_value); \
31567                 see $dnslist_text.
31568      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31569                                    ${lookup dnsdb {>|mxh=\
31570                                    $sender_address_domain} }} }
31571 .endd
31572 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31573 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31574 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31575 of expanding the condition might be something like this:
31576 .code
31577 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31578 .endd
31579 Thus, this example checks whether or not the IP addresses of the sender
31580 domain's mail servers are on the Spamhaus black list.
31581
31582 The key that was used for a successful DNS list lookup is put into the variable
31583 &$dnslist_matched$& (see section &<<SECID204>>&).
31584
31585
31586
31587
31588 .section "Data returned by DNS lists" "SECID203"
31589 .cindex "DNS list" "data returned from"
31590 DNS lists are constructed using address records in the DNS. The original RBL
31591 just used the address 127.0.0.1 on the right hand side of each record, but the
31592 RBL+ list and some other lists use a number of values with different meanings.
31593 The values used on the RBL+ list are:
31594 .display
31595 127.1.0.1  RBL
31596 127.1.0.2  DUL
31597 127.1.0.3  DUL and RBL
31598 127.1.0.4  RSS
31599 127.1.0.5  RSS and RBL
31600 127.1.0.6  RSS and DUL
31601 127.1.0.7  RSS and DUL and RBL
31602 .endd
31603 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31604 different values. Some DNS lists may return more than one address record;
31605 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31606
31607
31608 .section "Variables set from DNS lists" "SECID204"
31609 .cindex "expansion" "variables, set from DNS list"
31610 .cindex "DNS list" "variables set from"
31611 .vindex "&$dnslist_domain$&"
31612 .vindex "&$dnslist_matched$&"
31613 .vindex "&$dnslist_text$&"
31614 .vindex "&$dnslist_value$&"
31615 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31616 the name of the overall domain that matched (for example,
31617 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31618 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31619 the DNS record. When the key is an IP address, it is not reversed in
31620 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31621 cases, for example:
31622 .code
31623 deny dnslists = spamhaus.example
31624 .endd
31625 the key is also available in another variable (in this case,
31626 &$sender_host_address$&). In more complicated cases, however, this is not true.
31627 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31628 might generate a dnslists lookup like this:
31629 .code
31630 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31631 .endd
31632 If this condition succeeds, the value in &$dnslist_matched$& might be
31633 &`192.168.6.7`& (for example).
31634
31635 If more than one address record is returned by the DNS lookup, all the IP
31636 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31637 The variable &$dnslist_text$& contains the contents of any associated TXT
31638 record. For lists such as RBL+ the TXT record for a merged entry is often not
31639 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31640 information.
31641
31642 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31643 &-- although these appear before the condition in the ACL, they are not
31644 expanded until after it has failed. For example:
31645 .code
31646 deny    hosts = !+local_networks
31647         message = $sender_host_address is listed \
31648                   at $dnslist_domain
31649         dnslists = rbl-plus.mail-abuse.example
31650 .endd
31651
31652
31653
31654 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31655 .cindex "DNS list" "matching specific returned data"
31656 You can add an equals sign and an IP address after a &%dnslists%& domain name
31657 in order to restrict its action to DNS records with a matching right hand side.
31658 For example,
31659 .code
31660 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31661 .endd
31662 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31663 any address record is considered to be a match. For the moment, we assume
31664 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31665 describes how multiple records are handled.
31666
31667 More than one IP address may be given for checking, using a comma as a
31668 separator. These are alternatives &-- if any one of them matches, the
31669 &%dnslists%& condition is true. For example:
31670 .code
31671 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31672 .endd
31673 If you want to specify a constraining address list and also specify names or IP
31674 addresses to be looked up, the constraining address list must be specified
31675 first. For example:
31676 .code
31677 deny dnslists = dsn.rfc-ignorant.org\
31678                 =127.0.0.2/$sender_address_domain
31679 .endd
31680
31681 If the character &`&&`& is used instead of &`=`&, the comparison for each
31682 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31683 In other words, the listed addresses are used as bit masks. The comparison is
31684 true if all the bits in the mask are present in the address that is being
31685 tested. For example:
31686 .code
31687 dnslists = a.b.c&0.0.0.3
31688 .endd
31689 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31690 want to test whether one bit or another bit is present (as opposed to both
31691 being present), you must use multiple values. For example:
31692 .code
31693 dnslists = a.b.c&0.0.0.1,0.0.0.2
31694 .endd
31695 matches if the final component of the address is an odd number or two times
31696 an odd number.
31697
31698
31699
31700 .section "Negated DNS matching conditions" "SECID205"
31701 You can supply a negative list of IP addresses as part of a &%dnslists%&
31702 condition. Whereas
31703 .code
31704 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31705 .endd
31706 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31707 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31708 .code
31709 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31710 .endd
31711 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31712 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31713 words, the result of the test is inverted if an exclamation mark appears before
31714 the &`=`& (or the &`&&`&) sign.
31715
31716 &*Note*&: This kind of negation is not the same as negation in a domain,
31717 host, or address list (which is why the syntax is different).
31718
31719 If you are using just one list, the negation syntax does not gain you much. The
31720 previous example is precisely equivalent to
31721 .code
31722 deny  dnslists = a.b.c
31723      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31724 .endd
31725 However, if you are using multiple lists, the negation syntax is clearer.
31726 Consider this example:
31727 .code
31728 deny  dnslists = sbl.spamhaus.org : \
31729                  list.dsbl.org : \
31730                  dnsbl.njabl.org!=127.0.0.3 : \
31731                  relays.ordb.org
31732 .endd
31733 Using only positive lists, this would have to be:
31734 .code
31735 deny  dnslists = sbl.spamhaus.org : \
31736                  list.dsbl.org
31737 deny  dnslists = dnsbl.njabl.org
31738      !dnslists = dnsbl.njabl.org=127.0.0.3
31739 deny  dnslists = relays.ordb.org
31740 .endd
31741 which is less clear, and harder to maintain.
31742
31743
31744
31745
31746 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31747 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31748 thereby providing more than one IP address. When an item in a &%dnslists%& list
31749 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31750 the match to specific results from the DNS lookup, there are two ways in which
31751 the checking can be handled. For example, consider the condition:
31752 .code
31753 dnslists = a.b.c=127.0.0.1
31754 .endd
31755 What happens if the DNS lookup for the incoming IP address yields both
31756 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31757 condition true because at least one given value was found, or is it false
31758 because at least one of the found values was not listed? And how does this
31759 affect negated conditions? Both possibilities are provided for with the help of
31760 additional separators &`==`& and &`=&&`&.
31761
31762 .ilist
31763 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31764 IP addresses matches one of the listed addresses. For the example above, the
31765 condition is true because 127.0.0.1 matches.
31766 .next
31767 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31768 looked up IP addresses matches one of the listed addresses. If the condition is
31769 changed to:
31770 .code
31771 dnslists = a.b.c==127.0.0.1
31772 .endd
31773 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31774 false because 127.0.0.2 is not listed. You would need to have:
31775 .code
31776 dnslists = a.b.c==127.0.0.1,127.0.0.2
31777 .endd
31778 for the condition to be true.
31779 .endlist
31780
31781 When &`!`& is used to negate IP address matching, it inverts the result, giving
31782 the precise opposite of the behaviour above. Thus:
31783 .ilist
31784 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31785 addresses matches one of the listed addresses. Consider:
31786 .code
31787 dnslists = a.b.c!&0.0.0.1
31788 .endd
31789 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31790 false because 127.0.0.1 matches.
31791 .next
31792 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31793 looked up IP address that does not match. Consider:
31794 .code
31795 dnslists = a.b.c!=&0.0.0.1
31796 .endd
31797 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31798 true, because 127.0.0.2 does not match. You would need to have:
31799 .code
31800 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31801 .endd
31802 for the condition to be false.
31803 .endlist
31804 When the DNS lookup yields only a single IP address, there is no difference
31805 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31806
31807
31808
31809
31810 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31811 .cindex "DNS list" "information from merged"
31812 When the facility for restricting the matching IP values in a DNS list is used,
31813 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31814 the true reason for rejection. This happens when lists are merged and the IP
31815 address in the A record is used to distinguish them; unfortunately there is
31816 only one TXT record. One way round this is not to use merged lists, but that
31817 can be inefficient because it requires multiple DNS lookups where one would do
31818 in the vast majority of cases when the host of interest is not on any of the
31819 lists.
31820
31821 A less inefficient way of solving this problem is available. If
31822 two domain names, comma-separated, are given, the second is used first to
31823 do an initial check, making use of any IP value restrictions that are set.
31824 If there is a match, the first domain is used, without any IP value
31825 restrictions, to get the TXT record. As a byproduct of this, there is also
31826 a check that the IP being tested is indeed on the first list. The first
31827 domain is the one that is put in &$dnslist_domain$&. For example:
31828 .code
31829 deny message  = \
31830          rejected because $sender_host_address is blacklisted \
31831          at $dnslist_domain\n$dnslist_text
31832        dnslists = \
31833          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31834          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31835 .endd
31836 For the first blacklist item, this starts by doing a lookup in
31837 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31838 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31839 value, and as long as something is found, it looks for the corresponding TXT
31840 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31841 The second blacklist item is processed similarly.
31842
31843 If you are interested in more than one merged list, the same list must be
31844 given several times, but because the results of the DNS lookups are cached,
31845 the DNS calls themselves are not repeated. For example:
31846 .code
31847 deny dnslists = \
31848          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31849          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31850          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31851          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31852 .endd
31853 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31854 values matches (or if no record is found), this is the only lookup that is
31855 done. Only if there is a match is one of the more specific lists consulted.
31856
31857
31858
31859 .section "DNS lists and IPv6" "SECTmorednslistslast"
31860 .cindex "IPv6" "DNS black lists"
31861 .cindex "DNS list" "IPv6 usage"
31862 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31863 nibble by nibble. For example, if the calling host's IP address is
31864 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31865 .code
31866 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31867   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31868 .endd
31869 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31870 lists contain wildcard records, intended for IPv4, that interact badly with
31871 IPv6. For example, the DNS entry
31872 .code
31873 *.3.some.list.example.    A    127.0.0.1
31874 .endd
31875 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31876 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31877
31878 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31879 &%condition%& condition, as in this example:
31880 .code
31881 deny   condition = ${if isip4{$sender_host_address}}
31882        dnslists  = some.list.example
31883 .endd
31884
31885 If an explicit key is being used for a DNS lookup and it may be an IPv6
31886 address you should specify alternate list separators for both the outer
31887 (DNS list name) list and inner (lookup keys) list:
31888 .code
31889        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31890 .endd
31891
31892 .section "Rate limiting incoming messages" "SECTratelimiting"
31893 .cindex "rate limiting" "client sending"
31894 .cindex "limiting client sending rates"
31895 .oindex "&%smtp_ratelimit_*%&"
31896 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31897 which clients can send email. This is more powerful than the
31898 &%smtp_ratelimit_*%& options, because those options control the rate of
31899 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31900 works across all connections (concurrent and sequential) from the same client
31901 host. The syntax of the &%ratelimit%& condition is:
31902 .display
31903 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31904 .endd
31905 If the average client sending rate is less than &'m'& messages per time
31906 period &'p'& then the condition is false; otherwise it is true.
31907
31908 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31909 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31910 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31911 of &'p'&.
31912
31913 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31914 time interval, for example, &`8h`& for eight hours. A larger time constant
31915 means that it takes Exim longer to forget a client's past behaviour. The
31916 parameter &'m'& is the maximum number of messages that a client is permitted to
31917 send in each time interval. It also specifies the number of messages permitted
31918 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31919 constant, you can allow a client to send more messages in a burst without
31920 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31921 both small, messages must be sent at an even rate.
31922
31923 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31924 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31925 when deploying the &%ratelimit%& ACL condition. The script prints usage
31926 instructions when it is run with no arguments.
31927
31928 The key is used to look up the data for calculating the client's average
31929 sending rate. This data is stored in Exim's spool directory, alongside the
31930 retry and other hints databases. The default key is &$sender_host_address$&,
31931 which means Exim computes the sending rate of each client host IP address.
31932 By changing the key you can change how Exim identifies clients for the purpose
31933 of ratelimiting. For example, to limit the sending rate of each authenticated
31934 user, independent of the computer they are sending from, set the key to
31935 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31936 example, &$authenticated_id$& is only meaningful if the client has
31937 authenticated (which you can check with the &%authenticated%& ACL condition).
31938
31939 The lookup key does not have to identify clients: If you want to limit the
31940 rate at which a recipient receives messages, you can use the key
31941 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31942 ACL.
31943
31944 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31945 specifies what Exim measures the rate of, for example, messages or recipients
31946 or bytes. You can adjust the measurement using the &%unique=%& and/or
31947 &%count=%& options. You can also control when Exim updates the recorded rate
31948 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31949 separated by a slash, like the other parameters. They may appear in any order.
31950
31951 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31952 any options that alter the meaning of the stored data. The limit &'m'& is not
31953 stored, so you can alter the configured maximum rate and Exim will still
31954 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31955 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31956 behaviour. The lookup key is not affected by changes to the update mode and
31957 the &%count=%& option.
31958
31959
31960 .section "Ratelimit options for what is being measured" "ratoptmea"
31961 .cindex "rate limiting" "per_* options"
31962 The &%per_conn%& option limits the client's connection rate. It is not
31963 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31964 &%acl_not_smtp_start%& ACLs.
31965
31966 The &%per_mail%& option limits the client's rate of sending messages. This is
31967 the default if none of the &%per_*%& options is specified. It can be used in
31968 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31969 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31970
31971 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31972 the same ACLs as the &%per_mail%& option, though it is best to use this option
31973 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31974 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31975 in its MAIL command, which may be inaccurate or completely missing. You can
31976 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31977 in kilobytes, megabytes, or gigabytes, respectively.
31978
31979 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31980 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31981 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31982 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31983 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31984 in either case the rate limiting engine will see a message with many
31985 recipients as a large high-speed burst.
31986
31987 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31988 number of different recipients that the client has sent messages to in the
31989 last time period. That is, if the client repeatedly sends messages to the same
31990 recipient, its measured rate is not increased. This option can only be used in
31991 &%acl_smtp_rcpt%&.
31992
31993 The &%per_cmd%& option causes Exim to recompute the rate every time the
31994 condition is processed. This can be used to limit the rate of any SMTP
31995 command. If it is used in multiple ACLs it can limit the aggregate rate of
31996 multiple different commands.
31997
31998 The &%count=%& option can be used to alter how much Exim adds to the client's
31999 measured rate. For example, the &%per_byte%& option is equivalent to
32000 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32001 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32002 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32003
32004 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32005
32006
32007 .section "Ratelimit update modes" "ratoptupd"
32008 .cindex "rate limiting" "reading data without updating"
32009 You can specify one of three options with the &%ratelimit%& condition to
32010 control when its database is updated. This section describes the &%readonly%&
32011 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32012
32013 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32014 previously-computed rate to check against the limit.
32015
32016 For example, you can test the client's sending rate and deny it access (when
32017 it is too fast) in the connect ACL. If the client passes this check then it
32018 can go on to send a message, in which case its recorded rate will be updated
32019 in the MAIL ACL. Subsequent connections from the same client will check this
32020 new rate.
32021 .code
32022 acl_check_connect:
32023  deny ratelimit = 100 / 5m / readonly
32024     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32025                   (max $sender_rate_limit)
32026 # ...
32027 acl_check_mail:
32028  warn ratelimit = 100 / 5m / strict
32029     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32030                   (max $sender_rate_limit)
32031 .endd
32032
32033 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32034 processing a message then it may increase the client's measured rate more than
32035 it should. For example, this will happen if you check the &%per_rcpt%& option
32036 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32037 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32038 multiple update problems by using the &%readonly%& option on later ratelimit
32039 checks.
32040
32041 The &%per_*%& options described above do not make sense in some ACLs. If you
32042 use a &%per_*%& option in an ACL where it is not normally permitted then the
32043 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32044 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32045 next section) so you must specify the &%readonly%& option explicitly.
32046
32047
32048 .section "Ratelimit options for handling fast clients" "ratoptfast"
32049 .cindex "rate limiting" "strict and leaky modes"
32050 If a client's average rate is greater than the maximum, the rate limiting
32051 engine can react in two possible ways, depending on the presence of the
32052 &%strict%& or &%leaky%& update modes. This is independent of the other
32053 counter-measures (such as rejecting the message) that may be specified by the
32054 rest of the ACL.
32055
32056 The &%leaky%& (default) option means that the client's recorded rate is not
32057 updated if it is above the limit. The effect of this is that Exim measures the
32058 client's average rate of successfully sent email,
32059 up to the given limit.
32060 This is appropriate if the countermeasure when the condition is true
32061 consists of refusing the message, and
32062 is generally the better choice if you have clients that retry automatically.
32063 If the action when true is anything more complex then this option is
32064 likely not what is wanted.
32065
32066 The &%strict%& option means that the client's recorded rate is always
32067 updated. The effect of this is that Exim measures the client's average rate
32068 of attempts to send email, which can be much higher than the maximum it is
32069 actually allowed. If the client is over the limit it may be subjected to
32070 counter-measures by the ACL. It must slow down and allow sufficient time to
32071 pass that its computed rate falls below the maximum before it can send email
32072 again. The time (the number of smoothing periods) it must wait and not
32073 attempt to send mail can be calculated with this formula:
32074 .code
32075         ln(peakrate/maxrate)
32076 .endd
32077
32078
32079 .section "Limiting the rate of different events" "ratoptuniq"
32080 .cindex "rate limiting" "counting unique events"
32081 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32082 rate of different events. For example, the &%per_addr%& option uses this
32083 mechanism to count the number of different recipients that the client has
32084 sent messages to in the last time period; it is equivalent to
32085 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32086 measure the rate that a client uses different sender addresses with the
32087 options &`per_mail/unique=$sender_address`&.
32088
32089 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32090 has seen for that key. The whole set is thrown away when it is older than the
32091 rate smoothing period &'p'&, so each different event is counted at most once
32092 per period. In the &%leaky%& update mode, an event that causes the client to
32093 go over the limit is not added to the set, in the same way that the client's
32094 recorded rate is not updated in the same situation.
32095
32096 When you combine the &%unique=%& and &%readonly%& options, the specific
32097 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32098 rate.
32099
32100 The &%unique=%& mechanism needs more space in the ratelimit database than the
32101 other &%ratelimit%& options in order to store the event set. The number of
32102 unique values is potentially as large as the rate limit, so the extra space
32103 required increases with larger limits.
32104
32105 The uniqueification is not perfect: there is a small probability that Exim
32106 will think a new event has happened before. If the sender's rate is less than
32107 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32108 the measured rate can go above the limit, in which case Exim may under-count
32109 events by a significant margin. Fortunately, if the rate is high enough (2.7
32110 times the limit) that the false positive rate goes above 9%, then Exim will
32111 throw away the over-full event set before the measured rate falls below the
32112 limit. Therefore the only harm should be that exceptionally high sending rates
32113 are logged incorrectly; any countermeasures you configure will be as effective
32114 as intended.
32115
32116
32117 .section "Using rate limiting" "useratlim"
32118 Exim's other ACL facilities are used to define what counter-measures are taken
32119 when the rate limit is exceeded. This might be anything from logging a warning
32120 (for example, while measuring existing sending rates in order to define
32121 policy), through time delays to slow down fast senders, up to rejecting the
32122 message. For example:
32123 .code
32124 # Log all senders' rates
32125 warn ratelimit = 0 / 1h / strict
32126      log_message = Sender rate $sender_rate / $sender_rate_period
32127
32128 # Slow down fast senders; note the need to truncate $sender_rate
32129 # at the decimal point.
32130 warn ratelimit = 100 / 1h / per_rcpt / strict
32131      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32132                    $sender_rate_limit }s
32133
32134 # Keep authenticated users under control
32135 deny authenticated = *
32136      ratelimit = 100 / 1d / strict / $authenticated_id
32137
32138 # System-wide rate limit
32139 defer message = Sorry, too busy. Try again later.
32140      ratelimit = 10 / 1s / $primary_hostname
32141
32142 # Restrict incoming rate from each host, with a default
32143 # set using a macro and special cases looked up in a table.
32144 defer message = Sender rate exceeds $sender_rate_limit \
32145                messages per $sender_rate_period
32146      ratelimit = ${lookup {$sender_host_address} \
32147                    cdb {DB/ratelimits.cdb} \
32148                    {$value} {RATELIMIT} }
32149 .endd
32150 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32151 especially with the &%per_rcpt%& option, you may suffer from a performance
32152 bottleneck caused by locking on the ratelimit hints database. Apart from
32153 making your ACLs less complicated, you can reduce the problem by using a
32154 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32155 this means that Exim will lose its hints data after a reboot (including retry
32156 hints, the callout cache, and ratelimit data).
32157
32158
32159
32160 .section "Address verification" "SECTaddressverification"
32161 .cindex "verifying address" "options for"
32162 .cindex "policy control" "address verification"
32163 Several of the &%verify%& conditions described in section
32164 &<<SECTaclconditions>>& cause addresses to be verified. Section
32165 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32166 The verification conditions can be followed by options that modify the
32167 verification process. The options are separated from the keyword and from each
32168 other by slashes, and some of them contain parameters. For example:
32169 .code
32170 verify = sender/callout
32171 verify = recipient/defer_ok/callout=10s,defer_ok
32172 .endd
32173 The first stage of address verification, which always happens, is to run the
32174 address through the routers, in &"verify mode"&. Routers can detect the
32175 difference between verification and routing for delivery, and their actions can
32176 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32177 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32178 The available options are as follows:
32179
32180 .ilist
32181 If the &%callout%& option is specified, successful routing to one or more
32182 remote hosts is followed by a &"callout"& to those hosts as an additional
32183 check. Callouts and their sub-options are discussed in the next section.
32184 .next
32185 If there is a defer error while doing verification routing, the ACL
32186 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32187 options, the condition is forced to be true instead. Note that this is a main
32188 verification option as well as a suboption for callouts.
32189 .next
32190 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32191 discusses the reporting of sender address verification failures.
32192 .next
32193 The &%success_on_redirect%& option causes verification always to succeed
32194 immediately after a successful redirection. By default, if a redirection
32195 generates just one address, that address is also verified. See further
32196 discussion in section &<<SECTredirwhilveri>>&.
32197 .endlist
32198
32199 .cindex "verifying address" "differentiating failures"
32200 .vindex "&$recipient_verify_failure$&"
32201 .vindex "&$sender_verify_failure$&"
32202 .vindex "&$acl_verify_message$&"
32203 After an address verification failure, &$acl_verify_message$& contains the
32204 error message that is associated with the failure. It can be preserved by
32205 coding like this:
32206 .code
32207 warn  !verify = sender
32208        set acl_m0 = $acl_verify_message
32209 .endd
32210 If you are writing your own custom rejection message or log message when
32211 denying access, you can use this variable to include information about the
32212 verification failure.
32213
32214 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32215 appropriate) contains one of the following words:
32216
32217 .ilist
32218 &%qualify%&: The address was unqualified (no domain), and the message
32219 was neither local nor came from an exempted host.
32220 .next
32221 &%route%&: Routing failed.
32222 .next
32223 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32224 occurred at or before the MAIL command (that is, on initial
32225 connection, HELO, or MAIL).
32226 .next
32227 &%recipient%&: The RCPT command in a callout was rejected.
32228 .next
32229 &%postmaster%&: The postmaster check in a callout was rejected.
32230 .endlist
32231
32232 The main use of these variables is expected to be to distinguish between
32233 rejections of MAIL and rejections of RCPT in callouts.
32234
32235 The above variables may also be set after a &*successful*&
32236 address verification to:
32237
32238 .ilist
32239 &%random%&: A random local-part callout succeeded
32240 .endlist
32241
32242
32243
32244
32245 .section "Callout verification" "SECTcallver"
32246 .cindex "verifying address" "by callout"
32247 .cindex "callout" "verification"
32248 .cindex "SMTP" "callout verification"
32249 For non-local addresses, routing verifies the domain, but is unable to do any
32250 checking of the local part. There are situations where some means of verifying
32251 the local part is desirable. One way this can be done is to make an SMTP
32252 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32253 a subsequent host for a recipient address, to see if the host accepts the
32254 address. We use the term &'callout'& to cover both cases. Note that for a
32255 sender address, the callback is not to the client host that is trying to
32256 deliver the message, but to one of the hosts that accepts incoming mail for the
32257 sender's domain.
32258
32259 Exim does not do callouts by default. If you want them to happen, you must
32260 request them by setting appropriate options on the &%verify%& condition, as
32261 described below. This facility should be used with care, because it can add a
32262 lot of resource usage to the cost of verifying an address. However, Exim does
32263 cache the results of callouts, which helps to reduce the cost. Details of
32264 caching are in section &<<SECTcallvercache>>&.
32265
32266 Recipient callouts are usually used only between hosts that are controlled by
32267 the same administration. For example, a corporate gateway host could use
32268 callouts to check for valid recipients on an internal mailserver. A successful
32269 callout does not guarantee that a real delivery to the address would succeed;
32270 on the other hand, a failing callout does guarantee that a delivery would fail.
32271
32272 If the &%callout%& option is present on a condition that verifies an address, a
32273 second stage of verification occurs if the address is successfully routed to
32274 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32275 &(manualroute)& router, where the router specifies the hosts. However, if a
32276 router that does not set up hosts routes to an &(smtp)& transport with a
32277 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32278 &%hosts_override%& set, its hosts are always used, whether or not the router
32279 supplies a host list.
32280 Callouts are only supported on &(smtp)& transports.
32281
32282 The port that is used is taken from the transport, if it is specified and is a
32283 remote transport. (For routers that do verification only, no transport need be
32284 specified.) Otherwise, the default SMTP port is used. If a remote transport
32285 specifies an outgoing interface, this is used; otherwise the interface is not
32286 specified. Likewise, the text that is used for the HELO command is taken from
32287 the transport's &%helo_data%& option; if there is no transport, the value of
32288 &$smtp_active_hostname$& is used.
32289
32290 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32291 test whether a bounce message could be delivered to the sender address. The
32292 following SMTP commands are sent:
32293 .display
32294 &`HELO `&<&'local host name'&>
32295 &`MAIL FROM:<>`&
32296 &`RCPT TO:`&<&'the address to be tested'&>
32297 &`QUIT`&
32298 .endd
32299 LHLO is used instead of HELO if the transport's &%protocol%& option is
32300 set to &"lmtp"&.
32301
32302 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32303 settings.
32304
32305 A recipient callout check is similar. By default, it also uses an empty address
32306 for the sender. This default is chosen because most hosts do not make use of
32307 the sender address when verifying a recipient. Using the same address means
32308 that a single cache entry can be used for each recipient. Some sites, however,
32309 do make use of the sender address when verifying. These are catered for by the
32310 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32311
32312 If the response to the RCPT command is a 2&'xx'& code, the verification
32313 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32314 Exim tries the next host, if any. If there is a problem with all the remote
32315 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32316 &%callout%& option is given, in which case the condition is forced to succeed.
32317
32318 .cindex "SMTP" "output flushing, disabling for callout"
32319 A callout may take a little time. For this reason, Exim normally flushes SMTP
32320 output before performing a callout in an ACL, to avoid unexpected timeouts in
32321 clients when the SMTP PIPELINING extension is in use. The flushing can be
32322 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32323
32324
32325
32326
32327 .section "Additional parameters for callouts" "CALLaddparcall"
32328 .cindex "callout" "additional parameters for"
32329 The &%callout%& option can be followed by an equals sign and a number of
32330 optional parameters, separated by commas. For example:
32331 .code
32332 verify = recipient/callout=10s,defer_ok
32333 .endd
32334 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32335 separate verify options, is retained for backwards compatibility, but is now
32336 deprecated. The additional parameters for &%callout%& are as follows:
32337
32338
32339 .vlist
32340 .vitem <&'a&~time&~interval'&>
32341 .cindex "callout" "timeout, specifying"
32342 This specifies the timeout that applies for the callout attempt to each host.
32343 For example:
32344 .code
32345 verify = sender/callout=5s
32346 .endd
32347 The default is 30 seconds. The timeout is used for each response from the
32348 remote host. It is also used for the initial connection, unless overridden by
32349 the &%connect%& parameter.
32350
32351
32352 .vitem &*connect&~=&~*&<&'time&~interval'&>
32353 .cindex "callout" "connection timeout, specifying"
32354 This parameter makes it possible to set a different (usually smaller) timeout
32355 for making the SMTP connection. For example:
32356 .code
32357 verify = sender/callout=5s,connect=1s
32358 .endd
32359 If not specified, this timeout defaults to the general timeout value.
32360
32361 .vitem &*defer_ok*&
32362 .cindex "callout" "defer, action on"
32363 When this parameter is present, failure to contact any host, or any other kind
32364 of temporary error, is treated as success by the ACL. However, the cache is not
32365 updated in this circumstance.
32366
32367 .vitem &*fullpostmaster*&
32368 .cindex "callout" "full postmaster check"
32369 This operates like the &%postmaster%& option (see below), but if the check for
32370 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32371 accordance with the specification in RFC 2821. The RFC states that the
32372 unqualified address &'postmaster'& should be accepted.
32373
32374
32375 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32376 .cindex "callout" "sender when verifying header"
32377 When verifying addresses in header lines using the &%header_sender%&
32378 verification option, Exim behaves by default as if the addresses are envelope
32379 sender addresses from a message. Callout verification therefore tests to see
32380 whether a bounce message could be delivered, by using an empty address in the
32381 MAIL command. However, it is arguable that these addresses might never be used
32382 as envelope senders, and could therefore justifiably reject bounce messages
32383 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32384 address to use in the MAIL command. For example:
32385 .code
32386 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32387 .endd
32388 This parameter is available only for the &%header_sender%& verification option.
32389
32390
32391 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32392 .cindex "callout" "overall timeout, specifying"
32393 This parameter sets an overall timeout for performing a callout verification.
32394 For example:
32395 .code
32396 verify = sender/callout=5s,maxwait=30s
32397 .endd
32398 This timeout defaults to four times the callout timeout for individual SMTP
32399 commands. The overall timeout applies when there is more than one host that can
32400 be tried. The timeout is checked before trying the next host. This prevents
32401 very long delays if there are a large number of hosts and all are timing out
32402 (for example, when network connections are timing out).
32403
32404
32405 .vitem &*no_cache*&
32406 .cindex "callout" "cache, suppressing"
32407 .cindex "caching callout, suppressing"
32408 When this parameter is given, the callout cache is neither read nor updated.
32409
32410 .vitem &*postmaster*&
32411 .cindex "callout" "postmaster; checking"
32412 When this parameter is set, a successful callout check is followed by a similar
32413 check for the local part &'postmaster'& at the same domain. If this address is
32414 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32415 the postmaster check is recorded in a cache record; if it is a failure, this is
32416 used to fail subsequent callouts for the domain without a connection being
32417 made, until the cache record expires.
32418
32419 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32420 The postmaster check uses an empty sender in the MAIL command by default.
32421 You can use this parameter to do a postmaster check using a different address.
32422 For example:
32423 .code
32424 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32425 .endd
32426 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32427 one overrides. The &%postmaster%& parameter is equivalent to this example:
32428 .code
32429 require  verify = sender/callout=postmaster_mailfrom=
32430 .endd
32431 &*Warning*&: The caching arrangements for postmaster checking do not take
32432 account of the sender address. It is assumed that either the empty address or
32433 a fixed non-empty address will be used. All that Exim remembers is that the
32434 postmaster check for the domain succeeded or failed.
32435
32436
32437 .vitem &*random*&
32438 .cindex "callout" "&""random""& check"
32439 When this parameter is set, before doing the normal callout check, Exim does a
32440 check for a &"random"& local part at the same domain. The local part is not
32441 really random &-- it is defined by the expansion of the option
32442 &%callout_random_local_part%&, which defaults to
32443 .code
32444 $primary_hostname-$tod_epoch-testing
32445 .endd
32446 The idea here is to try to determine whether the remote host accepts all local
32447 parts without checking. If it does, there is no point in doing callouts for
32448 specific local parts. If the &"random"& check succeeds, the result is saved in
32449 a cache record, and used to force the current and subsequent callout checks to
32450 succeed without a connection being made, until the cache record expires.
32451
32452 .vitem &*use_postmaster*&
32453 .cindex "callout" "sender for recipient check"
32454 This parameter applies to recipient callouts only. For example:
32455 .code
32456 deny  !verify = recipient/callout=use_postmaster
32457 .endd
32458 .vindex "&$qualify_domain$&"
32459 It causes a non-empty postmaster address to be used in the MAIL command when
32460 performing the callout for the recipient, and also for a &"random"& check if
32461 that is configured. The local part of the address is &`postmaster`& and the
32462 domain is the contents of &$qualify_domain$&.
32463
32464 .vitem &*use_sender*&
32465 This option applies to recipient callouts only. For example:
32466 .code
32467 require  verify = recipient/callout=use_sender
32468 .endd
32469 It causes the message's actual sender address to be used in the MAIL
32470 command when performing the callout, instead of an empty address. There is no
32471 need to use this option unless you know that the called hosts make use of the
32472 sender when checking recipients. If used indiscriminately, it reduces the
32473 usefulness of callout caching.
32474
32475 .vitem &*hold*&
32476 This option applies to recipient callouts only. For example:
32477 .code
32478 require  verify = recipient/callout=use_sender,hold
32479 .endd
32480 It causes the connection to be held open and used for any further recipients
32481 and for eventual delivery (should that be done quickly).
32482 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32483 when that is used for the connections.
32484 The advantage is only gained if there are no callout cache hits
32485 (which could be enforced by the no_cache option),
32486 if the use_sender option is used,
32487 if neither the random nor the use_postmaster option is used,
32488 and if no other callouts intervene.
32489 .endlist
32490
32491 If you use any of the parameters that set a non-empty sender for the MAIL
32492 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32493 &%use_sender%&), you should think about possible loops. Recipient checking is
32494 usually done between two hosts that are under the same management, and the host
32495 that receives the callouts is not normally configured to do callouts itself.
32496 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32497 these circumstances.
32498
32499 However, if you use a non-empty sender address for a callout to an arbitrary
32500 host, there is the likelihood that the remote host will itself initiate a
32501 callout check back to your host. As it is checking what appears to be a message
32502 sender, it is likely to use an empty address in MAIL, thus avoiding a
32503 callout loop. However, to be on the safe side it would be best to set up your
32504 own ACLs so that they do not do sender verification checks when the recipient
32505 is the address you use for header sender or postmaster callout checking.
32506
32507 Another issue to think about when using non-empty senders for callouts is
32508 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32509 by the sender/recipient combination; thus, for any given recipient, many more
32510 actual callouts are performed than when an empty sender or postmaster is used.
32511
32512
32513
32514
32515 .section "Callout caching" "SECTcallvercache"
32516 .cindex "hints database" "callout cache"
32517 .cindex "callout" "cache, description of"
32518 .cindex "caching" "callout"
32519 Exim caches the results of callouts in order to reduce the amount of resources
32520 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32521 option. A hints database called &"callout"& is used for the cache. Two
32522 different record types are used: one records the result of a callout check for
32523 a specific address, and the other records information that applies to the
32524 entire domain (for example, that it accepts the local part &'postmaster'&).
32525
32526 When an original callout fails, a detailed SMTP error message is given about
32527 the failure. However, for subsequent failures use the cache data, this message
32528 is not available.
32529
32530 The expiry times for negative and positive address cache records are
32531 independent, and can be set by the global options &%callout_negative_expire%&
32532 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32533
32534 If a host gives a negative response to an SMTP connection, or rejects any
32535 commands up to and including
32536 .code
32537 MAIL FROM:<>
32538 .endd
32539 (but not including the MAIL command with a non-empty address),
32540 any callout attempt is bound to fail. Exim remembers such failures in a
32541 domain cache record, which it uses to fail callouts for the domain without
32542 making new connections, until the domain record times out. There are two
32543 separate expiry times for domain cache records:
32544 &%callout_domain_negative_expire%& (default 3h) and
32545 &%callout_domain_positive_expire%& (default 7d).
32546
32547 Domain records expire when the negative expiry time is reached if callouts
32548 cannot be made for the domain, or if the postmaster check failed.
32549 Otherwise, they expire when the positive expiry time is reached. This
32550 ensures that, for example, a host that stops accepting &"random"& local parts
32551 will eventually be noticed.
32552
32553 The callout caching mechanism is based on the domain of the address that is
32554 being tested. If the domain routes to several hosts, it is assumed that their
32555 behaviour will be the same.
32556
32557
32558
32559 .section "Sender address verification reporting" "SECTsenaddver"
32560 .cindex "verifying" "suppressing error details"
32561 See section &<<SECTaddressverification>>& for a general discussion of
32562 verification. When sender verification fails in an ACL, the details of the
32563 failure are given as additional output lines before the 550 response to the
32564 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32565 you might see:
32566 .code
32567 MAIL FROM:<xyz@abc.example>
32568 250 OK
32569 RCPT TO:<pqr@def.example>
32570 550-Verification failed for <xyz@abc.example>
32571 550-Called:   192.168.34.43
32572 550-Sent:     RCPT TO:<xyz@abc.example>
32573 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32574 550 Sender verification failed
32575 .endd
32576 If more than one RCPT command fails in the same way, the details are given
32577 only for the first of them. However, some administrators do not want to send
32578 out this much information. You can suppress the details by adding
32579 &`/no_details`& to the ACL statement that requests sender verification. For
32580 example:
32581 .code
32582 verify = sender/no_details
32583 .endd
32584
32585 .section "Redirection while verifying" "SECTredirwhilveri"
32586 .cindex "verifying" "redirection while"
32587 .cindex "address redirection" "while verifying"
32588 A dilemma arises when a local address is redirected by aliasing or forwarding
32589 during verification: should the generated addresses themselves be verified,
32590 or should the successful expansion of the original address be enough to verify
32591 it? By default, Exim takes the following pragmatic approach:
32592
32593 .ilist
32594 When an incoming address is redirected to just one child address, verification
32595 continues with the child address, and if that fails to verify, the original
32596 verification also fails.
32597 .next
32598 When an incoming address is redirected to more than one child address,
32599 verification does not continue. A success result is returned.
32600 .endlist
32601
32602 This seems the most reasonable behaviour for the common use of aliasing as a
32603 way of redirecting different local parts to the same mailbox. It means, for
32604 example, that a pair of alias entries of the form
32605 .code
32606 A.Wol:   aw123
32607 aw123:   :fail: Gone away, no forwarding address
32608 .endd
32609 work as expected, with both local parts causing verification failure. When a
32610 redirection generates more than one address, the behaviour is more like a
32611 mailing list, where the existence of the alias itself is sufficient for
32612 verification to succeed.
32613
32614 It is possible, however, to change the default behaviour so that all successful
32615 redirections count as successful verifications, however many new addresses are
32616 generated. This is specified by the &%success_on_redirect%& verification
32617 option. For example:
32618 .code
32619 require verify = recipient/success_on_redirect/callout=10s
32620 .endd
32621 In this example, verification succeeds if a router generates a new address, and
32622 the callout does not occur, because no address was routed to a remote host.
32623
32624 When verification is being tested via the &%-bv%& option, the treatment of
32625 redirections is as just described, unless the &%-v%& or any debugging option is
32626 also specified. In that case, full verification is done for every generated
32627 address and a report is output for each of them.
32628
32629
32630
32631 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32632 .cindex "CSA" "verifying"
32633 Client SMTP Authorization is a system that allows a site to advertise
32634 which machines are and are not permitted to send email. This is done by placing
32635 special SRV records in the DNS; these are looked up using the client's HELO
32636 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32637 Authorization checks in Exim are performed by the ACL condition:
32638 .code
32639 verify = csa
32640 .endd
32641 This fails if the client is not authorized. If there is a DNS problem, or if no
32642 valid CSA SRV record is found, or if the client is authorized, the condition
32643 succeeds. These three cases can be distinguished using the expansion variable
32644 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32645 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32646 be likely to cause problems for legitimate email.
32647
32648 The error messages produced by the CSA code include slightly more
32649 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32650 looking up the CSA SRV record, or problems looking up the CSA target
32651 address record. There are four reasons for &$csa_status$& being &"fail"&:
32652
32653 .ilist
32654 The client's host name is explicitly not authorized.
32655 .next
32656 The client's IP address does not match any of the CSA target IP addresses.
32657 .next
32658 The client's host name is authorized but it has no valid target IP addresses
32659 (for example, the target's addresses are IPv6 and the client is using IPv4).
32660 .next
32661 The client's host name has no CSA SRV record but a parent domain has asserted
32662 that all subdomains must be explicitly authorized.
32663 .endlist
32664
32665 The &%csa%& verification condition can take an argument which is the domain to
32666 use for the DNS query. The default is:
32667 .code
32668 verify = csa/$sender_helo_name
32669 .endd
32670 This implementation includes an extension to CSA. If the query domain
32671 is an address literal such as [192.0.2.95], or if it is a bare IP
32672 address, Exim searches for CSA SRV records in the reverse DNS as if
32673 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32674 meaningful to say:
32675 .code
32676 verify = csa/$sender_host_address
32677 .endd
32678 In fact, this is the check that Exim performs if the client does not say HELO.
32679 This extension can be turned off by setting the main configuration option
32680 &%dns_csa_use_reverse%& to be false.
32681
32682 If a CSA SRV record is not found for the domain itself, a search
32683 is performed through its parent domains for a record which might be
32684 making assertions about subdomains. The maximum depth of this search is limited
32685 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32686 default. Exim does not look for CSA SRV records in a top level domain, so the
32687 default settings handle HELO domains as long as seven
32688 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32689 of legitimate HELO domains.
32690
32691 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32692 direct SRV lookups, this is not sufficient because of the extra parent domain
32693 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32694 addresses into lookups in the reverse DNS space. The result of a successful
32695 lookup such as:
32696 .code
32697 ${lookup dnsdb {csa=$sender_helo_name}}
32698 .endd
32699 has two space-separated fields: an authorization code and a target host name.
32700 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32701 authorization required but absent, or &"?"& for unknown.
32702
32703
32704
32705
32706 .section "Bounce address tag validation" "SECTverifyPRVS"
32707 .cindex "BATV, verifying"
32708 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32709 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32710 Genuine incoming bounce messages should therefore always be addressed to
32711 recipients that have a valid tag. This scheme is a way of detecting unwanted
32712 bounce messages caused by sender address forgeries (often called &"collateral
32713 spam"&), because the recipients of such messages do not include valid tags.
32714
32715 There are two expansion items to help with the implementation of the BATV
32716 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32717 the original envelope sender address by using a simple key to add a hash of the
32718 address and some time-based randomizing information. The &%prvs%& expansion
32719 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32720 The syntax of these expansion items is described in section
32721 &<<SECTexpansionitems>>&.
32722 The validity period on signed addresses is seven days.
32723
32724 As an example, suppose the secret per-address keys are stored in an MySQL
32725 database. A query to look up the key for an address could be defined as a macro
32726 like this:
32727 .code
32728 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32729                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32730                 }{$value}}
32731 .endd
32732 Suppose also that the senders who make use of BATV are defined by an address
32733 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32734 use this:
32735 .code
32736 # Bounces: drop unsigned addresses for BATV senders
32737 deny message = This address does not send an unsigned reverse path
32738      senders = :
32739      recipients = +batv_senders
32740
32741 # Bounces: In case of prvs-signed address, check signature.
32742 deny message = Invalid reverse path signature.
32743      senders = :
32744      condition  = ${prvscheck {$local_part@$domain}\
32745                   {PRVSCHECK_SQL}{1}}
32746      !condition = $prvscheck_result
32747 .endd
32748 The first statement rejects recipients for bounce messages that are addressed
32749 to plain BATV sender addresses, because it is known that BATV senders do not
32750 send out messages with plain sender addresses. The second statement rejects
32751 recipients that are prvs-signed, but with invalid signatures (either because
32752 the key is wrong, or the signature has timed out).
32753
32754 A non-prvs-signed address is not rejected by the second statement, because the
32755 &%prvscheck%& expansion yields an empty string if its first argument is not a
32756 prvs-signed address, thus causing the &%condition%& condition to be false. If
32757 the first argument is a syntactically valid prvs-signed address, the yield is
32758 the third string (in this case &"1"&), whether or not the cryptographic and
32759 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32760 of the checks (empty for failure, &"1"& for success).
32761
32762 There is one more issue you must consider when implementing prvs-signing:
32763 you have to ensure that the routers accept prvs-signed addresses and
32764 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32765 router to remove the signature with a configuration along these lines:
32766 .code
32767 batv_redirect:
32768   driver = redirect
32769   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32770 .endd
32771 This works because, if the third argument of &%prvscheck%& is empty, the result
32772 of the expansion of a prvs-signed address is the decoded value of the original
32773 address. This router should probably be the first of your routers that handles
32774 local addresses.
32775
32776 To create BATV-signed addresses in the first place, a transport of this form
32777 can be used:
32778 .code
32779 external_smtp_batv:
32780   driver = smtp
32781   return_path = ${prvs {$return_path} \
32782                        {${lookup mysql{SELECT \
32783                        secret FROM batv_prvs WHERE \
32784                        sender='${quote_mysql:$sender_address}'} \
32785                        {$value}fail}}}
32786 .endd
32787 If no key can be found for the existing return path, no signing takes place.
32788
32789
32790
32791 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32792 .cindex "&ACL;" "relay control"
32793 .cindex "relaying" "control by ACL"
32794 .cindex "policy control" "relay control"
32795 An MTA is said to &'relay'& a message if it receives it from some host and
32796 delivers it directly to another host as a result of a remote address contained
32797 within it. Redirecting a local address via an alias or forward file and then
32798 passing the message on to another host is not relaying,
32799 .cindex "&""percent hack""&"
32800 but a redirection as a result of the &"percent hack"& is.
32801
32802 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32803 A host which is acting as a gateway or an MX backup is concerned with incoming
32804 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32805 a host which is acting as a smart host for a number of clients is concerned
32806 with outgoing relaying from those clients to the Internet at large. Often the
32807 same host is fulfilling both functions,
32808 . ///
32809 . as illustrated in the diagram below,
32810 . ///
32811 but in principle these two kinds of relaying are entirely independent. What is
32812 not wanted is the transmission of mail from arbitrary remote hosts through your
32813 system to arbitrary domains.
32814
32815
32816 You can implement relay control by means of suitable statements in the ACL that
32817 runs for each RCPT command. For convenience, it is often easiest to use
32818 Exim's named list facility to define the domains and hosts involved. For
32819 example, suppose you want to do the following:
32820
32821 .ilist
32822 Deliver a number of domains to mailboxes on the local host (or process them
32823 locally in some other way). Let's say these are &'my.dom1.example'& and
32824 &'my.dom2.example'&.
32825 .next
32826 Relay mail for a number of other domains for which you are the secondary MX.
32827 These might be &'friend1.example'& and &'friend2.example'&.
32828 .next
32829 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32830 Suppose your LAN is 192.168.45.0/24.
32831 .endlist
32832
32833
32834 In the main part of the configuration, you put the following definitions:
32835 .code
32836 domainlist local_domains    = my.dom1.example : my.dom2.example
32837 domainlist relay_to_domains = friend1.example : friend2.example
32838 hostlist   relay_from_hosts = 192.168.45.0/24
32839 .endd
32840 Now you can use these definitions in the ACL that is run for every RCPT
32841 command:
32842 .code
32843 acl_check_rcpt:
32844   accept domains = +local_domains : +relay_to_domains
32845   accept hosts   = +relay_from_hosts
32846 .endd
32847 The first statement accepts any RCPT command that contains an address in
32848 the local or relay domains. For any other domain, control passes to the second
32849 statement, which accepts the command only if it comes from one of the relay
32850 hosts. In practice, you will probably want to make your ACL more sophisticated
32851 than this, for example, by including sender and recipient verification. The
32852 default configuration includes a more comprehensive example, which is described
32853 in chapter &<<CHAPdefconfil>>&.
32854
32855
32856
32857 .section "Checking a relay configuration" "SECTcheralcon"
32858 .cindex "relaying" "checking control of"
32859 You can check the relay characteristics of your configuration in the same way
32860 that you can test any ACL behaviour for an incoming SMTP connection, by using
32861 the &%-bh%& option to run a fake SMTP session with which you interact.
32862 .ecindex IIDacl
32863
32864
32865
32866 . ////////////////////////////////////////////////////////////////////////////
32867 . ////////////////////////////////////////////////////////////////////////////
32868
32869 .chapter "Content scanning at ACL time" "CHAPexiscan"
32870 .scindex IIDcosca "content scanning" "at ACL time"
32871 The extension of Exim to include content scanning at ACL time, formerly known
32872 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32873 was integrated into the main source for Exim release 4.50, and Tom continues to
32874 maintain it. Most of the wording of this chapter is taken from Tom's
32875 specification.
32876
32877 It is also possible to scan the content of messages at other times. The
32878 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32879 scanning after all the ACLs have run. A transport filter can be used to scan
32880 messages at delivery time (see the &%transport_filter%& option, described in
32881 chapter &<<CHAPtransportgeneric>>&).
32882
32883 If you want to include the ACL-time content-scanning features when you compile
32884 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32885 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32886
32887 .ilist
32888 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32889 for all MIME parts for SMTP and non-SMTP messages, respectively.
32890 .next
32891 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32892 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32893 run at the end of message reception (the &%acl_smtp_data%& ACL).
32894 .next
32895 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32896 of messages, or parts of messages, for debugging purposes.
32897 .next
32898 Additional expansion variables that are set in the new ACL and by the new
32899 conditions.
32900 .next
32901 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32902 .endlist
32903
32904 Content-scanning is continually evolving, and new features are still being
32905 added. While such features are still unstable and liable to incompatible
32906 changes, they are made available in Exim by setting options whose names begin
32907 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32908 this manual. You can find out about them by reading the file called
32909 &_doc/experimental.txt_&.
32910
32911 All the content-scanning facilities work on a MBOX copy of the message that is
32912 temporarily created in a file called:
32913 .display
32914 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32915 .endd
32916 The &_.eml_& extension is a friendly hint to virus scanners that they can
32917 expect an MBOX-like structure inside that file. The file is created when the
32918 first content scanning facility is called. Subsequent calls to content
32919 scanning conditions open the same file again. The directory is recursively
32920 removed when the &%acl_smtp_data%& ACL has finished running, unless
32921 .code
32922 control = no_mbox_unspool
32923 .endd
32924 has been encountered. When the MIME ACL decodes files, they are put into the
32925 same directory by default.
32926
32927
32928
32929 .section "Scanning for viruses" "SECTscanvirus"
32930 .cindex "virus scanning"
32931 .cindex "content scanning" "for viruses"
32932 .cindex "content scanning" "the &%malware%& condition"
32933 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32934 It supports a &"generic"& interface to scanners called via the shell, and
32935 specialized interfaces for &"daemon"& type virus scanners, which are resident
32936 in memory and thus are much faster.
32937
32938 Since message data needs to have arrived,
32939 the condition may be only called in ACL defined by
32940 &%acl_smtp_data%&,
32941 &%acl_smtp_data_prdr%&,
32942 &%acl_smtp_mime%& or
32943 &%acl_smtp_dkim%&
32944
32945 A timeout of 2 minutes is applied to a scanner call (by default);
32946 if it expires then a defer action is taken.
32947
32948 .oindex "&%av_scanner%&"
32949 You can set the &%av_scanner%& option in the main part of the configuration
32950 to specify which scanner to use, together with any additional options that
32951 are needed. The basic syntax is as follows:
32952 .display
32953 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32954 .endd
32955 If you do not set &%av_scanner%&, it defaults to
32956 .code
32957 av_scanner = sophie:/var/run/sophie
32958 .endd
32959 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32960 before use.
32961 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32962 The following scanner types are supported in this release,
32963 though individual ones can be included or not at build time:
32964
32965 .vlist
32966 .vitem &%avast%&
32967 .cindex "virus scanners" "avast"
32968 This is the scanner daemon of Avast. It has been tested with Avast Core
32969 Security (currently at version 2.2.0).
32970 You can get a trial version at &url(https://www.avast.com) or for Linux
32971 at &url(https://www.avast.com/linux-server-antivirus).
32972 This scanner type takes one option,
32973 which can be either a full path to a UNIX socket,
32974 or host and port specifiers separated by white space.
32975 The host may be a name or an IP address; the port is either a
32976 single number or a pair of numbers with a dash between.
32977 A list of options may follow. These options are interpreted on the
32978 Exim's side of the malware scanner, or are given on separate lines to
32979 the daemon as options before the main scan command.
32980
32981 .cindex &`pass_unscanned`& "avast"
32982 If &`pass_unscanned`&
32983 is set, any files the Avast scanner can't scan (e.g.
32984 decompression bombs, or invalid archives) are considered clean. Use with
32985 care.
32986
32987 For example:
32988 .code
32989 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32990 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32991 av_scanner = avast:192.168.2.22 5036
32992 .endd
32993 If you omit the argument, the default path
32994 &_/var/run/avast/scan.sock_&
32995 is used.
32996 If you use a remote host,
32997 you need to make Exim's spool directory available to it,
32998 as the scanner is passed a file path, not file contents.
32999 For information about available commands and their options you may use
33000 .code
33001 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33002     FLAGS
33003     SENSITIVITY
33004     PACK
33005 .endd
33006
33007 If the scanner returns a temporary failure (e.g. license issues, or
33008 permission problems), the message is deferred and a paniclog entry is
33009 written.  The usual &`defer_ok`& option is available.
33010
33011 .vitem &%aveserver%&
33012 .cindex "virus scanners" "Kaspersky"
33013 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33014 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33015 which is the path to the daemon's UNIX socket. The default is shown in this
33016 example:
33017 .code
33018 av_scanner = aveserver:/var/run/aveserver
33019 .endd
33020
33021
33022 .vitem &%clamd%&
33023 .cindex "virus scanners" "clamd"
33024 This daemon-type scanner is GPL and free. You can get it at
33025 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33026 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33027 in the MIME ACL. This is no longer believed to be necessary.
33028
33029 The options are a list of server specifiers, which may be
33030 a UNIX socket specification,
33031 a TCP socket specification,
33032 or a (global) option.
33033
33034 A socket specification consists of a space-separated list.
33035 For a Unix socket the first element is a full path for the socket,
33036 for a TCP socket the first element is the IP address
33037 and the second a port number,
33038 Any further elements are per-server (non-global) options.
33039 These per-server options are supported:
33040 .code
33041 retry=<timespec>        Retry on connect fail
33042 .endd
33043
33044 The &`retry`& option specifies a time after which a single retry for
33045 a failed connect is made.  The default is to not retry.
33046
33047 If a Unix socket file is specified, only one server is supported.
33048
33049 Examples:
33050 .code
33051 av_scanner = clamd:/opt/clamd/socket
33052 av_scanner = clamd:192.0.2.3 1234
33053 av_scanner = clamd:192.0.2.3 1234:local
33054 av_scanner = clamd:192.0.2.3 1234 retry=10s
33055 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33056 .endd
33057 If the value of av_scanner points to a UNIX socket file or contains the
33058 &`local`&
33059 option, then the ClamAV interface will pass a filename containing the data
33060 to be scanned, which should normally result in less I/O happening and be
33061 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33062 Exim does not assume that there is a common filesystem with the remote host.
33063
33064 The final example shows that multiple TCP targets can be specified.  Exim will
33065 randomly use one for each incoming email (i.e. it load balances them).  Note
33066 that only TCP targets may be used if specifying a list of scanners; a UNIX
33067 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33068 unavailable, Exim will try the remaining one(s) until it finds one that works.
33069 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33070 not keep track of scanner state between multiple messages, and the scanner
33071 selection is random, so the message will get logged in the mainlog for each
33072 email that the down scanner gets chosen first (message wrapped to be readable):
33073 .code
33074 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33075    clamd: connection to localhost, port 3310 failed
33076    (Connection refused)
33077 .endd
33078
33079 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33080 contributing the code for this scanner.
33081
33082 .vitem &%cmdline%&
33083 .cindex "virus scanners" "command line interface"
33084 This is the keyword for the generic command line scanner interface. It can be
33085 used to attach virus scanners that are invoked from the shell. This scanner
33086 type takes 3 mandatory options:
33087
33088 .olist
33089 The full path and name of the scanner binary, with all command line options,
33090 and a placeholder (&`%s`&) for the directory to scan.
33091
33092 .next
33093 A regular expression to match against the STDOUT and STDERR output of the
33094 virus scanner. If the expression matches, a virus was found. You must make
33095 absolutely sure that this expression matches on &"virus found"&. This is called
33096 the &"trigger"& expression.
33097
33098 .next
33099 Another regular expression, containing exactly one pair of parentheses, to
33100 match the name of the virus found in the scanners output. This is called the
33101 &"name"& expression.
33102 .endlist olist
33103
33104 For example, Sophos Sweep reports a virus on a line like this:
33105 .code
33106 Virus 'W32/Magistr-B' found in file ./those.bat
33107 .endd
33108 For the trigger expression, we can match the phrase &"found in file"&. For the
33109 name expression, we want to extract the W32/Magistr-B string, so we can match
33110 for the single quotes left and right of it. Altogether, this makes the
33111 configuration setting:
33112 .code
33113 av_scanner = cmdline:\
33114              /path/to/sweep -ss -all -rec -archive %s:\
33115              found in file:'(.+)'
33116 .endd
33117 .vitem &%drweb%&
33118 .cindex "virus scanners" "DrWeb"
33119 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33120 takes one option,
33121 either a full path to a UNIX socket,
33122 or host and port specifiers separated by white space.
33123 The host may be a name or an IP address; the port is either a
33124 single number or a pair of numbers with a dash between.
33125 For example:
33126 .code
33127 av_scanner = drweb:/var/run/drwebd.sock
33128 av_scanner = drweb:192.168.2.20 31337
33129 .endd
33130 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33131 is used. Thanks to Alex Miller for contributing the code for this scanner.
33132
33133 .vitem &%f-protd%&
33134 .cindex "virus scanners" "f-protd"
33135 The f-protd scanner is accessed via HTTP over TCP.
33136 One argument is taken, being a space-separated hostname and port number
33137 (or port-range).
33138 For example:
33139 .code
33140 av_scanner = f-protd:localhost 10200-10204
33141 .endd
33142 If you omit the argument, the default values shown above are used.
33143
33144 .vitem &%f-prot6d%&
33145 .cindex "virus scanners" "f-prot6d"
33146 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33147 One argument is taken, being a space-separated hostname and port number.
33148 For example:
33149 .code
33150 av_scanner = f-prot6d:localhost 10200
33151 .endd
33152 If you omit the argument, the default values show above are used.
33153
33154 .vitem &%fsecure%&
33155 .cindex "virus scanners" "F-Secure"
33156 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33157 argument which is the path to a UNIX socket. For example:
33158 .code
33159 av_scanner = fsecure:/path/to/.fsav
33160 .endd
33161 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33162 Thelmen for contributing the code for this scanner.
33163
33164 .vitem &%kavdaemon%&
33165 .cindex "virus scanners" "Kaspersky"
33166 This is the scanner daemon of Kaspersky Version 4. This version of the
33167 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33168 scanner type takes one option, which is the path to the daemon's UNIX socket.
33169 For example:
33170 .code
33171 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33172 .endd
33173 The default path is &_/var/run/AvpCtl_&.
33174
33175 .vitem &%mksd%&
33176 .cindex "virus scanners" "mksd"
33177 This was a daemon type scanner that is aimed mainly at Polish users,
33178 though some documentation was available in English.
33179 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33180 and this appears to be a candidate for removal from Exim, unless
33181 we are informed of other virus scanners which use the same protocol
33182 to integrate.
33183 The only option for this scanner type is
33184 the maximum number of processes used simultaneously to scan the attachments,
33185 provided that mksd has
33186 been run with at least the same number of child processes. For example:
33187 .code
33188 av_scanner = mksd:2
33189 .endd
33190 You can safely omit this option (the default value is 1).
33191
33192 .vitem &%sock%&
33193 .cindex "virus scanners" "simple socket-connected"
33194 This is a general-purpose way of talking to simple scanner daemons
33195 running on the local machine.
33196 There are four options:
33197 an address (which may be an IP address and port, or the path of a Unix socket),
33198 a commandline to send (may include a single %s which will be replaced with
33199 the path to the mail file to be scanned),
33200 an RE to trigger on from the returned data,
33201 and an RE to extract malware_name from the returned data.
33202 For example:
33203 .code
33204 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33205 .endd
33206 Note that surrounding whitespace is stripped from each option, meaning
33207 there is no way to specify a trailing newline.
33208 The socket specifier and both regular-expressions are required.
33209 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33210 specify an empty element to get this.
33211
33212 .vitem &%sophie%&
33213 .cindex "virus scanners" "Sophos and Sophie"
33214 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33215 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33216 for this scanner type is the path to the UNIX socket that Sophie uses for
33217 client communication. For example:
33218 .code
33219 av_scanner = sophie:/tmp/sophie
33220 .endd
33221 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33222 the option.
33223 .endlist
33224
33225 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33226 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33227 ACL.
33228
33229 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33230 makes it possible to use different scanners. See further below for an example.
33231 The &%malware%& condition caches its results, so when you use it multiple times
33232 for the same message, the actual scanning process is only carried out once.
33233 However, using expandable items in &%av_scanner%& disables this caching, in
33234 which case each use of the &%malware%& condition causes a new scan of the
33235 message.
33236
33237 The &%malware%& condition takes a right-hand argument that is expanded before
33238 use and taken as a list, slash-separated by default.
33239 The first element can then be one of
33240
33241 .ilist
33242 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33243 The condition succeeds if a virus was found, and fail otherwise. This is the
33244 recommended usage.
33245 .next
33246 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33247 the condition fails immediately.
33248 .next
33249 A regular expression, in which case the message is scanned for viruses. The
33250 condition succeeds if a virus is found and its name matches the regular
33251 expression. This allows you to take special actions on certain types of virus.
33252 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33253 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33254 .endlist
33255
33256 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33257 messages even if there is a problem with the virus scanner.
33258 Otherwise, such a problem causes the ACL to defer.
33259
33260 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33261 specify a non-default timeout.  The default is two minutes.
33262 For example:
33263 .code
33264 malware = * / defer_ok / tmo=10s
33265 .endd
33266 A timeout causes the ACL to defer.
33267
33268 .vindex "&$callout_address$&"
33269 When a connection is made to the scanner the expansion variable &$callout_address$&
33270 is set to record the actual address used.
33271
33272 .vindex "&$malware_name$&"
33273 When a virus is found, the condition sets up an expansion variable called
33274 &$malware_name$& that contains the name of the virus. You can use it in a
33275 &%message%& modifier that specifies the error returned to the sender, and/or in
33276 logging data.
33277
33278 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33279 imposed by your anti-virus scanner.
33280
33281 Here is a very simple scanning example:
33282 .code
33283 deny message = This message contains malware ($malware_name)
33284      malware = *
33285 .endd
33286 The next example accepts messages when there is a problem with the scanner:
33287 .code
33288 deny message = This message contains malware ($malware_name)
33289      malware = */defer_ok
33290 .endd
33291 The next example shows how to use an ACL variable to scan with both sophie and
33292 aveserver. It assumes you have set:
33293 .code
33294 av_scanner = $acl_m0
33295 .endd
33296 in the main Exim configuration.
33297 .code
33298 deny message = This message contains malware ($malware_name)
33299      set acl_m0 = sophie
33300      malware = *
33301
33302 deny message = This message contains malware ($malware_name)
33303      set acl_m0 = aveserver
33304      malware = *
33305 .endd
33306
33307
33308 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33309 .cindex "content scanning" "for spam"
33310 .cindex "spam scanning"
33311 .cindex "SpamAssassin"
33312 .cindex "Rspamd"
33313 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33314 score and a report for the message.
33315 Support is also provided for Rspamd.
33316
33317 For more information about installation and configuration of SpamAssassin or
33318 Rspamd refer to their respective websites at
33319 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33320
33321 SpamAssassin can be installed with CPAN by running:
33322 .code
33323 perl -MCPAN -e 'install Mail::SpamAssassin'
33324 .endd
33325 SpamAssassin has its own set of configuration files. Please review its
33326 documentation to see how you can tweak it. The default installation should work
33327 nicely, however.
33328
33329 .oindex "&%spamd_address%&"
33330 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33331 intend to use an instance running on the local host you do not need to set
33332 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33333 you must set the &%spamd_address%& option in the global part of the Exim
33334 configuration as follows (example):
33335 .code
33336 spamd_address = 192.168.99.45 783
33337 .endd
33338 The SpamAssassin protocol relies on a TCP half-close from the client.
33339 If your SpamAssassin client side is running a Linux system with an
33340 iptables firewall, consider setting
33341 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33342 timeout, Exim uses when waiting for a response from the SpamAssassin
33343 server (currently defaulting to 120s).  With a lower value the Linux
33344 connection tracking may consider your half-closed connection as dead too
33345 soon.
33346
33347
33348 To use Rspamd (which by default listens on all local addresses
33349 on TCP port 11333)
33350 you should add &%variant=rspamd%& after the address/port pair, for example:
33351 .code
33352 spamd_address = 127.0.0.1 11333 variant=rspamd
33353 .endd
33354
33355 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33356 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33357 filename instead of an address/port pair:
33358 .code
33359 spamd_address = /var/run/spamd_socket
33360 .endd
33361 You can have multiple &%spamd%& servers to improve scalability. These can
33362 reside on other hardware reachable over the network. To specify multiple
33363 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33364 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33365 .code
33366 spamd_address = 192.168.2.10 783 : \
33367                 192.168.2.11 783 : \
33368                 192.168.2.12 783
33369 .endd
33370 Up to 32 &%spamd%& servers are supported.
33371 When a server fails to respond to the connection attempt, all other
33372 servers are tried until one succeeds. If no server responds, the &%spam%&
33373 condition defers.
33374
33375 Unix and TCP socket specifications may be mixed in any order.
33376 Each element of the list is a list itself, space-separated by default
33377 and changeable in the usual way (&<<SECTlistsepchange>>&);
33378 take care to not double the separator.
33379
33380 For TCP socket specifications a host name or IP (v4 or v6, but
33381 subject to list-separator quoting rules) address can be used,
33382 and the port can be one or a dash-separated pair.
33383 In the latter case, the range is tried in strict order.
33384
33385 Elements after the first for Unix sockets, or second for TCP socket,
33386 are options.
33387 The supported options are:
33388 .code
33389 pri=<priority>      Selection priority
33390 weight=<value>      Selection bias
33391 time=<start>-<end>  Use only between these times of day
33392 retry=<timespec>    Retry on connect fail
33393 tmo=<timespec>      Connection time limit
33394 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33395 .endd
33396
33397 The &`pri`& option specifies a priority for the server within the list,
33398 higher values being tried first.
33399 The default priority is 1.
33400
33401 The &`weight`& option specifies a selection bias.
33402 Within a priority set
33403 servers are queried in a random fashion, weighted by this value.
33404 The default value for selection bias is 1.
33405
33406 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33407 in the local time zone; each element being one or more digits.
33408 Either the seconds or both minutes and seconds, plus the leading &`.`&
33409 characters, may be omitted and will be taken as zero.
33410
33411 Timeout specifications for the &`retry`& and &`tmo`& options
33412 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33413
33414 The &`tmo`& option specifies an overall timeout for communication.
33415 The default value is two minutes.
33416
33417 The &`retry`& option specifies a time after which a single retry for
33418 a failed connect is made.
33419 The default is to not retry.
33420
33421 The &%spamd_address%& variable is expanded before use if it starts with
33422 a dollar sign. In this case, the expansion may return a string that is
33423 used as the list so that multiple spamd servers can be the result of an
33424 expansion.
33425
33426 .vindex "&$callout_address$&"
33427 When a connection is made to the server the expansion variable &$callout_address$&
33428 is set to record the actual address used.
33429
33430 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33431 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33432 .code
33433 deny message = This message was classified as SPAM
33434      spam = joe
33435 .endd
33436 The right-hand side of the &%spam%& condition specifies a name. This is
33437 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33438 to scan using a specific profile, but rather use the SpamAssassin system-wide
33439 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33440 Rspamd does not use this setting. However, you must put something on the
33441 right-hand side.
33442
33443 The name allows you to use per-domain or per-user antispam profiles in
33444 principle, but this is not straightforward in practice, because a message may
33445 have multiple recipients, not necessarily all in the same domain. Because the
33446 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33447 read the contents of the message, the variables &$local_part$& and &$domain$&
33448 are not set.
33449 Careful enforcement of single-recipient messages
33450 (e.g. by responding with defer in the recipient ACL for all recipients
33451 after the first),
33452 or the use of PRDR,
33453 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33454 are needed to use this feature.
33455
33456 The right-hand side of the &%spam%& condition is expanded before being used, so
33457 you can put lookups or conditions there. When the right-hand side evaluates to
33458 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33459
33460
33461 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33462 large ones may cause significant performance degradation. As most spam messages
33463 are quite small, it is recommended that you do not scan the big ones. For
33464 example:
33465 .code
33466 deny message = This message was classified as SPAM
33467      condition = ${if < {$message_size}{10K}}
33468      spam = nobody
33469 .endd
33470
33471 The &%spam%& condition returns true if the threshold specified in the user's
33472 SpamAssassin profile has been matched or exceeded. If you want to use the
33473 &%spam%& condition for its side effects (see the variables below), you can make
33474 it always return &"true"& by appending &`:true`& to the username.
33475
33476 .cindex "spam scanning" "returned variables"
33477 When the &%spam%& condition is run, it sets up a number of expansion
33478 variables.
33479 Except for &$spam_report$&,
33480 these variables are saved with the received message so are
33481 available for use at delivery time.
33482
33483 .vlist
33484 .vitem &$spam_score$&
33485 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33486 for inclusion in log or reject messages.
33487
33488 .vitem &$spam_score_int$&
33489 The spam score of the message, multiplied by ten, as an integer value. For
33490 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33491 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33492 The integer value is useful for numeric comparisons in conditions.
33493
33494 .vitem &$spam_bar$&
33495 A string consisting of a number of &"+"& or &"-"& characters, representing the
33496 integer part of the spam score value. A spam score of 4.4 would have a
33497 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33498 headers, since MUAs can match on such strings. The maximum length of the
33499 spam bar is 50 characters.
33500
33501 .vitem &$spam_report$&
33502 A multiline text table, containing the full SpamAssassin report for the
33503 message. Useful for inclusion in headers or reject messages.
33504 This variable is only usable in a DATA-time ACL.
33505 Beware that SpamAssassin may return non-ASCII characters, especially
33506 when running in country-specific locales, which are not legal
33507 unencoded in headers.
33508
33509 .vitem &$spam_action$&
33510 For SpamAssassin either 'reject' or 'no action' depending on the
33511 spam score versus threshold.
33512 For Rspamd, the recommended action.
33513
33514 .endlist
33515
33516 The &%spam%& condition caches its results unless expansion in
33517 spamd_address was used. If you call it again with the same user name, it
33518 does not scan again, but rather returns the same values as before.
33519
33520 The &%spam%& condition returns DEFER if there is any error while running
33521 the message through SpamAssassin or if the expansion of spamd_address
33522 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33523 statement block), append &`/defer_ok`& to the right-hand side of the
33524 spam condition, like this:
33525 .code
33526 deny message = This message was classified as SPAM
33527      spam    = joe/defer_ok
33528 .endd
33529 This causes messages to be accepted even if there is a problem with &%spamd%&.
33530
33531 Here is a longer, commented example of the use of the &%spam%&
33532 condition:
33533 .code
33534 # put headers in all messages (no matter if spam or not)
33535 warn  spam = nobody:true
33536       add_header = X-Spam-Score: $spam_score ($spam_bar)
33537       add_header = X-Spam-Report: $spam_report
33538
33539 # add second subject line with *SPAM* marker when message
33540 # is over threshold
33541 warn  spam = nobody
33542       add_header = Subject: *SPAM* $h_Subject:
33543
33544 # reject spam at high scores (> 12)
33545 deny  message = This message scored $spam_score spam points.
33546       spam = nobody:true
33547       condition = ${if >{$spam_score_int}{120}{1}{0}}
33548 .endd
33549
33550
33551
33552 .section "Scanning MIME parts" "SECTscanmimepart"
33553 .cindex "content scanning" "MIME parts"
33554 .cindex "MIME content scanning"
33555 .oindex "&%acl_smtp_mime%&"
33556 .oindex "&%acl_not_smtp_mime%&"
33557 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33558 each MIME part of an SMTP message, including multipart types, in the sequence
33559 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33560 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33561 options may both refer to the same ACL if you want the same processing in both
33562 cases.
33563
33564 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33565 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33566 the case of a non-SMTP message. However, a MIME ACL is called only if the
33567 message contains a &'Content-Type:'& header line. When a call to a MIME
33568 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33569 result code is sent to the client. In the case of an SMTP message, the
33570 &%acl_smtp_data%& ACL is not called when this happens.
33571
33572 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33573 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33574 condition to match against the raw MIME part. You can also use the
33575 &%mime_regex%& condition to match against the decoded MIME part (see section
33576 &<<SECTscanregex>>&).
33577
33578 At the start of a MIME ACL, a number of variables are set from the header
33579 information for the relevant MIME part. These are described below. The contents
33580 of the MIME part are not by default decoded into a disk file except for MIME
33581 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33582 part into a disk file, you can use the &%decode%& condition. The general
33583 syntax is:
33584 .display
33585 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33586 .endd
33587 The right hand side is expanded before use. After expansion,
33588 the value can be:
33589
33590 .olist
33591 &"0"& or &"false"&, in which case no decoding is done.
33592 .next
33593 The string &"default"&. In that case, the file is put in the temporary
33594 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33595 a sequential filename consisting of the message id and a sequence number. The
33596 full path and name is available in &$mime_decoded_filename$& after decoding.
33597 .next
33598 A full path name starting with a slash. If the full name is an existing
33599 directory, it is used as a replacement for the default directory. The filename
33600 is then sequentially assigned. If the path does not exist, it is used as
33601 the full path and filename.
33602 .next
33603 If the string does not start with a slash, it is used as the
33604 filename, and the default path is then used.
33605 .endlist
33606 The &%decode%& condition normally succeeds. It is only false for syntax
33607 errors or unusual circumstances such as memory shortages. You can easily decode
33608 a file with its original, proposed filename using
33609 .code
33610 decode = $mime_filename
33611 .endd
33612 However, you should keep in mind that &$mime_filename$& might contain
33613 anything. If you place files outside of the default path, they are not
33614 automatically unlinked.
33615
33616 For RFC822 attachments (these are messages attached to messages, with a
33617 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33618 as for the primary message, only that the &$mime_is_rfc822$& expansion
33619 variable is set (see below). Attached messages are always decoded to disk
33620 before being checked, and the files are unlinked once the check is done.
33621
33622 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33623 used to match regular expressions against raw and decoded MIME parts,
33624 respectively. They are described in section &<<SECTscanregex>>&.
33625
33626 .cindex "MIME content scanning" "returned variables"
33627 The following list describes all expansion variables that are
33628 available in the MIME ACL:
33629
33630 .vlist
33631 .vitem &$mime_boundary$&
33632 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33633 have a boundary string, which is stored in this variable. If the current part
33634 has no boundary parameter in the &'Content-Type:'& header, this variable
33635 contains the empty string.
33636
33637 .vitem &$mime_charset$&
33638 This variable contains the character set identifier, if one was found in the
33639 &'Content-Type:'& header. Examples for charset identifiers are:
33640 .code
33641 us-ascii
33642 gb2312 (Chinese)
33643 iso-8859-1
33644 .endd
33645 Please note that this value is not normalized, so you should do matches
33646 case-insensitively.
33647
33648 .vitem &$mime_content_description$&
33649 This variable contains the normalized content of the &'Content-Description:'&
33650 header. It can contain a human-readable description of the parts content. Some
33651 implementations repeat the filename for attachments here, but they are usually
33652 only used for display purposes.
33653
33654 .vitem &$mime_content_disposition$&
33655 This variable contains the normalized content of the &'Content-Disposition:'&
33656 header. You can expect strings like &"attachment"& or &"inline"& here.
33657
33658 .vitem &$mime_content_id$&
33659 This variable contains the normalized content of the &'Content-ID:'& header.
33660 This is a unique ID that can be used to reference a part from another part.
33661
33662 .vitem &$mime_content_size$&
33663 This variable is set only after the &%decode%& modifier (see above) has been
33664 successfully run. It contains the size of the decoded part in kilobytes. The
33665 size is always rounded up to full kilobytes, so only a completely empty part
33666 has a &$mime_content_size$& of zero.
33667
33668 .vitem &$mime_content_transfer_encoding$&
33669 This variable contains the normalized content of the
33670 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33671 type. Typical values are &"base64"& and &"quoted-printable"&.
33672
33673 .vitem &$mime_content_type$&
33674 If the MIME part has a &'Content-Type:'& header, this variable contains its
33675 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33676 are some examples of popular MIME types, as they may appear in this variable:
33677 .code
33678 text/plain
33679 text/html
33680 application/octet-stream
33681 image/jpeg
33682 audio/midi
33683 .endd
33684 If the MIME part has no &'Content-Type:'& header, this variable contains the
33685 empty string.
33686
33687 .vitem &$mime_decoded_filename$&
33688 This variable is set only after the &%decode%& modifier (see above) has been
33689 successfully run. It contains the full path and filename of the file
33690 containing the decoded data.
33691 .endlist
33692
33693 .cindex "RFC 2047"
33694 .vlist
33695 .vitem &$mime_filename$&
33696 This is perhaps the most important of the MIME variables. It contains a
33697 proposed filename for an attachment, if one was found in either the
33698 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33699 RFC2047
33700 or RFC2231
33701 decoded, but no additional sanity checks are done.
33702  If no filename was
33703 found, this variable contains the empty string.
33704
33705 .vitem &$mime_is_coverletter$&
33706 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33707 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33708 content in the cover letter, while not restricting attachments at all.
33709
33710 The variable contains 1 (true) for a MIME part believed to be part of the
33711 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33712 follows:
33713
33714 .olist
33715 The outermost MIME part of a message is always a cover letter.
33716
33717 .next
33718 If a multipart/alternative or multipart/related MIME part is a cover letter,
33719 so are all MIME subparts within that multipart.
33720
33721 .next
33722 If any other multipart is a cover letter, the first subpart is a cover letter,
33723 and the rest are attachments.
33724
33725 .next
33726 All parts contained within an attachment multipart are attachments.
33727 .endlist olist
33728
33729 As an example, the following will ban &"HTML mail"& (including that sent with
33730 alternative plain text), while allowing HTML files to be attached. HTML
33731 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33732 .code
33733 deny message = HTML mail is not accepted here
33734 !condition = $mime_is_rfc822
33735 condition = $mime_is_coverletter
33736 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33737 .endd
33738 .vitem &$mime_is_multipart$&
33739 This variable has the value 1 (true) when the current part has the main type
33740 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33741 Since multipart entities only serve as containers for other parts, you may not
33742 want to carry out specific actions on them.
33743
33744 .vitem &$mime_is_rfc822$&
33745 This variable has the value 1 (true) if the current part is not a part of the
33746 checked message itself, but part of an attached message. Attached message
33747 decoding is fully recursive.
33748
33749 .vitem &$mime_part_count$&
33750 This variable is a counter that is raised for each processed MIME part. It
33751 starts at zero for the very first part (which is usually a multipart). The
33752 counter is per-message, so it is reset when processing RFC822 attachments (see
33753 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33754 complete, so you can use it in the DATA ACL to determine the number of MIME
33755 parts of a message. For non-MIME messages, this variable contains the value -1.
33756 .endlist
33757
33758
33759
33760 .section "Scanning with regular expressions" "SECTscanregex"
33761 .cindex "content scanning" "with regular expressions"
33762 .cindex "regular expressions" "content scanning with"
33763 You can specify your own custom regular expression matches on the full body of
33764 the message, or on individual MIME parts.
33765
33766 The &%regex%& condition takes one or more regular expressions as arguments and
33767 matches them against the full message (when called in the DATA ACL) or a raw
33768 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33769 linewise, with a maximum line length of 32K characters. That means you cannot
33770 have multiline matches with the &%regex%& condition.
33771
33772 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33773 to 32K of decoded content (the whole content at once, not linewise). If the
33774 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33775 is decoded automatically when &%mime_regex%& is executed (using default path
33776 and filename values). If the decoded data is larger than  32K, only the first
33777 32K characters are checked.
33778
33779 The regular expressions are passed as a colon-separated list. To include a
33780 literal colon, you must double it. Since the whole right-hand side string is
33781 expanded before being used, you must also escape dollar signs and backslashes
33782 with more backslashes, or use the &`\N`& facility to disable expansion.
33783 Here is a simple example that contains two regular expressions:
33784 .code
33785 deny message = contains blacklisted regex ($regex_match_string)
33786      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33787 .endd
33788 The conditions returns true if any one of the regular expressions matches. The
33789 &$regex_match_string$& expansion variable is then set up and contains the
33790 matching regular expression.
33791 The expansion variables &$regex1$& &$regex2$& etc
33792 are set to any substrings captured by the regular expression.
33793
33794 &*Warning*&: With large messages, these conditions can be fairly
33795 CPU-intensive.
33796
33797 .ecindex IIDcosca
33798
33799
33800
33801
33802 . ////////////////////////////////////////////////////////////////////////////
33803 . ////////////////////////////////////////////////////////////////////////////
33804
33805 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33806          "Local scan function"
33807 .scindex IIDlosca "&[local_scan()]& function" "description of"
33808 .cindex "customizing" "input scan using C function"
33809 .cindex "policy control" "by local scan function"
33810 In these days of email worms, viruses, and ever-increasing spam, some sites
33811 want to apply a lot of checking to messages before accepting them.
33812
33813 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33814 passing messages to external virus and spam scanning software. You can also do
33815 a certain amount in Exim itself through string expansions and the &%condition%&
33816 condition in the ACL that runs after the SMTP DATA command or the ACL for
33817 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33818
33819 To allow for further customization to a site's own requirements, there is the
33820 possibility of linking Exim with a private message scanning function, written
33821 in C. If you want to run code that is written in something other than C, you
33822 can of course use a little C stub to call it.
33823
33824 The local scan function is run once for every incoming message, at the point
33825 when Exim is just about to accept the message.
33826 It can therefore be used to control non-SMTP messages from local processes as
33827 well as messages arriving via SMTP.
33828
33829 Exim applies a timeout to calls of the local scan function, and there is an
33830 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33831 Zero means &"no timeout"&.
33832 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33833 before calling the local scan function, so that the most common types of crash
33834 are caught. If the timeout is exceeded or one of those signals is caught, the
33835 incoming message is rejected with a temporary error if it is an SMTP message.
33836 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33837 code. The incident is logged on the main and reject logs.
33838
33839
33840
33841 .section "Building Exim to use a local scan function" "SECID207"
33842 .cindex "&[local_scan()]& function" "building Exim to use"
33843 To make use of the local scan function feature, you must tell Exim where your
33844 function is before building Exim, by setting
33845 both HAVE_LOCAL_SCAN and
33846 LOCAL_SCAN_SOURCE in your
33847 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33848 directory, so you might set
33849 .code
33850 HAVE_LOCAL_SCAN=yes
33851 LOCAL_SCAN_SOURCE=Local/local_scan.c
33852 .endd
33853 for example. The function must be called &[local_scan()]&;
33854 .new
33855 the source file(s) for it should first #define LOCAL_SCAN
33856 and then #include "local_scan.h".
33857 .wen
33858 It is called by
33859 Exim after it has received a message, when the success return code is about to
33860 be sent. This is after all the ACLs have been run. The return code from your
33861 function controls whether the message is actually accepted or not. There is a
33862 commented template function (that just accepts the message) in the file
33863 _src/local_scan.c_.
33864
33865 If you want to make use of Exim's runtime configuration file to set options
33866 for your &[local_scan()]& function, you must also set
33867 .code
33868 LOCAL_SCAN_HAS_OPTIONS=yes
33869 .endd
33870 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33871
33872
33873
33874
33875 .section "API for local_scan()" "SECTapiforloc"
33876 .cindex "&[local_scan()]& function" "API description"
33877 .cindex &%dlfunc%& "API description"
33878 You must include this line near the start of your code:
33879 .code
33880 #include "local_scan.h"
33881 .endd
33882 This header file defines a number of variables and other values, and the
33883 prototype for the function itself. Exim is coded to use unsigned char values
33884 almost exclusively, and one of the things this header defines is a shorthand
33885 for &`unsigned char`& called &`uschar`&.
33886 It also contains the following macro definitions, to simplify casting character
33887 strings and pointers to character strings:
33888 .code
33889 #define CS   (char *)
33890 #define CCS  (const char *)
33891 #define CSS  (char **)
33892 #define US   (unsigned char *)
33893 #define CUS  (const unsigned char *)
33894 #define USS  (unsigned char **)
33895 .endd
33896 The function prototype for &[local_scan()]& is:
33897 .code
33898 extern int local_scan(int fd, uschar **return_text);
33899 .endd
33900 The arguments are as follows:
33901
33902 .ilist
33903 &%fd%& is a file descriptor for the file that contains the body of the message
33904 (the -D file). The file is open for reading and writing, but updating it is not
33905 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33906
33907 The descriptor is positioned at character 19 of the file, which is the first
33908 character of the body itself, because the first 19 characters are the message
33909 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33910 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33911 case this changes in some future version.
33912 .next
33913 &%return_text%& is an address which you can use to return a pointer to a text
33914 string at the end of the function. The value it points to on entry is NULL.
33915 .endlist
33916
33917 The function must return an &%int%& value which is one of the following macros:
33918
33919 .vlist
33920 .vitem &`LOCAL_SCAN_ACCEPT`&
33921 .vindex "&$local_scan_data$&"
33922 The message is accepted. If you pass back a string of text, it is saved with
33923 the message, and made available in the variable &$local_scan_data$&. No
33924 newlines are permitted (if there are any, they are turned into spaces) and the
33925 maximum length of text is 1000 characters.
33926
33927 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33928 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33929 queued without immediate delivery, and is frozen.
33930
33931 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33932 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33933 queued without immediate delivery.
33934
33935 .vitem &`LOCAL_SCAN_REJECT`&
33936 The message is rejected; the returned text is used as an error message which is
33937 passed back to the sender and which is also logged. Newlines are permitted &--
33938 they cause a multiline response for SMTP rejections, but are converted to
33939 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33940 used.
33941
33942 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33943 The message is temporarily rejected; the returned text is used as an error
33944 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33945 problem"& is used.
33946
33947 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33948 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33949 message is not written to the reject log. It has the effect of unsetting the
33950 &%rejected_header%& log selector for just this rejection. If
33951 &%rejected_header%& is already unset (see the discussion of the
33952 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33953 same as LOCAL_SCAN_REJECT.
33954
33955 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33956 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33957 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33958 .endlist
33959
33960 If the message is not being received by interactive SMTP, rejections are
33961 reported by writing to &%stderr%& or by sending an email, as configured by the
33962 &%-oe%& command line options.
33963
33964
33965
33966 .section "Configuration options for local_scan()" "SECTconoptloc"
33967 .cindex "&[local_scan()]& function" "configuration options"
33968 It is possible to have option settings in the main configuration file
33969 that set values in static variables in the &[local_scan()]& module. If you
33970 want to do this, you must have the line
33971 .code
33972 LOCAL_SCAN_HAS_OPTIONS=yes
33973 .endd
33974 in your &_Local/Makefile_& when you build Exim. (This line is in
33975 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33976 file, you must define static variables to hold the option values, and a table
33977 to define them.
33978
33979 The table must be a vector called &%local_scan_options%&, of type
33980 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33981 and a pointer to the variable that holds the value. The entries must appear in
33982 alphabetical order. Following &%local_scan_options%& you must also define a
33983 variable called &%local_scan_options_count%& that contains the number of
33984 entries in the table. Here is a short example, showing two kinds of option:
33985 .code
33986 static int my_integer_option = 42;
33987 static uschar *my_string_option = US"a default string";
33988
33989 optionlist local_scan_options[] = {
33990   { "my_integer", opt_int,       &my_integer_option },
33991   { "my_string",  opt_stringptr, &my_string_option }
33992 };
33993
33994 int local_scan_options_count =
33995   sizeof(local_scan_options)/sizeof(optionlist);
33996 .endd
33997 The values of the variables can now be changed from Exim's runtime
33998 configuration file by including a local scan section as in this example:
33999 .code
34000 begin local_scan
34001 my_integer = 99
34002 my_string = some string of text...
34003 .endd
34004 The available types of option data are as follows:
34005
34006 .vlist
34007 .vitem &*opt_bool*&
34008 This specifies a boolean (true/false) option. The address should point to a
34009 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34010 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34011 whether such a variable has been set at all, you can initialize it to
34012 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34013 values.)
34014
34015 .vitem &*opt_fixed*&
34016 This specifies a fixed point number, such as is used for load averages.
34017 The address should point to a variable of type &`int`&. The value is stored
34018 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34019
34020 .vitem &*opt_int*&
34021 This specifies an integer; the address should point to a variable of type
34022 &`int`&. The value may be specified in any of the integer formats accepted by
34023 Exim.
34024
34025 .vitem &*opt_mkint*&
34026 This is the same as &%opt_int%&, except that when such a value is output in a
34027 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34028 printed with the suffix K or M.
34029
34030 .vitem &*opt_octint*&
34031 This also specifies an integer, but the value is always interpreted as an
34032 octal integer, whether or not it starts with the digit zero, and it is
34033 always output in octal.
34034
34035 .vitem &*opt_stringptr*&
34036 This specifies a string value; the address must be a pointer to a
34037 variable that points to a string (for example, of type &`uschar *`&).
34038
34039 .vitem &*opt_time*&
34040 This specifies a time interval value. The address must point to a variable of
34041 type &`int`&. The value that is placed there is a number of seconds.
34042 .endlist
34043
34044 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34045 out the values of all the &[local_scan()]& options.
34046
34047
34048
34049 .section "Available Exim variables" "SECID208"
34050 .cindex "&[local_scan()]& function" "available Exim variables"
34051 The header &_local_scan.h_& gives you access to a number of C variables. These
34052 are the only ones that are guaranteed to be maintained from release to release.
34053 Note, however, that you can obtain the value of any Exim expansion variable,
34054 including &$recipients$&, by calling &'expand_string()'&. The exported
34055 C variables are as follows:
34056
34057 .vlist
34058 .vitem &*int&~body_linecount*&
34059 This variable contains the number of lines in the message's body.
34060 It is not valid if the &%spool_files_wireformat%& option is used.
34061
34062 .vitem &*int&~body_zerocount*&
34063 This variable contains the number of binary zero bytes in the message's body.
34064 It is not valid if the &%spool_files_wireformat%& option is used.
34065
34066 .vitem &*unsigned&~int&~debug_selector*&
34067 This variable is set to zero when no debugging is taking place. Otherwise, it
34068 is a bitmap of debugging selectors. Two bits are identified for use in
34069 &[local_scan()]&; they are defined as macros:
34070
34071 .ilist
34072 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34073 testing option that is not privileged &-- any caller may set it. All the
34074 other selector bits can be set only by admin users.
34075
34076 .next
34077 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34078 by the &`+local_scan`& debug selector. It is not included in the default set
34079 of debugging bits.
34080 .endlist ilist
34081
34082 Thus, to write to the debugging output only when &`+local_scan`& has been
34083 selected, you should use code like this:
34084 .code
34085 if ((debug_selector & D_local_scan) != 0)
34086   debug_printf("xxx", ...);
34087 .endd
34088 .vitem &*uschar&~*expand_string_message*&
34089 After a failing call to &'expand_string()'& (returned value NULL), the
34090 variable &%expand_string_message%& contains the error message, zero-terminated.
34091
34092 .vitem &*header_line&~*header_list*&
34093 A pointer to a chain of header lines. The &%header_line%& structure is
34094 discussed below.
34095
34096 .vitem &*header_line&~*header_last*&
34097 A pointer to the last of the header lines.
34098
34099 .vitem &*uschar&~*headers_charset*&
34100 The value of the &%headers_charset%& configuration option.
34101
34102 .vitem &*BOOL&~host_checking*&
34103 This variable is TRUE during a host checking session that is initiated by the
34104 &%-bh%& command line option.
34105
34106 .vitem &*uschar&~*interface_address*&
34107 The IP address of the interface that received the message, as a string. This
34108 is NULL for locally submitted messages.
34109
34110 .vitem &*int&~interface_port*&
34111 The port on which this message was received. When testing with the &%-bh%&
34112 command line option, the value of this variable is -1 unless a port has been
34113 specified via the &%-oMi%& option.
34114
34115 .vitem &*uschar&~*message_id*&
34116 This variable contains Exim's message id for the incoming message (the value of
34117 &$message_exim_id$&) as a zero-terminated string.
34118
34119 .vitem &*uschar&~*received_protocol*&
34120 The name of the protocol by which the message was received.
34121
34122 .vitem &*int&~recipients_count*&
34123 The number of accepted recipients.
34124
34125 .vitem &*recipient_item&~*recipients_list*&
34126 .cindex "recipient" "adding in local scan"
34127 .cindex "recipient" "removing in local scan"
34128 The list of accepted recipients, held in a vector of length
34129 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34130 can add additional recipients by calling &'receive_add_recipient()'& (see
34131 below). You can delete recipients by removing them from the vector and
34132 adjusting the value in &%recipients_count%&. In particular, by setting
34133 &%recipients_count%& to zero you remove all recipients. If you then return the
34134 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34135 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34136 and then call &'receive_add_recipient()'& as often as needed.
34137
34138 .vitem &*uschar&~*sender_address*&
34139 The envelope sender address. For bounce messages this is the empty string.
34140
34141 .vitem &*uschar&~*sender_host_address*&
34142 The IP address of the sending host, as a string. This is NULL for
34143 locally-submitted messages.
34144
34145 .vitem &*uschar&~*sender_host_authenticated*&
34146 The name of the authentication mechanism that was used, or NULL if the message
34147 was not received over an authenticated SMTP connection.
34148
34149 .vitem &*uschar&~*sender_host_name*&
34150 The name of the sending host, if known.
34151
34152 .vitem &*int&~sender_host_port*&
34153 The port on the sending host.
34154
34155 .vitem &*BOOL&~smtp_input*&
34156 This variable is TRUE for all SMTP input, including BSMTP.
34157
34158 .vitem &*BOOL&~smtp_batched_input*&
34159 This variable is TRUE for BSMTP input.
34160
34161 .vitem &*int&~store_pool*&
34162 The contents of this variable control which pool of memory is used for new
34163 requests. See section &<<SECTmemhanloc>>& for details.
34164 .endlist
34165
34166
34167 .section "Structure of header lines" "SECID209"
34168 The &%header_line%& structure contains the members listed below.
34169 You can add additional header lines by calling the &'header_add()'& function
34170 (see below). You can cause header lines to be ignored (deleted) by setting
34171 their type to *.
34172
34173
34174 .vlist
34175 .vitem &*struct&~header_line&~*next*&
34176 A pointer to the next header line, or NULL for the last line.
34177
34178 .vitem &*int&~type*&
34179 A code identifying certain headers that Exim recognizes. The codes are printing
34180 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34181 Notice in particular that any header line whose type is * is not transmitted
34182 with the message. This flagging is used for header lines that have been
34183 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34184 lines.) Effectively, * means &"deleted"&.
34185
34186 .vitem &*int&~slen*&
34187 The number of characters in the header line, including the terminating and any
34188 internal newlines.
34189
34190 .vitem &*uschar&~*text*&
34191 A pointer to the text of the header. It always ends with a newline, followed by
34192 a zero byte. Internal newlines are preserved.
34193 .endlist
34194
34195
34196
34197 .section "Structure of recipient items" "SECID210"
34198 The &%recipient_item%& structure contains these members:
34199
34200 .vlist
34201 .vitem &*uschar&~*address*&
34202 This is a pointer to the recipient address as it was received.
34203
34204 .vitem &*int&~pno*&
34205 This is used in later Exim processing when top level addresses are created by
34206 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34207 and must always contain -1 at this stage.
34208
34209 .vitem &*uschar&~*errors_to*&
34210 If this value is not NULL, bounce messages caused by failing to deliver to the
34211 recipient are sent to the address it contains. In other words, it overrides the
34212 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34213 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34214 an unqualified address, Exim qualifies it using the domain from
34215 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34216 is NULL for all recipients.
34217 .endlist
34218
34219
34220
34221 .section "Available Exim functions" "SECID211"
34222 .cindex "&[local_scan()]& function" "available Exim functions"
34223 The header &_local_scan.h_& gives you access to a number of Exim functions.
34224 These are the only ones that are guaranteed to be maintained from release to
34225 release:
34226
34227 .vlist
34228 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34229        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34230
34231 This function creates a child process that runs the command specified by
34232 &%argv%&. The environment for the process is specified by &%envp%&, which can
34233 be NULL if no environment variables are to be passed. A new umask is supplied
34234 for the process in &%newumask%&.
34235
34236 Pipes to the standard input and output of the new process are set up
34237 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34238 standard error is cloned to the standard output. If there are any file
34239 descriptors &"in the way"& in the new process, they are closed. If the final
34240 argument is TRUE, the new process is made into a process group leader.
34241
34242 The function returns the pid of the new process, or -1 if things go wrong.
34243
34244 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34245 This function waits for a child process to terminate, or for a timeout (in
34246 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34247 return value is as follows:
34248
34249 .ilist
34250 >= 0
34251
34252 The process terminated by a normal exit and the value is the process
34253 ending status.
34254
34255 .next
34256 < 0 and > &--256
34257
34258 The process was terminated by a signal and the value is the negation of the
34259 signal number.
34260
34261 .next
34262 &--256
34263
34264 The process timed out.
34265 .next
34266 &--257
34267
34268 The was some other error in wait(); &%errno%& is still set.
34269 .endlist
34270
34271 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34272 This function provide you with a means of submitting a new message to
34273 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34274 want, but this packages it all up for you.) The function creates a pipe,
34275 forks a subprocess that is running
34276 .code
34277 exim -t -oem -oi -f <>
34278 .endd
34279 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34280 that is connected to the standard input. The yield of the function is the PID
34281 of the subprocess. You can then write a message to the file descriptor, with
34282 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34283
34284 When you have finished, call &'child_close()'& to wait for the process to
34285 finish and to collect its ending status. A timeout value of zero is usually
34286 fine in this circumstance. Unless you have made a mistake with the recipient
34287 addresses, you should get a return code of zero.
34288
34289
34290 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34291        *sender_authentication)*&
34292 This function is a more sophisticated version of &'child_open()'&. The command
34293 that it runs is:
34294 .display
34295 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34296 .endd
34297 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34298
34299
34300 .vitem &*void&~debug_printf(char&~*,&~...)*&
34301 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34302 output is written to the standard error stream. If no debugging is selected,
34303 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34304 conditional on the &`local_scan`& debug selector by coding like this:
34305 .code
34306 if ((debug_selector & D_local_scan) != 0)
34307   debug_printf("xxx", ...);
34308 .endd
34309
34310 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34311 This is an interface to Exim's string expansion code. The return value is the
34312 expanded string, or NULL if there was an expansion failure.
34313 The C variable &%expand_string_message%& contains an error message after an
34314 expansion failure. If expansion does not change the string, the return value is
34315 the pointer to the input string. Otherwise, the return value points to a new
34316 block of memory that was obtained by a call to &'store_get()'&. See section
34317 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34318
34319 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34320 This function allows you to an add additional header line at the end of the
34321 existing ones. The first argument is the type, and should normally be a space
34322 character. The second argument is a format string and any number of
34323 substitution arguments as for &[sprintf()]&. You may include internal newlines
34324 if you want, and you must ensure that the string ends with a newline.
34325
34326 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34327         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34328 This function adds a new header line at a specified point in the header
34329 chain. The header itself is specified as for &'header_add()'&.
34330
34331 If &%name%& is NULL, the new header is added at the end of the chain if
34332 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34333 NULL, the header lines are searched for the first non-deleted header that
34334 matches the name. If one is found, the new header is added before it if
34335 &%after%& is false. If &%after%& is true, the new header is added after the
34336 found header and any adjacent subsequent ones with the same name (even if
34337 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34338 option controls where the header is added. If it is true, addition is at the
34339 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34340 headers, or at the top if there are no &'Received:'& headers, you could use
34341 .code
34342 header_add_at_position(TRUE, US"Received", TRUE,
34343   ' ', "X-xxx: ...");
34344 .endd
34345 Normally, there is always at least one non-deleted &'Received:'& header, but
34346 there may not be if &%received_header_text%& expands to an empty string.
34347
34348
34349 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34350 This function removes header lines. If &%occurrence%& is zero or negative, all
34351 occurrences of the header are removed. If occurrence is greater than zero, that
34352 particular instance of the header is removed. If no header(s) can be found that
34353 match the specification, the function does nothing.
34354
34355
34356 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34357         int&~length,&~BOOL&~notdel)*&"
34358 This function tests whether the given header has the given name. It is not just
34359 a string comparison, because white space is permitted between the name and the
34360 colon. If the &%notdel%& argument is true, a false return is forced for all
34361 &"deleted"& headers; otherwise they are not treated specially. For example:
34362 .code
34363 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34364 .endd
34365 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34366 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34367 This function base64-encodes a string, which is passed by address and length.
34368 The text may contain bytes of any value, including zero. The result is passed
34369 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34370 zero-terminated.
34371
34372 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34373 This function decodes a base64-encoded string. Its arguments are a
34374 zero-terminated base64-encoded string and the address of a variable that is set
34375 to point to the result, which is in dynamic memory. The length of the decoded
34376 string is the yield of the function. If the input is invalid base64 data, the
34377 yield is -1. A zero byte is added to the end of the output string to make it
34378 easy to interpret as a C string (assuming it contains no zeros of its own). The
34379 added zero byte is not included in the returned count.
34380
34381 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34382 This function checks for a match in a domain list. Domains are always
34383 matched caselessly. The return value is one of the following:
34384 .display
34385 &`OK     `& match succeeded
34386 &`FAIL   `& match failed
34387 &`DEFER  `& match deferred
34388 .endd
34389 DEFER is usually caused by some kind of lookup defer, such as the
34390 inability to contact a database.
34391
34392 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34393         BOOL&~caseless)*&"
34394 This function checks for a match in a local part list. The third argument
34395 controls case-sensitivity. The return values are as for
34396 &'lss_match_domain()'&.
34397
34398 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34399         BOOL&~caseless)*&"
34400 This function checks for a match in an address list. The third argument
34401 controls the case-sensitivity of the local part match. The domain is always
34402 matched caselessly. The return values are as for &'lss_match_domain()'&.
34403
34404 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34405         uschar&~*list)*&"
34406 This function checks for a match in a host list. The most common usage is
34407 expected to be
34408 .code
34409 lss_match_host(sender_host_name, sender_host_address, ...)
34410 .endd
34411 .vindex "&$sender_host_address$&"
34412 An empty address field matches an empty item in the host list. If the host name
34413 is NULL, the name corresponding to &$sender_host_address$& is automatically
34414 looked up if a host name is required to match an item in the list. The return
34415 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34416 returns ERROR in the case when it had to look up a host name, but the lookup
34417 failed.
34418
34419 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34420         *format,&~...)*&"
34421 This function writes to Exim's log files. The first argument should be zero (it
34422 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34423 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34424 them. It specifies to which log or logs the message is written. The remaining
34425 arguments are a format and relevant insertion arguments. The string should not
34426 contain any newlines, not even at the end.
34427
34428
34429 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34430 This function adds an additional recipient to the message. The first argument
34431 is the recipient address. If it is unqualified (has no domain), it is qualified
34432 with the &%qualify_recipient%& domain. The second argument must always be -1.
34433
34434 This function does not allow you to specify a private &%errors_to%& address (as
34435 described with the structure of &%recipient_item%& above), because it pre-dates
34436 the addition of that field to the structure. However, it is easy to add such a
34437 value afterwards. For example:
34438 .code
34439  receive_add_recipient(US"monitor@mydom.example", -1);
34440  recipients_list[recipients_count-1].errors_to =
34441    US"postmaster@mydom.example";
34442 .endd
34443
34444 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34445 This is a convenience function to remove a named recipient from the list of
34446 recipients. It returns true if a recipient was removed, and false if no
34447 matching recipient could be found. The argument must be a complete email
34448 address.
34449 .endlist
34450
34451
34452 .cindex "RFC 2047"
34453 .vlist
34454 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34455   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34456 This function decodes strings that are encoded according to RFC 2047. Typically
34457 these are the contents of header lines. First, each &"encoded word"& is decoded
34458 from the Q or B encoding into a byte-string. Then, if provided with the name of
34459 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34460 made  to translate the result to the named character set. If this fails, the
34461 binary string is returned with an error message.
34462
34463 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34464 maximum MIME word length is enforced. The third argument is the target
34465 encoding, or NULL if no translation is wanted.
34466
34467 .cindex "binary zero" "in RFC 2047 decoding"
34468 .cindex "RFC 2047" "binary zero in"
34469 If a binary zero is encountered in the decoded string, it is replaced by the
34470 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34471 not be 0 because header lines are handled as zero-terminated strings.
34472
34473 The function returns the result of processing the string, zero-terminated; if
34474 &%lenptr%& is not NULL, the length of the result is set in the variable to
34475 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34476
34477 If an error is encountered, the function returns NULL and uses the &%error%&
34478 argument to return an error message. The variable pointed to by &%error%& is
34479 set to NULL if there is no error; it may be set non-NULL even when the function
34480 returns a non-NULL value if decoding was successful, but there was a problem
34481 with translation.
34482
34483
34484 .vitem &*int&~smtp_fflush(void)*&
34485 This function is used in conjunction with &'smtp_printf()'&, as described
34486 below.
34487
34488 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34489 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34490 output stream. You should use this function only when there is an SMTP output
34491 stream, that is, when the incoming message is being received via interactive
34492 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34493 is FALSE. If you want to test for an incoming message from another host (as
34494 opposed to a local process that used the &%-bs%& command line option), you can
34495 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34496 is involved.
34497
34498 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34499 output function, so it can be used for all forms of SMTP connection.
34500
34501 The second argument is used to request that the data be buffered
34502 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34503 This is advisory only, but likely to save on system-calls and packets
34504 sent when a sequence of calls to the function are made.
34505
34506 The argument was added in Exim version 4.90 - changing the API/ABI.
34507 Nobody noticed until 4.93 was imminent, at which point the
34508 ABI version number was incremented.
34509
34510 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34511 must start with an appropriate response code: 550 if you are going to return
34512 LOCAL_SCAN_REJECT, 451 if you are going to return
34513 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34514 initial lines of a multi-line response, the code must be followed by a hyphen
34515 to indicate that the line is not the final response line. You must also ensure
34516 that the lines you write terminate with CRLF. For example:
34517 .code
34518 smtp_printf("550-this is some extra info\r\n");
34519 return LOCAL_SCAN_REJECT;
34520 .endd
34521 Note that you can also create multi-line responses by including newlines in
34522 the data returned via the &%return_text%& argument. The added value of using
34523 &'smtp_printf()'& is that, for instance, you could introduce delays between
34524 multiple output lines.
34525
34526 The &'smtp_printf()'& function does not return any error indication, because it
34527 does not
34528 guarantee a flush of
34529 pending output, and therefore does not test
34530 the state of the stream. (In the main code of Exim, flushing and error
34531 detection is done when Exim is ready for the next SMTP input command.) If
34532 you want to flush the output and check for an error (for example, the
34533 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34534 arguments. It flushes the output stream, and returns a non-zero value if there
34535 is an error.
34536
34537 .new
34538 .vitem &*void&~*store_get(int,BOOL)*&
34539 This function accesses Exim's internal store (memory) manager. It gets a new
34540 chunk of memory whose size is given by the first argument.
34541 The second argument should be given as TRUE if the memory will be used for
34542 data possibly coming from an attacker (eg. the message content),
34543 FALSE if it is locally-sourced.
34544 Exim bombs out if it ever
34545 runs out of memory. See the next section for a discussion of memory handling.
34546 .wen
34547
34548 .vitem &*void&~*store_get_perm(int,BOOL)*&
34549 This function is like &'store_get()'&, but it always gets memory from the
34550 permanent pool. See the next section for a discussion of memory handling.
34551
34552 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34553 See below.
34554
34555 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34556 See below.
34557
34558 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34559 These three functions create strings using Exim's dynamic memory facilities.
34560 The first makes a copy of an entire string. The second copies up to a maximum
34561 number of characters, indicated by the second argument. The third uses a format
34562 and insertion arguments to create a new string. In each case, the result is a
34563 pointer to a new string in the current memory pool. See the next section for
34564 more discussion.
34565 .endlist
34566
34567
34568
34569 .section "More about Exim's memory handling" "SECTmemhanloc"
34570 .cindex "&[local_scan()]& function" "memory handling"
34571 No function is provided for freeing memory, because that is never needed.
34572 The dynamic memory that Exim uses when receiving a message is automatically
34573 recycled if another message is received by the same process (this applies only
34574 to incoming SMTP connections &-- other input methods can supply only one
34575 message at a time). After receiving the last message, a reception process
34576 terminates.
34577
34578 Because it is recycled, the normal dynamic memory cannot be used for holding
34579 data that must be preserved over a number of incoming messages on the same SMTP
34580 connection. However, Exim in fact uses two pools of dynamic memory; the second
34581 one is not recycled, and can be used for this purpose.
34582
34583 If you want to allocate memory that remains available for subsequent messages
34584 in the same SMTP connection, you should set
34585 .code
34586 store_pool = POOL_PERM
34587 .endd
34588 before calling the function that does the allocation. There is no need to
34589 restore the value if you do not need to; however, if you do want to revert to
34590 the normal pool, you can either restore the previous value of &%store_pool%& or
34591 set it explicitly to POOL_MAIN.
34592
34593 The pool setting applies to all functions that get dynamic memory, including
34594 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34595 There is also a convenience function called &'store_get_perm()'& that gets a
34596 block of memory from the permanent pool while preserving the value of
34597 &%store_pool%&.
34598 .ecindex IIDlosca
34599
34600
34601
34602
34603 . ////////////////////////////////////////////////////////////////////////////
34604 . ////////////////////////////////////////////////////////////////////////////
34605
34606 .chapter "System-wide message filtering" "CHAPsystemfilter"
34607 .scindex IIDsysfil1 "filter" "system filter"
34608 .scindex IIDsysfil2 "filtering all mail"
34609 .scindex IIDsysfil3 "system filter"
34610 The previous chapters (on ACLs and the local scan function) describe checks
34611 that can be applied to messages before they are accepted by a host. There is
34612 also a mechanism for checking messages once they have been received, but before
34613 they are delivered. This is called the &'system filter'&.
34614
34615 The system filter operates in a similar manner to users' filter files, but it
34616 is run just once per message (however many recipients the message has).
34617 It should not normally be used as a substitute for routing, because &%deliver%&
34618 commands in a system router provide new envelope recipient addresses.
34619 The system filter must be an Exim filter. It cannot be a Sieve filter.
34620
34621 The system filter is run at the start of a delivery attempt, before any routing
34622 is done. If a message fails to be completely delivered at the first attempt,
34623 the system filter is run again at the start of every retry.
34624 If you want your filter to do something only once per message, you can make use
34625 of the &%first_delivery%& condition in an &%if%& command in the filter to
34626 prevent it happening on retries.
34627
34628 .vindex "&$domain$&"
34629 .vindex "&$local_part$&"
34630 &*Warning*&: Because the system filter runs just once, variables that are
34631 specific to individual recipient addresses, such as &$local_part$& and
34632 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34633 you want to run a centrally-specified filter for each recipient address
34634 independently, you can do so by setting up a suitable &(redirect)& router, as
34635 described in section &<<SECTperaddfil>>& below.
34636
34637
34638 .section "Specifying a system filter" "SECID212"
34639 .cindex "uid (user id)" "system filter"
34640 .cindex "gid (group id)" "system filter"
34641 The name of the file that contains the system filter must be specified by
34642 setting &%system_filter%&. If you want the filter to run under a uid and gid
34643 other than root, you must also set &%system_filter_user%& and
34644 &%system_filter_group%& as appropriate. For example:
34645 .code
34646 system_filter = /etc/mail/exim.filter
34647 system_filter_user = exim
34648 .endd
34649 If a system filter generates any deliveries directly to files or pipes (via the
34650 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34651 specified by setting &%system_filter_file_transport%& and
34652 &%system_filter_pipe_transport%&, respectively. Similarly,
34653 &%system_filter_reply_transport%& must be set to handle any messages generated
34654 by the &%reply%& command.
34655
34656
34657 .section "Testing a system filter" "SECID213"
34658 You can run simple tests of a system filter in the same way as for a user
34659 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34660 are permitted only in system filters are recognized.
34661
34662 If you want to test the combined effect of a system filter and a user filter,
34663 you can use both &%-bF%& and &%-bf%& on the same command line.
34664
34665
34666
34667 .section "Contents of a system filter" "SECID214"
34668 The language used to specify system filters is the same as for users' filter
34669 files. It is described in the separate end-user document &'Exim's interface to
34670 mail filtering'&. However, there are some additional features that are
34671 available only in system filters; these are described in subsequent sections.
34672 If they are encountered in a user's filter file or when testing with &%-bf%&,
34673 they cause errors.
34674
34675 .cindex "frozen messages" "manual thaw; testing in filter"
34676 There are two special conditions which, though available in users' filter
34677 files, are designed for use in system filters. The condition &%first_delivery%&
34678 is true only for the first attempt at delivering a message, and
34679 &%manually_thawed%& is true only if the message has been frozen, and
34680 subsequently thawed by an admin user. An explicit forced delivery counts as a
34681 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34682
34683 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34684 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34685 succeed, it will not be tried again.
34686 If you want Exim to retry an unseen delivery until it succeeds, you should
34687 arrange to set it up every time the filter runs.
34688
34689 When a system filter finishes running, the values of the variables &$n0$& &--
34690 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34691 users' filter files. Thus a system filter can, for example, set up &"scores"&
34692 to which users' filter files can refer.
34693
34694
34695
34696 .section "Additional variable for system filters" "SECID215"
34697 .vindex "&$recipients$&"
34698 The expansion variable &$recipients$&, containing a list of all the recipients
34699 of the message (separated by commas and white space), is available in system
34700 filters. It is not available in users' filters for privacy reasons.
34701
34702
34703
34704 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34705 .cindex "freezing messages"
34706 .cindex "message" "freezing"
34707 .cindex "message" "forced failure"
34708 .cindex "&%fail%&" "in system filter"
34709 .cindex "&%freeze%& in system filter"
34710 .cindex "&%defer%& in system filter"
34711 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34712 always available in system filters, but are not normally enabled in users'
34713 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34714 for the &(redirect)& router.) These commands can optionally be followed by the
34715 word &%text%& and a string containing an error message, for example:
34716 .code
34717 fail text "this message looks like spam to me"
34718 .endd
34719 The keyword &%text%& is optional if the next character is a double quote.
34720
34721 The &%defer%& command defers delivery of the original recipients of the
34722 message. The &%fail%& command causes all the original recipients to be failed,
34723 and a bounce message to be created. The &%freeze%& command suspends all
34724 delivery attempts for the original recipients. In all cases, any new deliveries
34725 that are specified by the filter are attempted as normal after the filter has
34726 run.
34727
34728 The &%freeze%& command is ignored if the message has been manually unfrozen and
34729 not manually frozen since. This means that automatic freezing by a system
34730 filter can be used as a way of checking out suspicious messages. If a message
34731 is found to be all right, manually unfreezing it allows it to be delivered.
34732
34733 .cindex "log" "&%fail%& command log line"
34734 .cindex "&%fail%&" "log line; reducing"
34735 The text given with a fail command is used as part of the bounce message as
34736 well as being written to the log. If the message is quite long, this can fill
34737 up a lot of log space when such failures are common. To reduce the size of the
34738 log message, Exim interprets the text in a special way if it starts with the
34739 two characters &`<<`& and contains &`>>`& later. The text between these two
34740 strings is written to the log, and the rest of the text is used in the bounce
34741 message. For example:
34742 .code
34743 fail "<<filter test 1>>Your message is rejected \
34744      because it contains attachments that we are \
34745      not prepared to receive."
34746 .endd
34747
34748 .cindex "loop" "caused by &%fail%&"
34749 Take great care with the &%fail%& command when basing the decision to fail on
34750 the contents of the message, because the bounce message will of course include
34751 the contents of the original message and will therefore trigger the &%fail%&
34752 command again (causing a mail loop) unless steps are taken to prevent this.
34753 Testing the &%error_message%& condition is one way to prevent this. You could
34754 use, for example
34755 .code
34756 if $message_body contains "this is spam" and not error_message
34757 then fail text "spam is not wanted here" endif
34758 .endd
34759 though of course that might let through unwanted bounce messages. The
34760 alternative is clever checking of the body and/or headers to detect bounces
34761 generated by the filter.
34762
34763 The interpretation of a system filter file ceases after a
34764 &%defer%&,
34765 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34766 set up earlier in the filter file are honoured, so you can use a sequence such
34767 as
34768 .code
34769 mail ...
34770 freeze
34771 .endd
34772 to send a specified message when the system filter is freezing (or deferring or
34773 failing) a message. The normal deliveries for the message do not, of course,
34774 take place.
34775
34776
34777
34778 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34779 .cindex "header lines" "adding; in system filter"
34780 .cindex "header lines" "removing; in system filter"
34781 .cindex "filter" "header lines; adding/removing"
34782 Two filter commands that are available only in system filters are:
34783 .code
34784 headers add <string>
34785 headers remove <string>
34786 .endd
34787 The argument for the &%headers add%& is a string that is expanded and then
34788 added to the end of the message's headers. It is the responsibility of the
34789 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34790 space is ignored, and if the string is otherwise empty, or if the expansion is
34791 forced to fail, the command has no effect.
34792
34793 You can use &"\n"& within the string, followed by white space, to specify
34794 continued header lines. More than one header may be added in one command by
34795 including &"\n"& within the string without any following white space. For
34796 example:
34797 .code
34798 headers add "X-header-1: ....\n  \
34799              continuation of X-header-1 ...\n\
34800              X-header-2: ...."
34801 .endd
34802 Note that the header line continuation white space after the first newline must
34803 be placed before the backslash that continues the input string, because white
34804 space after input continuations is ignored.
34805
34806 The argument for &%headers remove%& is a colon-separated list of header names.
34807 This command applies only to those headers that are stored with the message;
34808 those that are added at delivery time (such as &'Envelope-To:'& and
34809 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34810 header with the same name, they are all removed.
34811
34812 The &%headers%& command in a system filter makes an immediate change to the set
34813 of header lines that was received with the message (with possible additions
34814 from ACL processing). Subsequent commands in the system filter operate on the
34815 modified set, which also forms the basis for subsequent message delivery.
34816 Unless further modified during routing or transporting, this set of headers is
34817 used for all recipients of the message.
34818
34819 During routing and transporting, the variables that refer to the contents of
34820 header lines refer only to those lines that are in this set. Thus, header lines
34821 that are added by a system filter are visible to users' filter files and to all
34822 routers and transports. This contrasts with the manipulation of header lines by
34823 routers and transports, which is not immediate, but which instead is saved up
34824 until the message is actually being written (see section
34825 &<<SECTheadersaddrem>>&).
34826
34827 If the message is not delivered at the first attempt, header lines that were
34828 added by the system filter are stored with the message, and so are still
34829 present at the next delivery attempt. Header lines that were removed are still
34830 present, but marked &"deleted"& so that they are not transported with the
34831 message. For this reason, it is usual to make the &%headers%& command
34832 conditional on &%first_delivery%& so that the set of header lines is not
34833 modified more than once.
34834
34835 Because header modification in a system filter acts immediately, you have to
34836 use an indirect approach if you want to modify the contents of a header line.
34837 For example:
34838 .code
34839 headers add "Old-Subject: $h_subject:"
34840 headers remove "Subject"
34841 headers add "Subject: new subject (was: $h_old-subject:)"
34842 headers remove "Old-Subject"
34843 .endd
34844
34845
34846
34847 .section "Setting an errors address in a system filter" "SECID217"
34848 .cindex "envelope from"
34849 .cindex "envelope sender"
34850 In a system filter, if a &%deliver%& command is followed by
34851 .code
34852 errors_to <some address>
34853 .endd
34854 in order to change the envelope sender (and hence the error reporting) for that
34855 delivery, any address may be specified. (In a user filter, only the current
34856 user's address can be set.) For example, if some mail is being monitored, you
34857 might use
34858 .code
34859 unseen deliver monitor@spying.example errors_to root@local.example
34860 .endd
34861 to take a copy which would not be sent back to the normal error reporting
34862 address if its delivery failed.
34863
34864
34865
34866 .section "Per-address filtering" "SECTperaddfil"
34867 .vindex "&$domain$&"
34868 .vindex "&$local_part$&"
34869 In contrast to the system filter, which is run just once per message for each
34870 delivery attempt, it is also possible to set up a system-wide filtering
34871 operation that runs once for each recipient address. In this case, variables
34872 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34873 filter file could be made dependent on them. This is an example of a router
34874 which implements such a filter:
34875 .code
34876 central_filter:
34877   check_local_user
34878   driver = redirect
34879   domains = +local_domains
34880   file = /central/filters/$local_part
34881   no_verify
34882   allow_filter
34883   allow_freeze
34884 .endd
34885 The filter is run in a separate process under its own uid. Therefore, either
34886 &%check_local_user%& must be set (as above), in which case the filter is run as
34887 the local user, or the &%user%& option must be used to specify which user to
34888 use. If both are set, &%user%& overrides.
34889
34890 Care should be taken to ensure that none of the commands in the filter file
34891 specify a significant delivery if the message is to go on to be delivered to
34892 its intended recipient. The router will not then claim to have dealt with the
34893 address, so it will be passed on to subsequent routers to be delivered in the
34894 normal way.
34895 .ecindex IIDsysfil1
34896 .ecindex IIDsysfil2
34897 .ecindex IIDsysfil3
34898
34899
34900
34901
34902
34903
34904 . ////////////////////////////////////////////////////////////////////////////
34905 . ////////////////////////////////////////////////////////////////////////////
34906
34907 .chapter "Message processing" "CHAPmsgproc"
34908 .scindex IIDmesproc "message" "general processing"
34909 Exim performs various transformations on the sender and recipient addresses of
34910 all messages that it handles, and also on the messages' header lines. Some of
34911 these are optional and configurable, while others always take place. All of
34912 this processing, except rewriting as a result of routing, and the addition or
34913 removal of header lines while delivering, happens when a message is received,
34914 before it is placed on Exim's queue.
34915
34916 Some of the automatic processing takes place by default only for
34917 &"locally-originated"& messages. This adjective is used to describe messages
34918 that are not received over TCP/IP, but instead are passed to an Exim process on
34919 its standard input. This includes the interactive &"local SMTP"& case that is
34920 set up by the &%-bs%& command line option.
34921
34922 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34923 or ::1) are not considered to be locally-originated. Exim does not treat the
34924 loopback interface specially in any way.
34925
34926 If you want the loopback interface to be treated specially, you must ensure
34927 that there are appropriate entries in your ACLs.
34928
34929
34930
34931
34932 .section "Submission mode for non-local messages" "SECTsubmodnon"
34933 .cindex "message" "submission"
34934 .cindex "submission mode"
34935 Processing that happens automatically for locally-originated messages (unless
34936 &%suppress_local_fixups%& is set) can also be requested for messages that are
34937 received over TCP/IP. The term &"submission mode"& is used to describe this
34938 state. Submission mode is set by the modifier
34939 .code
34940 control = submission
34941 .endd
34942 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34943 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34944 a local submission, and is normally used when the source of the message is
34945 known to be an MUA running on a client host (as opposed to an MTA). For
34946 example, to set submission mode for messages originating on the IPv4 loopback
34947 interface, you could include the following in the MAIL ACL:
34948 .code
34949 warn  hosts = 127.0.0.1
34950       control = submission
34951 .endd
34952 .cindex "&%sender_retain%& submission option"
34953 There are some options that can be used when setting submission mode. A slash
34954 is used to separate options. For example:
34955 .code
34956 control = submission/sender_retain
34957 .endd
34958 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34959 true and &%local_from_check%& false for the current incoming message. The first
34960 of these allows an existing &'Sender:'& header in the message to remain, and
34961 the second suppresses the check to ensure that &'From:'& matches the
34962 authenticated sender. With this setting, Exim still fixes up messages by adding
34963 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34964 attempt to check sender authenticity in header lines.
34965
34966 When &%sender_retain%& is not set, a submission mode setting may specify a
34967 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34968 example:
34969 .code
34970 control = submission/domain=some.domain
34971 .endd
34972 The domain may be empty. How this value is used is described in sections
34973 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34974 that allows you to specify the user's full name for inclusion in a created
34975 &'Sender:'& or &'From:'& header line. For example:
34976 .code
34977 accept authenticated = *
34978        control = submission/domain=wonderland.example/\
34979                             name=${lookup {$authenticated_id} \
34980                                    lsearch {/etc/exim/namelist}}
34981 .endd
34982 Because the name may contain any characters, including slashes, the &%name%&
34983 option must be given last. The remainder of the string is used as the name. For
34984 the example above, if &_/etc/exim/namelist_& contains:
34985 .code
34986 bigegg:  Humpty Dumpty
34987 .endd
34988 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34989 line would be:
34990 .code
34991 Sender: Humpty Dumpty <bigegg@wonderland.example>
34992 .endd
34993 .cindex "return path" "in submission mode"
34994 By default, submission mode forces the return path to the same address as is
34995 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34996 specified, the return path is also left unchanged.
34997
34998 &*Note*&: The changes caused by submission mode take effect after the predata
34999 ACL. This means that any sender checks performed before the fix-ups use the
35000 untrusted sender address specified by the user, not the trusted sender address
35001 specified by submission mode. Although this might be slightly unexpected, it
35002 does mean that you can configure ACL checks to spot that a user is trying to
35003 spoof another's address.
35004
35005 .section "Line endings" "SECTlineendings"
35006 .cindex "line endings"
35007 .cindex "carriage return"
35008 .cindex "linefeed"
35009 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35010 linefeed) is the line ending for messages transmitted over the Internet using
35011 SMTP over TCP/IP. However, within individual operating systems, different
35012 conventions are used. For example, Unix-like systems use just LF, but others
35013 use CRLF or just CR.
35014
35015 Exim was designed for Unix-like systems, and internally, it stores messages
35016 using the system's convention of a single LF as a line terminator. When
35017 receiving a message, all line endings are translated to this standard format.
35018 Originally, it was thought that programs that passed messages directly to an
35019 MTA within an operating system would use that system's convention. Experience
35020 has shown that this is not the case; for example, there are Unix applications
35021 that use CRLF in this circumstance. For this reason, and for compatibility with
35022 other MTAs, the way Exim handles line endings for all messages is now as
35023 follows:
35024
35025 .ilist
35026 LF not preceded by CR is treated as a line ending.
35027 .next
35028 CR is treated as a line ending; if it is immediately followed by LF, the LF
35029 is ignored.
35030 .next
35031 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35032 nor a local message in the state where a line containing only a dot is a
35033 terminator.
35034 .next
35035 If a bare CR is encountered within a header line, an extra space is added after
35036 the line terminator so as not to end the header line. The reasoning behind this
35037 is that bare CRs in header lines are most likely either to be mistakes, or
35038 people trying to play silly games.
35039 .next
35040 If the first header line received in a message ends with CRLF, a subsequent
35041 bare LF in a header line is treated in the same way as a bare CR in a header
35042 line.
35043 .endlist
35044
35045
35046
35047
35048
35049 .section "Unqualified addresses" "SECID218"
35050 .cindex "unqualified addresses"
35051 .cindex "address" "qualification"
35052 By default, Exim expects every envelope address it receives from an external
35053 host to be fully qualified. Unqualified addresses cause negative responses to
35054 SMTP commands. However, because SMTP is used as a means of transporting
35055 messages from MUAs running on personal workstations, there is sometimes a
35056 requirement to accept unqualified addresses from specific hosts or IP networks.
35057
35058 Exim has two options that separately control which hosts may send unqualified
35059 sender or recipient addresses in SMTP commands, namely
35060 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35061 cases, if an unqualified address is accepted, it is qualified by adding the
35062 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35063
35064 .oindex "&%qualify_domain%&"
35065 .oindex "&%qualify_recipient%&"
35066 Unqualified addresses in header lines are automatically qualified for messages
35067 that are locally originated, unless the &%-bnq%& option is given on the command
35068 line. For messages received over SMTP, unqualified addresses in header lines
35069 are qualified only if unqualified addresses are permitted in SMTP commands. In
35070 other words, such qualification is also controlled by
35071 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35072
35073
35074
35075
35076 .section "The UUCP From line" "SECID219"
35077 .cindex "&""From""& line"
35078 .cindex "UUCP" "&""From""& line"
35079 .cindex "sender" "address"
35080 .oindex "&%uucp_from_pattern%&"
35081 .oindex "&%uucp_from_sender%&"
35082 .cindex "envelope from"
35083 .cindex "envelope sender"
35084 .cindex "Sendmail compatibility" "&""From""& line"
35085 Messages that have come from UUCP (and some other applications) often begin
35086 with a line containing the envelope sender and a timestamp, following the word
35087 &"From"&. Examples of two common formats are:
35088 .code
35089 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35090 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35091 .endd
35092 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35093 Exim recognizes such lines at the start of messages that are submitted to it
35094 via the command line (that is, on the standard input). It does not recognize
35095 such lines in incoming SMTP messages, unless the sending host matches
35096 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35097 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35098 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35099 default value matches the two common cases shown above and puts the address
35100 that follows &"From"& into &$1$&.
35101
35102 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35103 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35104 a trusted user, the message's sender address is constructed by expanding the
35105 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35106 then parsed as an RFC 2822 address. If there is no domain, the local part is
35107 qualified with &%qualify_domain%& unless it is the empty string. However, if
35108 the command line &%-f%& option is used, it overrides the &"From"& line.
35109
35110 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35111 sender address is not changed. This is also the case for incoming SMTP messages
35112 that are permitted to contain &"From"& lines.
35113
35114 Only one &"From"& line is recognized. If there is more than one, the second is
35115 treated as a data line that starts the body of the message, as it is not valid
35116 as a header line. This also happens if a &"From"& line is present in an
35117 incoming SMTP message from a source that is not permitted to send them.
35118
35119
35120
35121 .section "Resent- header lines" "SECID220"
35122 .cindex "&%Resent-%& header lines"
35123 .cindex "header lines" "Resent-"
35124 RFC 2822 makes provision for sets of header lines starting with the string
35125 &`Resent-`& to be added to a message when it is resent by the original
35126 recipient to somebody else. These headers are &'Resent-Date:'&,
35127 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35128 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35129
35130 .blockquote
35131 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35132 processing of replies or other such automatic actions on messages.'&
35133 .endblockquote
35134
35135 This leaves things a bit vague as far as other processing actions such as
35136 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35137 follows:
35138
35139 .ilist
35140 A &'Resent-From:'& line that just contains the login id of the submitting user
35141 is automatically rewritten in the same way as &'From:'& (see below).
35142 .next
35143 If there's a rewriting rule for a particular header line, it is also applied to
35144 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35145 &'From:'& also rewrites &'Resent-From:'&.
35146 .next
35147 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35148 also removed.
35149 .next
35150 For a locally-submitted message,
35151 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35152 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35153 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35154 included in log lines in this case.
35155 .next
35156 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35157 &%Resent-%& header lines are present.
35158 .endlist
35159
35160
35161
35162
35163 .section "The Auto-Submitted: header line" "SECID221"
35164 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35165 includes the header line:
35166 .code
35167 Auto-Submitted: auto-replied
35168 .endd
35169
35170 .section "The Bcc: header line" "SECID222"
35171 .cindex "&'Bcc:'& header line"
35172 If Exim is called with the &%-t%& option, to take recipient addresses from a
35173 message's header, it removes any &'Bcc:'& header line that may exist (after
35174 extracting its addresses). If &%-t%& is not present on the command line, any
35175 existing &'Bcc:'& is not removed.
35176
35177
35178 .section "The Date: header line" "SECID223"
35179 .cindex "&'Date:'& header line"
35180 .cindex "header lines" "Date:"
35181 If a locally-generated or submission-mode message has no &'Date:'& header line,
35182 Exim adds one, using the current date and time, unless the
35183 &%suppress_local_fixups%& control has been specified.
35184
35185 .section "The Delivery-date: header line" "SECID224"
35186 .cindex "&'Delivery-date:'& header line"
35187 .oindex "&%delivery_date_remove%&"
35188 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35189 set. Exim can be configured to add them to the final delivery of messages. (See
35190 the generic &%delivery_date_add%& transport option.) They should not be present
35191 in messages in transit. If the &%delivery_date_remove%& configuration option is
35192 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35193 messages.
35194
35195
35196 .section "The Envelope-to: header line" "SECID225"
35197 .cindex "&'Envelope-to:'& header line"
35198 .cindex "header lines" "Envelope-to:"
35199 .oindex "&%envelope_to_remove%&"
35200 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35201 Exim can be configured to add them to the final delivery of messages. (See the
35202 generic &%envelope_to_add%& transport option.) They should not be present in
35203 messages in transit. If the &%envelope_to_remove%& configuration option is set
35204 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35205 messages.
35206
35207
35208 .section "The From: header line" "SECTthefrohea"
35209 .cindex "&'From:'& header line"
35210 .cindex "header lines" "From:"
35211 .cindex "Sendmail compatibility" "&""From""& line"
35212 .cindex "message" "submission"
35213 .cindex "submission mode"
35214 If a submission-mode message does not contain a &'From:'& header line, Exim
35215 adds one if either of the following conditions is true:
35216
35217 .ilist
35218 The envelope sender address is not empty (that is, this is not a bounce
35219 message). The added header line copies the envelope sender address.
35220 .next
35221 .vindex "&$authenticated_id$&"
35222 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35223 .olist
35224 .vindex "&$qualify_domain$&"
35225 If no domain is specified by the submission control, the local part is
35226 &$authenticated_id$& and the domain is &$qualify_domain$&.
35227 .next
35228 If a non-empty domain is specified by the submission control, the local
35229 part is &$authenticated_id$&, and the domain is the specified domain.
35230 .next
35231 If an empty domain is specified by the submission control,
35232 &$authenticated_id$& is assumed to be the complete address.
35233 .endlist
35234 .endlist
35235
35236 A non-empty envelope sender takes precedence.
35237
35238 If a locally-generated incoming message does not contain a &'From:'& header
35239 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35240 containing the sender's address. The calling user's login name and full name
35241 are used to construct the address, as described in section &<<SECTconstr>>&.
35242 They are obtained from the password data by calling &[getpwuid()]& (but see the
35243 &%unknown_login%& configuration option). The address is qualified with
35244 &%qualify_domain%&.
35245
35246 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35247 &'From:'& header line containing just the unqualified login name of the calling
35248 user, this is replaced by an address containing the user's login name and full
35249 name as described in section &<<SECTconstr>>&.
35250
35251
35252 .section "The Message-ID: header line" "SECID226"
35253 .cindex "&'Message-ID:'& header line"
35254 .cindex "header lines" "Message-ID:"
35255 .cindex "message" "submission"
35256 .oindex "&%message_id_header_text%&"
35257 If a locally-generated or submission-mode incoming message does not contain a
35258 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35259 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35260 to the message. If there are any &'Resent-:'& headers in the message, it
35261 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35262 message id, preceded by the letter E to ensure it starts with a letter, and
35263 followed by @ and the primary host name. Additional information can be included
35264 in this header line by setting the &%message_id_header_text%& and/or
35265 &%message_id_header_domain%& options.
35266
35267
35268 .section "The Received: header line" "SECID227"
35269 .cindex "&'Received:'& header line"
35270 .cindex "header lines" "Received:"
35271 A &'Received:'& header line is added at the start of every message. The
35272 contents are defined by the &%received_header_text%& configuration option, and
35273 Exim automatically adds a semicolon and a timestamp to the configured string.
35274
35275 The &'Received:'& header is generated as soon as the message's header lines
35276 have been received. At this stage, the timestamp in the &'Received:'& header
35277 line is the time that the message started to be received. This is the value
35278 that is seen by the DATA ACL and by the &[local_scan()]& function.
35279
35280 Once a message is accepted, the timestamp in the &'Received:'& header line is
35281 changed to the time of acceptance, which is (apart from a small delay while the
35282 -H spool file is written) the earliest time at which delivery could start.
35283
35284
35285 .section "The References: header line" "SECID228"
35286 .cindex "&'References:'& header line"
35287 .cindex "header lines" "References:"
35288 Messages created by the &(autoreply)& transport include a &'References:'&
35289 header line. This is constructed according to the rules that are described in
35290 section 3.64 of RFC 2822 (which states that replies should contain such a
35291 header line), and section 3.14 of RFC 3834 (which states that automatic
35292 responses are not different in this respect). However, because some mail
35293 processing software does not cope well with very long header lines, no more
35294 than 12 message IDs are copied from the &'References:'& header line in the
35295 incoming message. If there are more than 12, the first one and then the final
35296 11 are copied, before adding the message ID of the incoming message.
35297
35298
35299
35300 .section "The Return-path: header line" "SECID229"
35301 .cindex "&'Return-path:'& header line"
35302 .cindex "header lines" "Return-path:"
35303 .oindex "&%return_path_remove%&"
35304 &'Return-path:'& header lines are defined as something an MTA may insert when
35305 it does the final delivery of messages. (See the generic &%return_path_add%&
35306 transport option.) Therefore, they should not be present in messages in
35307 transit. If the &%return_path_remove%& configuration option is set (the
35308 default), Exim removes &'Return-path:'& header lines from incoming messages.
35309
35310
35311
35312 .section "The Sender: header line" "SECTthesenhea"
35313 .cindex "&'Sender:'& header line"
35314 .cindex "message" "submission"
35315 .cindex "header lines" "Sender:"
35316 For a locally-originated message from an untrusted user, Exim may remove an
35317 existing &'Sender:'& header line, and it may add a new one. You can modify
35318 these actions by setting the &%local_sender_retain%& option true, the
35319 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35320 control setting.
35321
35322 When a local message is received from an untrusted user and
35323 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35324 control has not been set, a check is made to see if the address given in the
35325 &'From:'& header line is the correct (local) sender of the message. The address
35326 that is expected has the login name as the local part and the value of
35327 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35328 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35329 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35330 line is added to the message.
35331
35332 If you set &%local_from_check%& false, this checking does not occur. However,
35333 the removal of an existing &'Sender:'& line still happens, unless you also set
35334 &%local_sender_retain%& to be true. It is not possible to set both of these
35335 options true at the same time.
35336
35337 .cindex "submission mode"
35338 By default, no processing of &'Sender:'& header lines is done for messages
35339 received over TCP/IP or for messages submitted by trusted users. However, when
35340 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35341 not specified on the submission control, the following processing takes place:
35342
35343 .vindex "&$authenticated_id$&"
35344 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35345 authenticated, and &$authenticated_id$& is not empty, a sender address is
35346 created as follows:
35347
35348 .ilist
35349 .vindex "&$qualify_domain$&"
35350 If no domain is specified by the submission control, the local part is
35351 &$authenticated_id$& and the domain is &$qualify_domain$&.
35352 .next
35353 If a non-empty domain is specified by the submission control, the local part
35354 is &$authenticated_id$&, and the domain is the specified domain.
35355 .next
35356 If an empty domain is specified by the submission control,
35357 &$authenticated_id$& is assumed to be the complete address.
35358 .endlist
35359
35360 This address is compared with the address in the &'From:'& header line. If they
35361 are different, a &'Sender:'& header line containing the created address is
35362 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35363 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35364
35365 .cindex "return path" "created from &'Sender:'&"
35366 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35367 the message (the envelope sender address) is changed to be the same address,
35368 except in the case of submission mode when &%sender_retain%& is specified.
35369
35370
35371
35372 .section "Adding and removing header lines in routers and transports" &&&
35373          "SECTheadersaddrem"
35374 .cindex "header lines" "adding; in router or transport"
35375 .cindex "header lines" "removing; in router or transport"
35376 When a message is delivered, the addition and removal of header lines can be
35377 specified in a system filter, or on any of the routers and transports that
35378 process the message. Section &<<SECTaddremheasys>>& contains details about
35379 modifying headers in a system filter. Header lines can also be added in an ACL
35380 as a message is received (see section &<<SECTaddheadacl>>&).
35381
35382 In contrast to what happens in a system filter, header modifications that are
35383 specified on routers and transports apply only to the particular recipient
35384 addresses that are being processed by those routers and transports. These
35385 changes do not actually take place until a copy of the message is being
35386 transported. Therefore, they do not affect the basic set of header lines, and
35387 they do not affect the values of the variables that refer to header lines.
35388
35389 &*Note*&: In particular, this means that any expansions in the configuration of
35390 the transport cannot refer to the modified header lines, because such
35391 expansions all occur before the message is actually transported.
35392
35393 For both routers and transports, the argument of a &%headers_add%&
35394 option must be in the form of one or more RFC 2822 header lines, separated by
35395 newlines (coded as &"\n"&). For example:
35396 .code
35397 headers_add = X-added-header: added by $primary_hostname\n\
35398               X-added-second: another added header line
35399 .endd
35400 Exim does not check the syntax of these added header lines.
35401
35402 Multiple &%headers_add%& options for a single router or transport can be
35403 specified; the values will append to a single list of header lines.
35404 Each header-line is separately expanded.
35405
35406 The argument of a &%headers_remove%& option must consist of a colon-separated
35407 list of header names. This is confusing, because header names themselves are
35408 often terminated by colons. In this case, the colons are the list separators,
35409 not part of the names. For example:
35410 .code
35411 headers_remove = return-receipt-to:acknowledge-to
35412 .endd
35413
35414 Multiple &%headers_remove%& options for a single router or transport can be
35415 specified; the arguments will append to a single header-names list.
35416 Each item is separately expanded.
35417 Note that colons in complex expansions which are used to
35418 form all or part of a &%headers_remove%& list
35419 will act as list separators.
35420
35421 When &%headers_add%& or &%headers_remove%& is specified on a router,
35422 items are expanded at routing time,
35423 and then associated with all addresses that are
35424 accepted by that router, and also with any new addresses that it generates. If
35425 an address passes through several routers as a result of aliasing or
35426 forwarding, the changes are cumulative.
35427
35428 .oindex "&%unseen%&"
35429 However, this does not apply to multiple routers that result from the use of
35430 the &%unseen%& option. Any header modifications that were specified by the
35431 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35432
35433 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35434 settings cannot be delivered together in a batch, so a transport is always
35435 dealing with a set of addresses that have the same header-processing
35436 requirements.
35437
35438 The transport starts by writing the original set of header lines that arrived
35439 with the message, possibly modified by the system filter. As it writes out
35440 these lines, it consults the list of header names that were attached to the
35441 recipient address(es) by &%headers_remove%& options in routers, and it also
35442 consults the transport's own &%headers_remove%& option. Header lines whose
35443 names are on either of these lists are not written out. If there are multiple
35444 instances of any listed header, they are all skipped.
35445
35446 After the remaining original header lines have been written, new header
35447 lines that were specified by routers' &%headers_add%& options are written, in
35448 the order in which they were attached to the address. These are followed by any
35449 header lines specified by the transport's &%headers_add%& option.
35450
35451 This way of handling header line modifications in routers and transports has
35452 the following consequences:
35453
35454 .ilist
35455 The original set of header lines, possibly modified by the system filter,
35456 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35457 to it, at all times.
35458 .next
35459 Header lines that are added by a router's
35460 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35461 expansion syntax in subsequent routers or the transport.
35462 .next
35463 Conversely, header lines that are specified for removal by &%headers_remove%&
35464 in a router remain visible to subsequent routers and the transport.
35465 .next
35466 Headers added to an address by &%headers_add%& in a router cannot be removed by
35467 a later router or by a transport.
35468 .next
35469 An added header can refer to the contents of an original header that is to be
35470 removed, even it has the same name as the added header. For example:
35471 .code
35472 headers_remove = subject
35473 headers_add = Subject: new subject (was: $h_subject:)
35474 .endd
35475 .endlist
35476
35477 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35478 for a &(redirect)& router that has the &%one_time%& option set.
35479
35480
35481
35482
35483
35484 .section "Constructed addresses" "SECTconstr"
35485 .cindex "address" "constructed"
35486 .cindex "constructed address"
35487 When Exim constructs a sender address for a locally-generated message, it uses
35488 the form
35489 .display
35490 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35491 .endd
35492 For example:
35493 .code
35494 Zaphod Beeblebrox <zaphod@end.univ.example>
35495 .endd
35496 The user name is obtained from the &%-F%& command line option if set, or
35497 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35498 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35499 ampersand character, this is replaced by the login name with the first letter
35500 upper cased, as is conventional in a number of operating systems. See the
35501 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35502 The &%unknown_username%& option can be used to specify user names in cases when
35503 there is no password file entry.
35504
35505 .cindex "RFC 2047"
35506 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35507 parts of it if necessary. In addition, if it contains any non-printing
35508 characters, it is encoded as described in RFC 2047, which defines a way of
35509 including non-ASCII characters in header lines. The value of the
35510 &%headers_charset%& option specifies the name of the encoding that is used (the
35511 characters are assumed to be in this encoding). The setting of
35512 &%print_topbitchars%& controls whether characters with the top bit set (that
35513 is, with codes greater than 127) count as printing characters or not.
35514
35515
35516
35517 .section "Case of local parts" "SECID230"
35518 .cindex "case of local parts"
35519 .cindex "local part" "case of"
35520 RFC 2822 states that the case of letters in the local parts of addresses cannot
35521 be assumed to be non-significant. Exim preserves the case of local parts of
35522 addresses, but by default it uses a lower-cased form when it is routing,
35523 because on most Unix systems, usernames are in lower case and case-insensitive
35524 routing is required. However, any particular router can be made to use the
35525 original case for local parts by setting the &%caseful_local_part%& generic
35526 router option.
35527
35528 .cindex "mixed-case login names"
35529 If you must have mixed-case user names on your system, the best way to proceed,
35530 assuming you want case-independent handling of incoming email, is to set up
35531 your first router to convert incoming local parts in your domains to the
35532 correct case by means of a file lookup. For example:
35533 .code
35534 correct_case:
35535   driver = redirect
35536   domains = +local_domains
35537   data = ${lookup{$local_part}cdb\
35538               {/etc/usercased.cdb}{$value}fail}\
35539               @$domain
35540 .endd
35541 For this router, the local part is forced to lower case by the default action
35542 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35543 up a new local part in the correct case. If you then set &%caseful_local_part%&
35544 on any subsequent routers which process your domains, they will operate on
35545 local parts with the correct case in a case-sensitive manner.
35546
35547
35548
35549 .section "Dots in local parts" "SECID231"
35550 .cindex "dot" "in local part"
35551 .cindex "local part" "dots in"
35552 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35553 part may not begin or end with a dot, nor have two consecutive dots in the
35554 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35555 empty components for compatibility.
35556
35557
35558
35559 .section "Rewriting addresses" "SECID232"
35560 .cindex "rewriting" "addresses"
35561 Rewriting of sender and recipient addresses, and addresses in headers, can
35562 happen automatically, or as the result of configuration options, as described
35563 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35564 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35565
35566 Automatic rewriting includes qualification, as mentioned above. The other case
35567 in which it can happen is when an incomplete non-local domain is given. The
35568 routing process may cause this to be expanded into the full domain name. For
35569 example, a header such as
35570 .code
35571 To: hare@teaparty
35572 .endd
35573 might get rewritten as
35574 .code
35575 To: hare@teaparty.wonderland.fict.example
35576 .endd
35577 Rewriting as a result of routing is the one kind of message processing that
35578 does not happen at input time, as it cannot be done until the address has
35579 been routed.
35580
35581 Strictly, one should not do &'any'& deliveries of a message until all its
35582 addresses have been routed, in case any of the headers get changed as a
35583 result of routing. However, doing this in practice would hold up many
35584 deliveries for unreasonable amounts of time, just because one address could not
35585 immediately be routed. Exim therefore does not delay other deliveries when
35586 routing of one or more addresses is deferred.
35587 .ecindex IIDmesproc
35588
35589
35590
35591 . ////////////////////////////////////////////////////////////////////////////
35592 . ////////////////////////////////////////////////////////////////////////////
35593
35594 .chapter "SMTP processing" "CHAPSMTP"
35595 .scindex IIDsmtpproc1 "SMTP" "processing details"
35596 .scindex IIDsmtpproc2 "LMTP" "processing details"
35597 Exim supports a number of different ways of using the SMTP protocol, and its
35598 LMTP variant, which is an interactive protocol for transferring messages into a
35599 closed mail store application. This chapter contains details of how SMTP is
35600 processed. For incoming mail, the following are available:
35601
35602 .ilist
35603 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35604 .next
35605 SMTP over the standard input and output (the &%-bs%& option);
35606 .next
35607 Batched SMTP on the standard input (the &%-bS%& option).
35608 .endlist
35609
35610 For mail delivery, the following are available:
35611
35612 .ilist
35613 SMTP over TCP/IP (the &(smtp)& transport);
35614 .next
35615 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35616 &"lmtp"&);
35617 .next
35618 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35619 transport);
35620 .next
35621 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35622 the &%use_bsmtp%& option set).
35623 .endlist
35624
35625 &'Batched SMTP'& is the name for a process in which batches of messages are
35626 stored in or read from files (or pipes), in a format in which SMTP commands are
35627 used to contain the envelope information.
35628
35629
35630
35631 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35632 .cindex "SMTP" "outgoing over TCP/IP"
35633 .cindex "outgoing SMTP over TCP/IP"
35634 .cindex "LMTP" "over TCP/IP"
35635 .cindex "outgoing LMTP over TCP/IP"
35636 .cindex "EHLO"
35637 .cindex "HELO"
35638 .cindex "SIZE option on MAIL command"
35639 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35640 The &%protocol%& option selects which protocol is to be used, but the actual
35641 processing is the same in both cases.
35642
35643 If, in response to its EHLO command, Exim is told that the SIZE
35644 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35645 command. The value of <&'n'&> is the message size plus the value of the
35646 &%size_addition%& option (default 1024) to allow for additions to the message
35647 such as per-transport header lines, or changes made in a
35648 .cindex "transport" "filter"
35649 .cindex "filter" "transport filter"
35650 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35651 suppressed.
35652
35653 If the remote server advertises support for PIPELINING, Exim uses the
35654 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35655 required for the transaction.
35656
35657 If the remote server advertises support for the STARTTLS command, and Exim
35658 was built to support TLS encryption, it tries to start a TLS session unless the
35659 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35660 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35661 is called for verification.
35662
35663 If the remote server advertises support for the AUTH command, Exim scans
35664 the authenticators configuration for any suitable client settings, as described
35665 in chapter &<<CHAPSMTPAUTH>>&.
35666
35667 .cindex "carriage return"
35668 .cindex "linefeed"
35669 Responses from the remote host are supposed to be terminated by CR followed by
35670 LF. However, there are known to be hosts that do not send CR characters, so in
35671 order to be able to interwork with such hosts, Exim treats LF on its own as a
35672 line terminator.
35673
35674 If a message contains a number of different addresses, all those with the same
35675 characteristics (for example, the same envelope sender) that resolve to the
35676 same set of hosts, in the same order, are sent in a single SMTP transaction,
35677 even if they are for different domains, unless there are more than the setting
35678 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35679 they are split into groups containing no more than &%max_rcpt%&s addresses
35680 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35681 in parallel sessions. The order of hosts with identical MX values is not
35682 significant when checking whether addresses can be batched in this way.
35683
35684 When the &(smtp)& transport suffers a temporary failure that is not
35685 message-related, Exim updates its transport-specific database, which contains
35686 records indexed by host name that remember which messages are waiting for each
35687 particular host. It also updates the retry database with new retry times.
35688
35689 .cindex "hints database" "retry keys"
35690 Exim's retry hints are based on host name plus IP address, so if one address of
35691 a multi-homed host is broken, it will soon be skipped most of the time.
35692 See the next section for more detail about error handling.
35693
35694 .cindex "SMTP" "passed connection"
35695 .cindex "SMTP" "batching over TCP/IP"
35696 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35697 looks in the hints database for the transport to see if there are any queued
35698 messages waiting for the host to which it is connected. If it finds one, it
35699 creates a new Exim process using the &%-MC%& option (which can only be used by
35700 a process running as root or the Exim user) and passes the TCP/IP socket to it
35701 so that it can deliver another message using the same socket. The new process
35702 does only those deliveries that are routed to the connected host, and may in
35703 turn pass the socket on to a third process, and so on.
35704
35705 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35706 limit the number of messages sent down a single TCP/IP connection.
35707
35708 .cindex "asterisk" "after IP address"
35709 The second and subsequent messages delivered down an existing connection are
35710 identified in the main log by the addition of an asterisk after the closing
35711 square bracket of the IP address.
35712
35713
35714
35715
35716 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35717 .cindex "error" "in outgoing SMTP"
35718 .cindex "SMTP" "errors in outgoing"
35719 .cindex "host" "error"
35720 Three different kinds of error are recognized for outgoing SMTP: host errors,
35721 message errors, and recipient errors.
35722
35723 .vlist
35724 .vitem "&*Host errors*&"
35725 A host error is not associated with a particular message or with a
35726 particular recipient of a message. The host errors are:
35727
35728 .ilist
35729 Connection refused or timed out,
35730 .next
35731 Any error response code on connection,
35732 .next
35733 Any error response code to EHLO or HELO,
35734 .next
35735 Loss of connection at any time, except after &"."&,
35736 .next
35737 I/O errors at any time,
35738 .next
35739 Timeouts during the session, other than in response to MAIL, RCPT or
35740 the &"."& at the end of the data.
35741 .endlist ilist
35742
35743 For a host error, a permanent error response on connection, or in response to
35744 EHLO, causes all addresses routed to the host to be failed. Any other host
35745 error causes all addresses to be deferred, and retry data to be created for the
35746 host. It is not tried again, for any message, until its retry time arrives. If
35747 the current set of addresses are not all delivered in this run (to some
35748 alternative host), the message is added to the list of those waiting for this
35749 host, so if it is still undelivered when a subsequent successful delivery is
35750 made to the host, it will be sent down the same SMTP connection.
35751
35752 .vitem "&*Message errors*&"
35753 .cindex "message" "error"
35754 A message error is associated with a particular message when sent to a
35755 particular host, but not with a particular recipient of the message. The
35756 message errors are:
35757
35758 .ilist
35759 Any error response code to MAIL, DATA, or the &"."& that terminates
35760 the data,
35761 .next
35762 Timeout after MAIL,
35763 .next
35764 Timeout or loss of connection after the &"."& that terminates the data. A
35765 timeout after the DATA command itself is treated as a host error, as is loss of
35766 connection at any other time.
35767 .endlist ilist
35768
35769 For a message error, a permanent error response (5&'xx'&) causes all addresses
35770 to be failed, and a delivery error report to be returned to the sender. A
35771 temporary error response (4&'xx'&), or one of the timeouts, causes all
35772 addresses to be deferred. Retry data is not created for the host, but instead,
35773 a retry record for the combination of host plus message id is created. The
35774 message is not added to the list of those waiting for this host. This ensures
35775 that the failing message will not be sent to this host again until the retry
35776 time arrives. However, other messages that are routed to the host are not
35777 affected, so if it is some property of the message that is causing the error,
35778 it will not stop the delivery of other mail.
35779
35780 If the remote host specified support for the SIZE parameter in its response
35781 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35782 over-large message will cause a message error because the error arrives as a
35783 response to MAIL.
35784
35785 .vitem "&*Recipient errors*&"
35786 .cindex "recipient" "error"
35787 A recipient error is associated with a particular recipient of a message. The
35788 recipient errors are:
35789
35790 .ilist
35791 Any error response to RCPT,
35792 .next
35793 Timeout after RCPT.
35794 .endlist
35795
35796 For a recipient error, a permanent error response (5&'xx'&) causes the
35797 recipient address to be failed, and a bounce message to be returned to the
35798 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35799 address to be deferred, and routing retry data to be created for it. This is
35800 used to delay processing of the address in subsequent queue runs, until its
35801 routing retry time arrives. This applies to all messages, but because it
35802 operates only in queue runs, one attempt will be made to deliver a new message
35803 to the failing address before the delay starts to operate. This ensures that,
35804 if the failure is really related to the message rather than the recipient
35805 (&"message too big for this recipient"& is a possible example), other messages
35806 have a chance of getting delivered. If a delivery to the address does succeed,
35807 the retry information gets cleared, so all stuck messages get tried again, and
35808 the retry clock is reset.
35809
35810 The message is not added to the list of those waiting for this host. Use of the
35811 host for other messages is unaffected, and except in the case of a timeout,
35812 other recipients are processed independently, and may be successfully delivered
35813 in the current SMTP session. After a timeout it is of course impossible to
35814 proceed with the session, so all addresses get deferred. However, those other
35815 than the one that failed do not suffer any subsequent retry delays. Therefore,
35816 if one recipient is causing trouble, the others have a chance of getting
35817 through when a subsequent delivery attempt occurs before the failing
35818 recipient's retry time.
35819 .endlist
35820
35821 In all cases, if there are other hosts (or IP addresses) available for the
35822 current set of addresses (for example, from multiple MX records), they are
35823 tried in this run for any undelivered addresses, subject of course to their
35824 own retry data. In other words, recipient error retry data does not take effect
35825 until the next delivery attempt.
35826
35827 Some hosts have been observed to give temporary error responses to every
35828 MAIL command at certain times (&"insufficient space"& has been seen). It
35829 would be nice if such circumstances could be recognized, and defer data for the
35830 host itself created, but this is not possible within the current Exim design.
35831 What actually happens is that retry data for every (host, message) combination
35832 is created.
35833
35834 The reason that timeouts after MAIL and RCPT are treated specially is that
35835 these can sometimes arise as a result of the remote host's verification
35836 procedures. Exim makes this assumption, and treats them as if a temporary error
35837 response had been received. A timeout after &"."& is treated specially because
35838 it is known that some broken implementations fail to recognize the end of the
35839 message if the last character of the last line is a binary zero. Thus, it is
35840 helpful to treat this case as a message error.
35841
35842 Timeouts at other times are treated as host errors, assuming a problem with the
35843 host, or the connection to it. If a timeout after MAIL, RCPT,
35844 or &"."& is really a connection problem, the assumption is that at the next try
35845 the timeout is likely to occur at some other point in the dialogue, causing it
35846 then to be treated as a host error.
35847
35848 There is experimental evidence that some MTAs drop the connection after the
35849 terminating &"."& if they do not like the contents of the message for some
35850 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35851 should be given. That is why Exim treats this case as a message rather than a
35852 host error, in order not to delay other messages to the same host.
35853
35854
35855
35856
35857 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35858 .cindex "SMTP" "incoming over TCP/IP"
35859 .cindex "incoming SMTP over TCP/IP"
35860 .cindex "inetd"
35861 .cindex "daemon"
35862 Incoming SMTP messages can be accepted in one of two ways: by running a
35863 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35864 &_/etc/inetd.conf_& should be like this:
35865 .code
35866 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35867 .endd
35868 Exim distinguishes between this case and the case of a locally running user
35869 agent using the &%-bs%& option by checking whether or not the standard input is
35870 a socket. When it is, either the port must be privileged (less than 1024), or
35871 the caller must be root or the Exim user. If any other user passes a socket
35872 with an unprivileged port number, Exim prints a message on the standard error
35873 stream and exits with an error code.
35874
35875 By default, Exim does not make a log entry when a remote host connects or
35876 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35877 unexpected. It can be made to write such log entries by setting the
35878 &%smtp_connection%& log selector.
35879
35880 .cindex "carriage return"
35881 .cindex "linefeed"
35882 Commands from the remote host are supposed to be terminated by CR followed by
35883 LF. However, there are known to be hosts that do not send CR characters. In
35884 order to be able to interwork with such hosts, Exim treats LF on its own as a
35885 line terminator.
35886 Furthermore, because common code is used for receiving messages from all
35887 sources, a CR on its own is also interpreted as a line terminator. However, the
35888 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35889
35890 .cindex "EHLO" "invalid data"
35891 .cindex "HELO" "invalid data"
35892 One area that sometimes gives rise to problems concerns the EHLO or
35893 HELO commands. Some clients send syntactically invalid versions of these
35894 commands, which Exim rejects by default. (This is nothing to do with verifying
35895 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35896 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35897 match the broken hosts that send invalid commands.
35898
35899 .cindex "SIZE option on MAIL command"
35900 .cindex "MAIL" "SIZE option"
35901 The amount of disk space available is checked whenever SIZE is received on
35902 a MAIL command, independently of whether &%message_size_limit%& or
35903 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35904 false. A temporary error is given if there is not enough space. If
35905 &%check_spool_space%& is set, the check is for that amount of space plus the
35906 value given with SIZE, that is, it checks that the addition of the incoming
35907 message will not reduce the space below the threshold.
35908
35909 When a message is successfully received, Exim includes the local message id in
35910 its response to the final &"."& that terminates the data. If the remote host
35911 logs this text it can help with tracing what has happened to a message.
35912
35913 The Exim daemon can limit the number of simultaneous incoming connections it is
35914 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35915 number of simultaneous incoming connections from a single remote host (see the
35916 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35917 rejected using the SMTP temporary error code 421.
35918
35919 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35920 subprocess has finished, as this can get lost at busy times. Instead, it looks
35921 for completed subprocesses every time it wakes up. Provided there are other
35922 things happening (new incoming calls, starts of queue runs), completed
35923 processes will be noticed and tidied away. On very quiet systems you may
35924 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35925 it will be noticed when the daemon next wakes up.
35926
35927 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35928 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35929 high system load &-- for details see the &%smtp_accept_reserve%&,
35930 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35931 applies in both the daemon and &'inetd'& cases.
35932
35933 Exim normally starts a delivery process for each message received, though this
35934 can be varied by means of the &%-odq%& command line option and the
35935 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35936 number of simultaneously running delivery processes started in this way from
35937 SMTP input can be limited by the &%smtp_accept_queue%& and
35938 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35939 subsequently received messages are just put on the input queue without starting
35940 a delivery process.
35941
35942 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35943 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35944 started up from the &'inetd'& daemon, because in that case each connection is
35945 handled by an entirely independent Exim process. Control by load average is,
35946 however, available with &'inetd'&.
35947
35948 Exim can be configured to verify addresses in incoming SMTP commands as they
35949 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35950 to rewrite addresses at this time &-- before any syntax checking is done. See
35951 section &<<SECTrewriteS>>&.
35952
35953 Exim can also be configured to limit the rate at which a client host submits
35954 MAIL and RCPT commands in a single SMTP session. See the
35955 &%smtp_ratelimit_hosts%& option.
35956
35957
35958
35959 .section "Unrecognized SMTP commands" "SECID234"
35960 .cindex "SMTP" "unrecognized commands"
35961 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35962 commands during a single SMTP connection, it drops the connection after sending
35963 the error response to the last command. The default value for
35964 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35965 abuse that subvert web servers into making connections to SMTP ports; in these
35966 circumstances, a number of non-SMTP lines are sent first.
35967
35968
35969 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35970 .cindex "SMTP" "syntax errors"
35971 .cindex "SMTP" "protocol errors"
35972 A syntax error is detected if an SMTP command is recognized, but there is
35973 something syntactically wrong with its data, for example, a malformed email
35974 address in a RCPT command. Protocol errors include invalid command
35975 sequencing such as RCPT before MAIL. If Exim receives more than
35976 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35977 drops the connection after sending the error response to the last command. The
35978 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35979 broken clients that loop sending bad commands (yes, it has been seen).
35980
35981
35982
35983 .section "Use of non-mail SMTP commands" "SECID236"
35984 .cindex "SMTP" "non-mail commands"
35985 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35986 DATA. Exim counts such commands, and drops the connection if there are too
35987 many of them in a single SMTP session. This action catches some
35988 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35989 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35990 defines what &"too many"& means. Its default value is 10.
35991
35992 When a new message is expected, one occurrence of RSET is not counted. This
35993 allows a client to send one RSET between messages (this is not necessary,
35994 but some clients do it). Exim also allows one uncounted occurrence of HELO
35995 or EHLO, and one occurrence of STARTTLS between messages. After
35996 starting up a TLS session, another EHLO is expected, and so it too is not
35997 counted.
35998
35999 The first occurrence of AUTH in a connection, or immediately following
36000 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36001 RCPT, DATA, and QUIT are counted.
36002
36003 You can control which hosts are subject to the limit set by
36004 &%smtp_accept_max_nonmail%& by setting
36005 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36006 the limit apply to all hosts. This option means that you can exclude any
36007 specific badly-behaved hosts that you have to live with.
36008
36009
36010
36011
36012 .section "The VRFY and EXPN commands" "SECID237"
36013 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36014 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36015 appropriate) in order to decide whether the command should be accepted or not.
36016
36017 .cindex "VRFY" "processing"
36018 When no ACL is defined for VRFY, or if it rejects without
36019 setting an explicit response code, the command is accepted
36020 (with a 252 SMTP response code)
36021 in order to support awkward clients that do a VRFY before every RCPT.
36022 When VRFY is accepted, it runs exactly the same code as when Exim is
36023 called with the &%-bv%& option, and returns 250/451/550
36024 SMTP response codes.
36025
36026 .cindex "EXPN" "processing"
36027 If no ACL for EXPN is defined, the command is rejected.
36028 When EXPN is accepted, a single-level expansion of the address is done.
36029 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36030 than a verification (the &%-bv%& option). If an unqualified local part is given
36031 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36032 of VRFY and EXPN commands are logged on the main and reject logs, and
36033 VRFY verification failures are logged on the main log for consistency with
36034 RCPT failures.
36035
36036
36037
36038 .section "The ETRN command" "SECTETRN"
36039 .cindex "ETRN" "processing"
36040 RFC 1985 describes an SMTP command called ETRN that is designed to
36041 overcome the security problems of the TURN command (which has fallen into
36042 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36043 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36044 should be accepted or not. If no ACL is defined, the command is rejected.
36045
36046 The ETRN command is concerned with &"releasing"& messages that are awaiting
36047 delivery to certain hosts. As Exim does not organize its message queue by host,
36048 the only form of ETRN that is supported by default is the one where the
36049 text starts with the &"#"& prefix, in which case the remainder of the text is
36050 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36051 the &%-R%& option to happen, with the remainder of the ETRN text as its
36052 argument. For example,
36053 .code
36054 ETRN #brigadoon
36055 .endd
36056 runs the command
36057 .code
36058 exim -R brigadoon
36059 .endd
36060 which causes a delivery attempt on all messages with undelivered addresses
36061 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36062 default), Exim prevents the simultaneous execution of more than one queue run
36063 for the same argument string as a result of an ETRN command. This stops
36064 a misbehaving client from starting more than one queue runner at once.
36065
36066 .cindex "hints database" "ETRN serialization"
36067 Exim implements the serialization by means of a hints database in which a
36068 record is written whenever a process is started by ETRN, and deleted when
36069 the process completes. However, Exim does not keep the SMTP session waiting for
36070 the ETRN process to complete. Once ETRN is accepted, the client is sent
36071 a &"success"& return code. Obviously there is scope for hints records to get
36072 left lying around if there is a system or program crash. To guard against this,
36073 Exim ignores any records that are more than six hours old.
36074
36075 .oindex "&%smtp_etrn_command%&"
36076 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36077 used. This specifies a command that is run whenever ETRN is received,
36078 whatever the form of its argument. For
36079 example:
36080 .code
36081 smtp_etrn_command = /etc/etrn_command $domain \
36082                     $sender_host_address
36083 .endd
36084 .vindex "&$domain$&"
36085 The string is split up into arguments which are independently expanded. The
36086 expansion variable &$domain$& is set to the argument of the ETRN command,
36087 and no syntax checking is done on the contents of this argument. Exim does not
36088 wait for the command to complete, so its status code is not checked. Exim runs
36089 under its own uid and gid when receiving incoming SMTP, so it is not possible
36090 for it to change them before running the command.
36091
36092
36093
36094 .section "Incoming local SMTP" "SECID238"
36095 .cindex "SMTP" "local incoming"
36096 Some user agents use SMTP to pass messages to their local MTA using the
36097 standard input and output, as opposed to passing the envelope on the command
36098 line and writing the message to the standard input. This is supported by the
36099 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36100 messages over TCP/IP (including the use of ACLs), except that the envelope
36101 sender given in a MAIL command is ignored unless the caller is trusted. In
36102 an ACL you can detect this form of SMTP input by testing for an empty host
36103 identification. It is common to have this as the first line in the ACL that
36104 runs for RCPT commands:
36105 .code
36106 accept hosts = :
36107 .endd
36108 This accepts SMTP messages from local processes without doing any other tests.
36109
36110
36111
36112 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36113 .cindex "SMTP" "batched outgoing"
36114 .cindex "batched SMTP output"
36115 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36116 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36117 be output in BSMTP format. No SMTP responses are possible for this form of
36118 delivery. All it is doing is using SMTP commands as a way of transmitting the
36119 envelope along with the message.
36120
36121 The message is written to the file or pipe preceded by the SMTP commands
36122 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36123 the message that start with a dot have an extra dot added. The SMTP command
36124 HELO is not normally used. If it is required, the &%message_prefix%& option
36125 can be used to specify it.
36126
36127 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36128 one recipient address at a time by default. However, you can arrange for them
36129 to handle several addresses at once by setting the &%batch_max%& option. When
36130 this is done for BSMTP, messages may contain multiple RCPT commands. See
36131 chapter &<<CHAPbatching>>& for more details.
36132
36133 .vindex "&$host$&"
36134 When one or more addresses are routed to a BSMTP transport by a router that
36135 sets up a host list, the name of the first host on the list is available to the
36136 transport in the variable &$host$&. Here is an example of such a transport and
36137 router:
36138 .code
36139 begin routers
36140 route_append:
36141   driver = manualroute
36142   transport = smtp_appendfile
36143   route_list = domain.example  batch.host.example
36144
36145 begin transports
36146 smtp_appendfile:
36147   driver = appendfile
36148   directory = /var/bsmtp/$host
36149   batch_max = 1000
36150   use_bsmtp
36151   user = exim
36152 .endd
36153 This causes messages addressed to &'domain.example'& to be written in BSMTP
36154 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36155 message (unless there are more than 1000 recipients).
36156
36157
36158
36159 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36160 .cindex "SMTP" "batched incoming"
36161 .cindex "batched SMTP input"
36162 The &%-bS%& command line option causes Exim to accept one or more messages by
36163 reading SMTP on the standard input, but to generate no responses. If the caller
36164 is trusted, the senders in the MAIL commands are believed; otherwise the
36165 sender is always the caller of Exim. Unqualified senders and receivers are not
36166 rejected (there seems little point) but instead just get qualified. HELO
36167 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36168 as NOOP; QUIT quits.
36169
36170 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36171 ACL is run in the same way as for non-SMTP local input.
36172
36173 If an error is detected while reading a message, including a missing &"."& at
36174 the end, Exim gives up immediately. It writes details of the error to the
36175 standard output in a stylized way that the calling program should be able to
36176 make some use of automatically, for example:
36177 .code
36178 554 Unexpected end of file
36179 Transaction started in line 10
36180 Error detected in line 14
36181 .endd
36182 It writes a more verbose version, for human consumption, to the standard error
36183 file, for example:
36184 .code
36185 An error was detected while processing a file of BSMTP input.
36186 The error message was:
36187
36188 501 '>' missing at end of address
36189
36190 The SMTP transaction started in line 10.
36191 The error was detected in line 12.
36192 The SMTP command at fault was:
36193
36194 rcpt to:<malformed@in.com.plete
36195
36196 1 previous message was successfully processed.
36197 The rest of the batch was abandoned.
36198 .endd
36199 The return code from Exim is zero only if there were no errors. It is 1 if some
36200 messages were accepted before an error was detected, and 2 if no messages were
36201 accepted.
36202 .ecindex IIDsmtpproc1
36203 .ecindex IIDsmtpproc2
36204
36205
36206
36207 . ////////////////////////////////////////////////////////////////////////////
36208 . ////////////////////////////////////////////////////////////////////////////
36209
36210 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36211          "Customizing messages"
36212 When a message fails to be delivered, or remains in the queue for more than a
36213 configured amount of time, Exim sends a message to the original sender, or
36214 to an alternative configured address. The text of these messages is built into
36215 the code of Exim, but it is possible to change it, either by adding a single
36216 string, or by replacing each of the paragraphs by text supplied in a file.
36217
36218 The &'From:'& and &'To:'& header lines are automatically generated; you can
36219 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36220 option. Exim also adds the line
36221 .code
36222 Auto-Submitted: auto-generated
36223 .endd
36224 to all warning and bounce messages,
36225
36226
36227 .section "Customizing bounce messages" "SECID239"
36228 .cindex "customizing" "bounce message"
36229 .cindex "bounce message" "customizing"
36230 If &%bounce_message_text%& is set, its contents are included in the default
36231 message immediately after &"This message was created automatically by mail
36232 delivery software."& The string is not expanded. It is not used if
36233 &%bounce_message_file%& is set.
36234
36235 When &%bounce_message_file%& is set, it must point to a template file for
36236 constructing error messages. The file consists of a series of text items,
36237 separated by lines consisting of exactly four asterisks. If the file cannot be
36238 opened, default text is used and a message is written to the main and panic
36239 logs. If any text item in the file is empty, default text is used for that
36240 item.
36241
36242 .vindex "&$bounce_recipient$&"
36243 .vindex "&$bounce_return_size_limit$&"
36244 Each item of text that is read from the file is expanded, and there are two
36245 expansion variables which can be of use here: &$bounce_recipient$& is set to
36246 the recipient of an error message while it is being created, and
36247 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36248 option, rounded to a whole number.
36249
36250 The items must appear in the file in the following order:
36251
36252 .ilist
36253 The first item is included in the headers, and should include at least a
36254 &'Subject:'& header. Exim does not check the syntax of these headers.
36255 .next
36256 The second item forms the start of the error message. After it, Exim lists the
36257 failing addresses with their error messages.
36258 .next
36259 The third item is used to introduce any text from pipe transports that is to be
36260 returned to the sender. It is omitted if there is no such text.
36261 .next
36262 The fourth, fifth and sixth items will be ignored and may be empty.
36263 The fields exist for back-compatibility
36264 .endlist
36265
36266 The default state (&%bounce_message_file%& unset) is equivalent to the
36267 following file, in which the sixth item is empty. The &'Subject:'& and some
36268 other lines have been split in order to fit them on the page:
36269 .code
36270 Subject: Mail delivery failed
36271   ${if eq{$sender_address}{$bounce_recipient}
36272   {: returning message to sender}}
36273 ****
36274 This message was created automatically by mail delivery software.
36275
36276 A message ${if eq{$sender_address}{$bounce_recipient}
36277   {that you sent }{sent by
36278
36279 <$sender_address>
36280
36281 }}could not be delivered to all of its recipients.
36282 This is a permanent error. The following address(es) failed:
36283 ****
36284 The following text was generated during the delivery attempt(s):
36285 ****
36286 ------ This is a copy of the message, including all the headers.
36287   ------
36288 ****
36289 ------ The body of the message is $message_size characters long;
36290   only the first
36291 ------ $bounce_return_size_limit or so are included here.
36292 ****
36293 .endd
36294 .section "Customizing warning messages" "SECTcustwarn"
36295 .cindex "customizing" "warning message"
36296 .cindex "warning of delay" "customizing the message"
36297 The option &%warn_message_file%& can be pointed at a template file for use when
36298 warnings about message delays are created. In this case there are only three
36299 text sections:
36300
36301 .ilist
36302 The first item is included in the headers, and should include at least a
36303 &'Subject:'& header. Exim does not check the syntax of these headers.
36304 .next
36305 The second item forms the start of the warning message. After it, Exim lists
36306 the delayed addresses.
36307 .next
36308 The third item then ends the message.
36309 .endlist
36310
36311 The default state is equivalent to the following file, except that some lines
36312 have been split here, in order to fit them on the page:
36313 .code
36314 Subject: Warning: message $message_exim_id delayed
36315   $warn_message_delay
36316 ****
36317 This message was created automatically by mail delivery software.
36318
36319 A message ${if eq{$sender_address}{$warn_message_recipients}
36320 {that you sent }{sent by
36321
36322 <$sender_address>
36323
36324 }}has not been delivered to all of its recipients after
36325 more than $warn_message_delay in the queue on $primary_hostname.
36326
36327 The message identifier is:     $message_exim_id
36328 The subject of the message is: $h_subject
36329 The date of the message is:    $h_date
36330
36331 The following address(es) have not yet been delivered:
36332 ****
36333 No action is required on your part. Delivery attempts will
36334 continue for some time, and this warning may be repeated at
36335 intervals if the message remains undelivered. Eventually the
36336 mail delivery software will give up, and when that happens,
36337 the message will be returned to you.
36338 .endd
36339 .vindex "&$warn_message_delay$&"
36340 .vindex "&$warn_message_recipients$&"
36341 However, in the default state the subject and date lines are omitted if no
36342 appropriate headers exist. During the expansion of this file,
36343 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36344 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36345 of recipients for the warning message. There may be more than one if there are
36346 multiple addresses with different &%errors_to%& settings on the routers that
36347 handled them.
36348
36349
36350
36351
36352 . ////////////////////////////////////////////////////////////////////////////
36353 . ////////////////////////////////////////////////////////////////////////////
36354
36355 .chapter "Some common configuration settings" "CHAPcomconreq"
36356 This chapter discusses some configuration settings that seem to be fairly
36357 common. More examples and discussion can be found in the Exim book.
36358
36359
36360
36361 .section "Sending mail to a smart host" "SECID240"
36362 .cindex "smart host" "example router"
36363 If you want to send all mail for non-local domains to a &"smart host"&, you
36364 should replace the default &(dnslookup)& router with a router which does the
36365 routing explicitly:
36366 .code
36367 send_to_smart_host:
36368   driver = manualroute
36369   route_list = !+local_domains smart.host.name
36370   transport = remote_smtp
36371 .endd
36372 You can use the smart host's IP address instead of the name if you wish.
36373 If you are using Exim only to submit messages to a smart host, and not for
36374 receiving incoming messages, you can arrange for it to do the submission
36375 synchronously by setting the &%mua_wrapper%& option (see chapter
36376 &<<CHAPnonqueueing>>&).
36377
36378
36379
36380
36381 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36382 .cindex "mailing lists"
36383 Exim can be used to run simple mailing lists, but for large and/or complicated
36384 requirements, the use of additional specialized mailing list software such as
36385 Majordomo or Mailman is recommended.
36386
36387 The &(redirect)& router can be used to handle mailing lists where each list
36388 is maintained in a separate file, which can therefore be managed by an
36389 independent manager. The &%domains%& router option can be used to run these
36390 lists in a separate domain from normal mail. For example:
36391 .code
36392 lists:
36393   driver = redirect
36394   domains = lists.example
36395   file = /usr/lists/$local_part
36396   forbid_pipe
36397   forbid_file
36398   errors_to = $local_part-request@lists.example
36399   no_more
36400 .endd
36401 This router is skipped for domains other than &'lists.example'&. For addresses
36402 in that domain, it looks for a file that matches the local part. If there is no
36403 such file, the router declines, but because &%no_more%& is set, no subsequent
36404 routers are tried, and so the whole delivery fails.
36405
36406 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36407 expanded into a filename or a pipe delivery, which is usually inappropriate in
36408 a mailing list.
36409
36410 .oindex "&%errors_to%&"
36411 The &%errors_to%& option specifies that any delivery errors caused by addresses
36412 taken from a mailing list are to be sent to the given address rather than the
36413 original sender of the message. However, before acting on this, Exim verifies
36414 the error address, and ignores it if verification fails.
36415
36416 For example, using the configuration above, mail sent to
36417 &'dicts@lists.example'& is passed on to those addresses contained in
36418 &_/usr/lists/dicts_&, with error reports directed to
36419 &'dicts-request@lists.example'&, provided that this address can be verified.
36420 There could be a file called &_/usr/lists/dicts-request_& containing
36421 the address(es) of this particular list's manager(s), but other approaches,
36422 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36423 or &%local_part_suffix%& options) to handle addresses of the form
36424 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36425
36426
36427
36428 .section "Syntax errors in mailing lists" "SECID241"
36429 .cindex "mailing lists" "syntax errors in"
36430 If an entry in redirection data contains a syntax error, Exim normally defers
36431 delivery of the original address. That means that a syntax error in a mailing
36432 list holds up all deliveries to the list. This may not be appropriate when a
36433 list is being maintained automatically from data supplied by users, and the
36434 addresses are not rigorously checked.
36435
36436 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36437 entries that fail to parse, noting the incident in the log. If in addition
36438 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36439 whenever a broken address is skipped. It is usually appropriate to set
36440 &%syntax_errors_to%& to the same address as &%errors_to%&.
36441
36442
36443
36444 .section "Re-expansion of mailing lists" "SECID242"
36445 .cindex "mailing lists" "re-expansion of"
36446 Exim remembers every individual address to which a message has been delivered,
36447 in order to avoid duplication, but it normally stores only the original
36448 recipient addresses with a message. If all the deliveries to a mailing list
36449 cannot be done at the first attempt, the mailing list is re-expanded when the
36450 delivery is next tried. This means that alterations to the list are taken into
36451 account at each delivery attempt, so addresses that have been added to
36452 the list since the message arrived will therefore receive a copy of the
36453 message, even though it pre-dates their subscription.
36454
36455 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36456 on the &(redirect)& router. If this is done, any addresses generated by the
36457 router that fail to deliver at the first attempt are added to the message as
36458 &"top level"& addresses, and the parent address that generated them is marked
36459 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36460 subsequent delivery attempts. The disadvantage of this is that if any of the
36461 failing addresses are incorrect, correcting them in the file has no effect on
36462 pre-existing messages.
36463
36464 The original top-level address is remembered with each of the generated
36465 addresses, and is output in any log messages. However, any intermediate parent
36466 addresses are not recorded. This makes a difference to the log only if the
36467 &%all_parents%& selector is set, but for mailing lists there is normally only
36468 one level of expansion anyway.
36469
36470
36471
36472 .section "Closed mailing lists" "SECID243"
36473 .cindex "mailing lists" "closed"
36474 The examples so far have assumed open mailing lists, to which anybody may
36475 send mail. It is also possible to set up closed lists, where mail is accepted
36476 from specified senders only. This is done by making use of the generic
36477 &%senders%& option to restrict the router that handles the list.
36478
36479 The following example uses the same file as a list of recipients and as a list
36480 of permitted senders. It requires three routers:
36481 .code
36482 lists_request:
36483   driver = redirect
36484   domains = lists.example
36485   local_part_suffix = -request
36486   file = /usr/lists/$local_part$local_part_suffix
36487   no_more
36488
36489 lists_post:
36490   driver = redirect
36491   domains = lists.example
36492   senders = ${if exists {/usr/lists/$local_part}\
36493              {lsearch;/usr/lists/$local_part}{*}}
36494   file = /usr/lists/$local_part
36495   forbid_pipe
36496   forbid_file
36497   errors_to = $local_part-request@lists.example
36498   no_more
36499
36500 lists_closed:
36501   driver = redirect
36502   domains = lists.example
36503   allow_fail
36504   data = :fail: $local_part@lists.example is a closed mailing list
36505 .endd
36506 All three routers have the same &%domains%& setting, so for any other domains,
36507 they are all skipped. The first router runs only if the local part ends in
36508 &%-request%&. It handles messages to the list manager(s) by means of an open
36509 mailing list.
36510
36511 The second router runs only if the &%senders%& precondition is satisfied. It
36512 checks for the existence of a list that corresponds to the local part, and then
36513 checks that the sender is on the list by means of a linear search. It is
36514 necessary to check for the existence of the file before trying to search it,
36515 because otherwise Exim thinks there is a configuration error. If the file does
36516 not exist, the expansion of &%senders%& is *, which matches all senders. This
36517 means that the router runs, but because there is no list, declines, and
36518 &%no_more%& ensures that no further routers are run. The address fails with an
36519 &"unrouteable address"& error.
36520
36521 The third router runs only if the second router is skipped, which happens when
36522 a mailing list exists, but the sender is not on it. This router forcibly fails
36523 the address, giving a suitable error message.
36524
36525
36526
36527
36528 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36529 .cindex "VERP"
36530 .cindex "Variable Envelope Return Paths"
36531 .cindex "envelope from"
36532 .cindex "envelope sender"
36533 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36534 are a way of helping mailing list administrators discover which subscription
36535 address is the cause of a particular delivery failure. The idea is to encode
36536 the original recipient address in the outgoing envelope sender address, so that
36537 if the message is forwarded by another host and then subsequently bounces, the
36538 original recipient can be extracted from the recipient address of the bounce.
36539
36540 .oindex &%errors_to%&
36541 .oindex &%return_path%&
36542 Envelope sender addresses can be modified by Exim using two different
36543 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36544 list examples), or the &%return_path%& option on a transport. The second of
36545 these is effective only if the message is successfully delivered to another
36546 host; it is not used for errors detected on the local host (see the description
36547 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36548 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36549 .code
36550 verp_smtp:
36551   driver = smtp
36552   max_rcpt = 1
36553   return_path = \
36554     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36555       {$1-request+$local_part=$domain@your.dom.example}fail}
36556 .endd
36557 This has the effect of rewriting the return path (envelope sender) on outgoing
36558 SMTP messages, if the local part of the original return path ends in
36559 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36560 local part and domain of the recipient into the return path. Suppose, for
36561 example, that a message whose return path has been set to
36562 &'somelist-request@your.dom.example'& is sent to
36563 &'subscriber@other.dom.example'&. In the transport, the return path is
36564 rewritten as
36565 .code
36566 somelist-request+subscriber=other.dom.example@your.dom.example
36567 .endd
36568 .vindex "&$local_part$&"
36569 For this to work, you must tell Exim to send multiple copies of messages that
36570 have more than one recipient, so that each copy has just one recipient. This is
36571 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36572 might be sent to several different recipients in the same domain, in which case
36573 &$local_part$& is not available in the transport, because it is not unique.
36574
36575 Unless your host is doing nothing but mailing list deliveries, you should
36576 probably use a separate transport for the VERP deliveries, so as not to use
36577 extra resources in making one-per-recipient copies for other deliveries. This
36578 can easily be done by expanding the &%transport%& option in the router:
36579 .code
36580 dnslookup:
36581   driver = dnslookup
36582   domains = ! +local_domains
36583   transport = \
36584     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36585       {verp_smtp}{remote_smtp}}
36586   no_more
36587 .endd
36588 If you want to change the return path using &%errors_to%& in a router instead
36589 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36590 routers that handle mailing list addresses. This will ensure that all delivery
36591 errors, including those detected on the local host, are sent to the VERP
36592 address.
36593
36594 On a host that does no local deliveries and has no manual routing, only the
36595 &(dnslookup)& router needs to be changed. A special transport is not needed for
36596 SMTP deliveries. Every mailing list recipient has its own return path value,
36597 and so Exim must hand them to the transport one at a time. Here is an example
36598 of a &(dnslookup)& router that implements VERP:
36599 .code
36600 verp_dnslookup:
36601   driver = dnslookup
36602   domains = ! +local_domains
36603   transport = remote_smtp
36604   errors_to = \
36605     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36606      {$1-request+$local_part=$domain@your.dom.example}fail}
36607   no_more
36608 .endd
36609 Before you start sending out messages with VERPed return paths, you must also
36610 configure Exim to accept the bounce messages that come back to those paths.
36611 Typically this is done by setting a &%local_part_suffix%& option for a
36612 router, and using this to route the messages to wherever you want to handle
36613 them.
36614
36615 The overhead incurred in using VERP depends very much on the size of the
36616 message, the number of recipient addresses that resolve to the same remote
36617 host, and the speed of the connection over which the message is being sent. If
36618 a lot of addresses resolve to the same host and the connection is slow, sending
36619 a separate copy of the message for each address may take substantially longer
36620 than sending a single copy with many recipients (for which VERP cannot be
36621 used).
36622
36623
36624
36625
36626
36627
36628 .section "Virtual domains" "SECTvirtualdomains"
36629 .cindex "virtual domains"
36630 .cindex "domain" "virtual"
36631 The phrase &'virtual domain'& is unfortunately used with two rather different
36632 meanings:
36633
36634 .ilist
36635 A domain for which there are no real mailboxes; all valid local parts are
36636 aliases for other email addresses. Common examples are organizational
36637 top-level domains and &"vanity"& domains.
36638 .next
36639 One of a number of independent domains that are all handled by the same host,
36640 with mailboxes on that host, but where the mailbox owners do not necessarily
36641 have login accounts on that host.
36642 .endlist
36643
36644 The first usage is probably more common, and does seem more &"virtual"& than
36645 the second. This kind of domain can be handled in Exim with a straightforward
36646 aliasing router. One approach is to create a separate alias file for each
36647 virtual domain. Exim can test for the existence of the alias file to determine
36648 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36649 to a router of this form:
36650 .code
36651 virtual:
36652   driver = redirect
36653   domains = dsearch;/etc/mail/virtual
36654   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36655   no_more
36656 .endd
36657 The &%domains%& option specifies that the router is to be skipped, unless there
36658 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36659 domain that is being processed. When the router runs, it looks up the local
36660 part in the file to find a new address (or list of addresses). The &%no_more%&
36661 setting ensures that if the lookup fails (leading to &%data%& being an empty
36662 string), Exim gives up on the address without trying any subsequent routers.
36663
36664 This one router can handle all the virtual domains because the alias filenames
36665 follow a fixed pattern. Permissions can be arranged so that appropriate people
36666 can edit the different alias files. A successful aliasing operation results in
36667 a new envelope recipient address, which is then routed from scratch.
36668
36669 The other kind of &"virtual"& domain can also be handled in a straightforward
36670 way. One approach is to create a file for each domain containing a list of
36671 valid local parts, and use it in a router like this:
36672 .code
36673 my_domains:
36674   driver = accept
36675   domains = dsearch;/etc/mail/domains
36676   local_parts = lsearch;/etc/mail/domains/$domain
36677   transport = my_mailboxes
36678 .endd
36679 The address is accepted if there is a file for the domain, and the local part
36680 can be found in the file. The &%domains%& option is used to check for the
36681 file's existence because &%domains%& is tested before the &%local_parts%&
36682 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36683 because that option is tested after &%local_parts%&. The transport is as
36684 follows:
36685 .code
36686 my_mailboxes:
36687   driver = appendfile
36688   file = /var/mail/$domain/$local_part
36689   user = mail
36690 .endd
36691 This uses a directory of mailboxes for each domain. The &%user%& setting is
36692 required, to specify which uid is to be used for writing to the mailboxes.
36693
36694 The configuration shown here is just one example of how you might support this
36695 requirement. There are many other ways this kind of configuration can be set
36696 up, for example, by using a database instead of separate files to hold all the
36697 information about the domains.
36698
36699
36700
36701 .section "Multiple user mailboxes" "SECTmulbox"
36702 .cindex "multiple mailboxes"
36703 .cindex "mailbox" "multiple"
36704 .cindex "local part" "prefix"
36705 .cindex "local part" "suffix"
36706 Heavy email users often want to operate with multiple mailboxes, into which
36707 incoming mail is automatically sorted. A popular way of handling this is to
36708 allow users to use multiple sender addresses, so that replies can easily be
36709 identified. Users are permitted to add prefixes or suffixes to their local
36710 parts for this purpose. The wildcard facility of the generic router options
36711 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36712 example, consider this router:
36713 .code
36714 userforward:
36715   driver = redirect
36716   check_local_user
36717   file = $home/.forward
36718   local_part_suffix = -*
36719   local_part_suffix_optional
36720   allow_filter
36721 .endd
36722 .vindex "&$local_part_suffix$&"
36723 It runs a user's &_.forward_& file for all local parts of the form
36724 &'username-*'&. Within the filter file the user can distinguish different
36725 cases by testing the variable &$local_part_suffix$&. For example:
36726 .code
36727 if $local_part_suffix contains -special then
36728 save /home/$local_part/Mail/special
36729 endif
36730 .endd
36731 If the filter file does not exist, or does not deal with such addresses, they
36732 fall through to subsequent routers, and, assuming no subsequent use of the
36733 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36734 control over which suffixes are valid.
36735
36736 Alternatively, a suffix can be used to trigger the use of a different
36737 &_.forward_& file &-- which is the way a similar facility is implemented in
36738 another MTA:
36739 .code
36740 userforward:
36741   driver = redirect
36742   check_local_user
36743   file = $home/.forward$local_part_suffix
36744   local_part_suffix = -*
36745   local_part_suffix_optional
36746   allow_filter
36747 .endd
36748 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36749 example, &_.forward-special_& is used. Once again, if the appropriate file
36750 does not exist, or does not deal with the address, it is passed on to
36751 subsequent routers, which could, if required, look for an unqualified
36752 &_.forward_& file to use as a default.
36753
36754
36755
36756 .section "Simplified vacation processing" "SECID244"
36757 .cindex "vacation processing"
36758 The traditional way of running the &'vacation'& program is for a user to set up
36759 a pipe command in a &_.forward_& file
36760 (see section &<<SECTspecitredli>>& for syntax details).
36761 This is prone to error by inexperienced users. There are two features of Exim
36762 that can be used to make this process simpler for users:
36763
36764 .ilist
36765 A local part prefix such as &"vacation-"& can be specified on a router which
36766 can cause the message to be delivered directly to the &'vacation'& program, or
36767 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36768 &_.forward_& file are then much simpler. For example:
36769 .code
36770 spqr, vacation-spqr
36771 .endd
36772 .next
36773 The &%require_files%& generic router option can be used to trigger a
36774 vacation delivery by checking for the existence of a certain file in the
36775 user's home directory. The &%unseen%& generic option should also be used, to
36776 ensure that the original delivery also proceeds. In this case, all the user has
36777 to do is to create a file called, say, &_.vacation_&, containing a vacation
36778 message.
36779 .endlist
36780
36781 Another advantage of both these methods is that they both work even when the
36782 use of arbitrary pipes by users is locked out.
36783
36784
36785
36786 .section "Taking copies of mail" "SECID245"
36787 .cindex "message" "copying every"
36788 Some installations have policies that require archive copies of all messages to
36789 be made. A single copy of each message can easily be taken by an appropriate
36790 command in a system filter, which could, for example, use a different file for
36791 each day's messages.
36792
36793 There is also a shadow transport mechanism that can be used to take copies of
36794 messages that are successfully delivered by local transports, one copy per
36795 delivery. This could be used, &'inter alia'&, to implement automatic
36796 notification of delivery by sites that insist on doing such things.
36797
36798
36799
36800 .section "Intermittently connected hosts" "SECID246"
36801 .cindex "intermittently connected hosts"
36802 It has become quite common (because it is cheaper) for hosts to connect to the
36803 Internet periodically rather than remain connected all the time. The normal
36804 arrangement is that mail for such hosts accumulates on a system that is
36805 permanently connected.
36806
36807 Exim was designed for use on permanently connected hosts, and so it is not
36808 particularly well-suited to use in an intermittently connected environment.
36809 Nevertheless there are some features that can be used.
36810
36811
36812 .section "Exim on the upstream server host" "SECID247"
36813 It is tempting to arrange for incoming mail for the intermittently connected
36814 host to remain in Exim's queue until the client connects. However, this
36815 approach does not scale very well. Two different kinds of waiting message are
36816 being mixed up in the same queue &-- those that cannot be delivered because of
36817 some temporary problem, and those that are waiting for their destination host
36818 to connect. This makes it hard to manage the queue, as well as wasting
36819 resources, because each queue runner scans the entire queue.
36820
36821 A better approach is to separate off those messages that are waiting for an
36822 intermittently connected host. This can be done by delivering these messages
36823 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36824 format, from where they are transmitted by other software when their
36825 destination connects. This makes it easy to collect all the mail for one host
36826 in a single directory, and to apply local timeout rules on a per-message basis
36827 if required.
36828
36829 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36830 you are doing this, you should configure Exim with a long retry period for the
36831 intermittent host. For example:
36832 .code
36833 cheshire.wonderland.fict.example    *   F,5d,24h
36834 .endd
36835 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36836 which messages it has queued up for that host. Once the intermittent host comes
36837 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36838 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36839 causes all the queued up messages to be delivered, often down a single SMTP
36840 connection. While the host remains connected, any new messages get delivered
36841 immediately.
36842
36843 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36844 issued with a different IP address each time it connects, Exim's retry
36845 mechanisms on the holding host get confused, because the IP address is normally
36846 used as part of the key string for holding retry information. This can be
36847 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36848 Since this has disadvantages for permanently connected hosts, it is best to
36849 arrange a separate transport for the intermittently connected ones.
36850
36851
36852
36853 .section "Exim on the intermittently connected client host" "SECID248"
36854 The value of &%smtp_accept_queue_per_connection%& should probably be
36855 increased, or even set to zero (that is, disabled) on the intermittently
36856 connected host, so that all incoming messages down a single connection get
36857 delivered immediately.
36858
36859 .cindex "SMTP" "passed connection"
36860 .cindex "SMTP" "multiple deliveries"
36861 .cindex "multiple SMTP deliveries"
36862 Mail waiting to be sent from an intermittently connected host will probably
36863 not have been routed, because without a connection DNS lookups are not
36864 possible. This means that if a normal queue run is done at connection time,
36865 each message is likely to be sent in a separate SMTP session. This can be
36866 avoided by starting the queue run with a command line option beginning with
36867 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36868 first pass, routing is done but no deliveries take place. The second pass is a
36869 normal queue run; since all the messages have been previously routed, those
36870 destined for the same host are likely to get sent as multiple deliveries in a
36871 single SMTP connection.
36872
36873
36874
36875 . ////////////////////////////////////////////////////////////////////////////
36876 . ////////////////////////////////////////////////////////////////////////////
36877
36878 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36879          "Exim as a non-queueing client"
36880 .cindex "client, non-queueing"
36881 .cindex "smart host" "suppressing queueing"
36882 On a personal computer, it is a common requirement for all
36883 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36884 configured to operate that way, for all the popular operating systems.
36885 However, there are some MUAs for Unix-like systems that cannot be so
36886 configured: they submit messages using the command line interface of
36887 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36888 messages this way.
36889
36890 If the personal computer runs continuously, there is no problem, because it can
36891 run a conventional MTA that handles delivery to the smart host, and deal with
36892 any delays via its queueing mechanism. However, if the computer does not run
36893 continuously or runs different operating systems at different times, queueing
36894 email is not desirable.
36895
36896 There is therefore a requirement for something that can provide the
36897 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36898 any queueing or retrying facilities. Furthermore, the delivery to the smart
36899 host should be synchronous, so that if it fails, the sending MUA is immediately
36900 informed. In other words, we want something that extends an MUA that submits
36901 to a local MTA via the command line so that it behaves like one that submits
36902 to a remote smart host using TCP/SMTP.
36903
36904 There are a number of applications (for example, there is one called &'ssmtp'&)
36905 that do this job. However, people have found them to be lacking in various
36906 ways. For instance, you might want to allow aliasing and forwarding to be done
36907 before sending a message to the smart host.
36908
36909 Exim already had the necessary infrastructure for doing this job. Just a few
36910 tweaks were needed to make it behave as required, though it is somewhat of an
36911 overkill to use a fully-featured MTA for this purpose.
36912
36913 .oindex "&%mua_wrapper%&"
36914 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36915 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36916 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36917 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36918 compatible router and transport configuration. Typically there will be just one
36919 router and one transport, sending everything to a smart host.
36920
36921 When run in MUA wrapping mode, the behaviour of Exim changes in the
36922 following ways:
36923
36924 .ilist
36925 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36926 In other words, the only way to submit messages is via the command line.
36927 .next
36928 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36929 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36930 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36931 does not finish until the delivery attempt is complete. If the delivery is
36932 successful, a zero return code is given.
36933 .next
36934 Address redirection is permitted, but the final routing for all addresses must
36935 be to the same remote transport, and to the same list of hosts. Furthermore,
36936 the return address (envelope sender) must be the same for all recipients, as
36937 must any added or deleted header lines. In other words, it must be possible to
36938 deliver the message in a single SMTP transaction, however many recipients there
36939 are.
36940 .next
36941 If these conditions are not met, or if routing any address results in a
36942 failure or defer status, or if Exim is unable to deliver all the recipients
36943 successfully to one of the smart hosts, delivery of the entire message fails.
36944 .next
36945 Because no queueing is allowed, all failures are treated as permanent; there
36946 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36947 smart host. Furthermore, because only a single yes/no response can be given to
36948 the caller, it is not possible to deliver to some recipients and not others. If
36949 there is an error (temporary or permanent) for any recipient, all are failed.
36950 .next
36951 If more than one smart host is listed, Exim will try another host after a
36952 connection failure or a timeout, in the normal way. However, if this kind of
36953 failure happens for all the hosts, the delivery fails.
36954 .next
36955 When delivery fails, an error message is written to the standard error stream
36956 (as well as to Exim's log), and Exim exits to the caller with a return code
36957 value 1. The message is expunged from Exim's spool files. No bounce messages
36958 are ever generated.
36959 .next
36960 No retry data is maintained, and any retry rules are ignored.
36961 .next
36962 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36963 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36964 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36965 .endlist
36966
36967 The overall effect is that Exim makes a single synchronous attempt to deliver
36968 the message, failing if there is any kind of problem. Because no local
36969 deliveries are done and no daemon can be run, Exim does not need root
36970 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36971 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36972 the advantages and disadvantages of running without root privilege.
36973
36974
36975
36976
36977 . ////////////////////////////////////////////////////////////////////////////
36978 . ////////////////////////////////////////////////////////////////////////////
36979
36980 .chapter "Log files" "CHAPlog"
36981 .scindex IIDloggen "log" "general description"
36982 .cindex "log" "types of"
36983 Exim writes three different logs, referred to as the main log, the reject log,
36984 and the panic log:
36985
36986 .ilist
36987 .cindex "main log"
36988 The main log records the arrival of each message and each delivery in a single
36989 line in each case. The format is as compact as possible, in an attempt to keep
36990 down the size of log files. Two-character flag sequences make it easy to pick
36991 out these lines. A number of other events are recorded in the main log. Some of
36992 them are optional, in which case the &%log_selector%& option controls whether
36993 they are included or not. A Perl script called &'eximstats'&, which does simple
36994 analysis of main log files, is provided in the Exim distribution (see section
36995 &<<SECTmailstat>>&).
36996 .next
36997 .cindex "reject log"
36998 The reject log records information from messages that are rejected as a result
36999 of a configuration option (that is, for policy reasons).
37000 The first line of each rejection is a copy of the line that is also written to
37001 the main log. Then, if the message's header has been read at the time the log
37002 is written, its contents are written to this log. Only the original header
37003 lines are available; header lines added by ACLs are not logged. You can use the
37004 reject log to check that your policy controls are working correctly; on a busy
37005 host this may be easier than scanning the main log for rejection messages. You
37006 can suppress the writing of the reject log by setting &%write_rejectlog%&
37007 false.
37008 .next
37009 .cindex "panic log"
37010 .cindex "system log"
37011 When certain serious errors occur, Exim writes entries to its panic log. If the
37012 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37013 are usually written to the main log as well, but can get lost amid the mass of
37014 other entries. The panic log should be empty under normal circumstances. It is
37015 therefore a good idea to check it (or to have a &'cron'& script check it)
37016 regularly, in order to become aware of any problems. When Exim cannot open its
37017 panic log, it tries as a last resort to write to the system log (syslog). This
37018 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37019 message itself is written at priority LOG_CRIT.
37020 .endlist
37021
37022 Every log line starts with a timestamp, in the format shown in the following
37023 example. Note that many of the examples shown in this chapter are line-wrapped.
37024 In the log file, this would be all on one line:
37025 .code
37026 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37027   by QUIT
37028 .endd
37029 By default, the timestamps are in the local timezone. There are two
37030 ways of changing this:
37031
37032 .ilist
37033 You can set the &%timezone%& option to a different time zone; in particular, if
37034 you set
37035 .code
37036 timezone = UTC
37037 .endd
37038 the timestamps will be in UTC (aka GMT).
37039 .next
37040 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37041 example:
37042 .code
37043 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37044 .endd
37045 .endlist
37046
37047 .cindex "log" "process ids in"
37048 .cindex "pid (process id)" "in log lines"
37049 Exim does not include its process id in log lines by default, but you can
37050 request that it does so by specifying the &`pid`& log selector (see section
37051 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37052 brackets, immediately after the time and date.
37053
37054
37055
37056
37057 .section "Where the logs are written" "SECTwhelogwri"
37058 .cindex "log" "destination"
37059 .cindex "log" "to file"
37060 .cindex "log" "to syslog"
37061 .cindex "syslog"
37062 The logs may be written to local files, or to syslog, or both. However, it
37063 should be noted that many syslog implementations use UDP as a transport, and
37064 are therefore unreliable in the sense that messages are not guaranteed to
37065 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37066 It has also been reported that on large log files (tens of megabytes) you may
37067 need to tweak syslog to prevent it syncing the file with each write &-- on
37068 Linux this has been seen to make syslog take 90% plus of CPU time.
37069
37070 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37071 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37072 configuration. This latter string is expanded, so it can contain, for example,
37073 references to the host name:
37074 .code
37075 log_file_path = /var/log/$primary_hostname/exim_%slog
37076 .endd
37077 It is generally advisable, however, to set the string in &_Local/Makefile_&
37078 rather than at runtime, because then the setting is available right from the
37079 start of Exim's execution. Otherwise, if there's something it wants to log
37080 before it has read the configuration file (for example, an error in the
37081 configuration file) it will not use the path you want, and may not be able to
37082 log at all.
37083
37084 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37085 list, currently limited to at most two items. This is one option where the
37086 facility for changing a list separator may not be used. The list must always be
37087 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37088 otherwise the item must either be an absolute path, containing &`%s`& at the
37089 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37090 implying the use of a default path.
37091
37092 When Exim encounters an empty item in the list, it searches the list defined by
37093 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37094 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37095 mean &"use the path specified at build time"&. It no such item exists, log
37096 files are written in the &_log_& subdirectory of the spool directory. This is
37097 equivalent to the setting:
37098 .code
37099 log_file_path = $spool_directory/log/%slog
37100 .endd
37101 If you do not specify anything at build time or runtime,
37102 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37103 that is where the logs are written.
37104
37105 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37106 are in use &-- see section &<<SECTdatlogfil>>& below.
37107
37108 Here are some examples of possible settings:
37109 .display
37110 &`LOG_FILE_PATH=syslog                    `& syslog only
37111 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37112 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37113 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37114 .endd
37115 If there are more than two paths in the list, the first is used and a panic
37116 error is logged.
37117
37118
37119
37120 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37121 .cindex "log" "cycling local files"
37122 .cindex "cycling logs"
37123 .cindex "&'exicyclog'&"
37124 .cindex "log" "local files; writing to"
37125 Some operating systems provide centralized and standardized methods for cycling
37126 log files. For those that do not, a utility script called &'exicyclog'& is
37127 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37128 main and reject logs each time it is called. The maximum number of old logs to
37129 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37130
37131 An Exim delivery process opens the main log when it first needs to write to it,
37132 and it keeps the file open in case subsequent entries are required &-- for
37133 example, if a number of different deliveries are being done for the same
37134 message. However, remote SMTP deliveries can take a long time, and this means
37135 that the file may be kept open long after it is renamed if &'exicyclog'& or
37136 something similar is being used to rename log files on a regular basis. To
37137 ensure that a switch of log files is noticed as soon as possible, Exim calls
37138 &[stat()]& on the main log's name before reusing an open file, and if the file
37139 does not exist, or its inode has changed, the old file is closed and Exim
37140 tries to open the main log from scratch. Thus, an old log file may remain open
37141 for quite some time, but no Exim processes should write to it once it has been
37142 renamed.
37143
37144
37145
37146 .section "Datestamped log files" "SECTdatlogfil"
37147 .cindex "log" "datestamped files"
37148 Instead of cycling the main and reject log files by renaming them
37149 periodically, some sites like to use files whose names contain a datestamp,
37150 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37151 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37152 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37153 point where the datestamp is required. For example:
37154 .code
37155 log_file_path = /var/spool/exim/log/%slog-%D
37156 log_file_path = /var/log/exim-%s-%D.log
37157 log_file_path = /var/spool/exim/log/%D-%slog
37158 log_file_path = /var/log/exim/%s.%M
37159 .endd
37160 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37161 examples of names generated by the above examples:
37162 .code
37163 /var/spool/exim/log/mainlog-20021225
37164 /var/log/exim-reject-20021225.log
37165 /var/spool/exim/log/20021225-mainlog
37166 /var/log/exim/main.200212
37167 .endd
37168 When this form of log file is specified, Exim automatically switches to new
37169 files at midnight. It does not make any attempt to compress old logs; you
37170 will need to write your own script if you require this. You should not
37171 run &'exicyclog'& with this form of logging.
37172
37173 The location of the panic log is also determined by &%log_file_path%&, but it
37174 is not datestamped, because rotation of the panic log does not make sense.
37175 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37176 the string. In addition, if it immediately follows a slash, a following
37177 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37178 character is removed. Thus, the four examples above would give these panic
37179 log names:
37180 .code
37181 /var/spool/exim/log/paniclog
37182 /var/log/exim-panic.log
37183 /var/spool/exim/log/paniclog
37184 /var/log/exim/panic
37185 .endd
37186
37187
37188 .section "Logging to syslog" "SECID249"
37189 .cindex "log" "syslog; writing to"
37190 The use of syslog does not change what Exim logs or the format of its messages,
37191 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37192 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37193 that, the same strings are written to syslog as to log files. The syslog
37194 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37195 by default, but you can change these by setting the &%syslog_facility%& and
37196 &%syslog_processname%& options, respectively. If Exim was compiled with
37197 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37198 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37199 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37200 the time and host name to each line.
37201 The three log streams are mapped onto syslog priorities as follows:
37202
37203 .ilist
37204 &'mainlog'& is mapped to LOG_INFO
37205 .next
37206 &'rejectlog'& is mapped to LOG_NOTICE
37207 .next
37208 &'paniclog'& is mapped to LOG_ALERT
37209 .endlist
37210
37211 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37212 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37213 these are routed by syslog to the same place. You can suppress this duplication
37214 by setting &%syslog_duplication%& false.
37215
37216 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37217 entries contain multiple lines when headers are included. To cope with both
37218 these cases, entries written to syslog are split into separate &[syslog()]&
37219 calls at each internal newline, and also after a maximum of
37220 870 data characters. (This allows for a total syslog line length of 1024, when
37221 additions such as timestamps are added.) If you are running a syslog
37222 replacement that can handle lines longer than the 1024 characters allowed by
37223 RFC 3164, you should set
37224 .code
37225 SYSLOG_LONG_LINES=yes
37226 .endd
37227 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37228 lines, but it still splits at internal newlines in &'reject'& log entries.
37229
37230 To make it easy to re-assemble split lines later, each component of a split
37231 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37232 where <&'n'&> is the component number and <&'m'&> is the total number of
37233 components in the entry. The / delimiter is used when the line was split
37234 because it was too long; if it was split because of an internal newline, the \
37235 delimiter is used. For example, supposing the length limit to be 50 instead of
37236 870, the following would be the result of a typical rejection message to
37237 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37238 name, and pid as added by syslog:
37239 .code
37240 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37241 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37242 [3/5]  when scanning for sender: missing or malformed lo
37243 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37244 [5/5] mple>)
37245 .endd
37246 The same error might cause the following lines to be written to &"rejectlog"&
37247 (LOG_NOTICE):
37248 .code
37249 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37250 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37251 [3/18] er when scanning for sender: missing or malformed
37252 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37253 [5\18] .example>)
37254 [6\18] Recipients: ph10@some.domain.cam.example
37255 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37256 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37257 [9\18]        id 16RdAL-0006pc-00
37258 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37259 [11\18] 09:43 +0100
37260 [12\18] F From: <>
37261 [13\18]   Subject: this is a test header
37262 [18\18]   X-something: this is another header
37263 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37264 [16\18] le>
37265 [17\18] B Bcc:
37266 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37267 .endd
37268 Log lines that are neither too long nor contain newlines are written to syslog
37269 without modification.
37270
37271 If only syslog is being used, the Exim monitor is unable to provide a log tail
37272 display, unless syslog is routing &'mainlog'& to a file on the local host and
37273 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37274 where it is.
37275
37276
37277
37278 .section "Log line flags" "SECID250"
37279 One line is written to the main log for each message received, and for each
37280 successful, unsuccessful, and delayed delivery. These lines can readily be
37281 picked out by the distinctive two-character flags that immediately follow the
37282 timestamp. The flags are:
37283 .display
37284 &`<=`&     message arrival
37285 &`(=`&     message fakereject
37286 &`=>`&     normal message delivery
37287 &`->`&     additional address in same delivery
37288 &`>>`&     cutthrough message delivery
37289 &`*>`&     delivery suppressed by &%-N%&
37290 &`**`&     delivery failed; address bounced
37291 &`==`&     delivery deferred; temporary problem
37292 .endd
37293
37294
37295 .section "Logging message reception" "SECID251"
37296 .cindex "log" "reception line"
37297 The format of the single-line entry in the main log that is written for every
37298 message received is shown in the basic example below, which is split over
37299 several lines in order to fit it on the page:
37300 .code
37301 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37302   H=mailer.fict.example [192.168.123.123] U=exim
37303   P=smtp S=5678 id=<incoming message id>
37304 .endd
37305 The address immediately following &"<="& is the envelope sender address. A
37306 bounce message is shown with the sender address &"<>"&, and if it is locally
37307 generated, this is followed by an item of the form
37308 .code
37309 R=<message id>
37310 .endd
37311 which is a reference to the message that caused the bounce to be sent.
37312
37313 .cindex "HELO"
37314 .cindex "EHLO"
37315 For messages from other hosts, the H and U fields identify the remote host and
37316 record the RFC 1413 identity of the user that sent the message, if one was
37317 received. The number given in square brackets is the IP address of the sending
37318 host. If there is a single, unparenthesized  host name in the H field, as
37319 above, it has been verified to correspond to the IP address (see the
37320 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37321 by the remote host in the SMTP HELO or EHLO command, and has not been
37322 verified. If verification yields a different name to that given for HELO or
37323 EHLO, the verified name appears first, followed by the HELO or EHLO
37324 name in parentheses.
37325
37326 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37327 without brackets, in the HELO or EHLO command, leading to entries in
37328 the log containing text like these examples:
37329 .code
37330 H=(10.21.32.43) [192.168.8.34]
37331 H=([10.21.32.43]) [192.168.8.34]
37332 .endd
37333 This can be confusing. Only the final address in square brackets can be relied
37334 on.
37335
37336 For locally generated messages (that is, messages not received over TCP/IP),
37337 the H field is omitted, and the U field contains the login name of the caller
37338 of Exim.
37339
37340 .cindex "authentication" "logging"
37341 .cindex "AUTH" "logging"
37342 For all messages, the P field specifies the protocol used to receive the
37343 message. This is the value that is stored in &$received_protocol$&. In the case
37344 of incoming SMTP messages, the value indicates whether or not any SMTP
37345 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37346 session was encrypted, there is an additional X field that records the cipher
37347 suite that was used.
37348
37349 .cindex log protocol
37350 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37351 hosts that have authenticated themselves using the SMTP AUTH command. The first
37352 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37353 there is an additional item A= followed by the name of the authenticator that
37354 was used. If an authenticated identification was set up by the authenticator's
37355 &%server_set_id%& option, this is logged too, separated by a colon from the
37356 authenticator name.
37357
37358 .cindex "size" "of message"
37359 The id field records the existing message id, if present. The size of the
37360 received message is given by the S field. When the message is delivered,
37361 headers may be removed or added, so that the size of delivered copies of the
37362 message may not correspond with this value (and indeed may be different to each
37363 other).
37364
37365 The &%log_selector%& option can be used to request the logging of additional
37366 data when a message is received. See section &<<SECTlogselector>>& below.
37367
37368
37369
37370 .section "Logging deliveries" "SECID252"
37371 .cindex "log" "delivery line"
37372 The format of the single-line entry in the main log that is written for every
37373 delivery is shown in one of the examples below, for local and remote
37374 deliveries, respectively. Each example has been split into multiple lines in order
37375 to fit it on the page:
37376 .code
37377 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37378   <marv@hitch.fict.example> R=localuser T=local_delivery
37379 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37380   monk@holistic.fict.example R=dnslookup T=remote_smtp
37381   H=holistic.fict.example [192.168.234.234]
37382 .endd
37383 For ordinary local deliveries, the original address is given in angle brackets
37384 after the final delivery address, which might be a pipe or a file. If
37385 intermediate address(es) exist between the original and the final address, the
37386 last of these is given in parentheses after the final address. The R and T
37387 fields record the router and transport that were used to process the address.
37388
37389 If SMTP AUTH was used for the delivery there is an additional item A=
37390 followed by the name of the authenticator that was used.
37391 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37392 option, this is logged too, separated by a colon from the authenticator name.
37393
37394 If a shadow transport was run after a successful local delivery, the log line
37395 for the successful delivery has an item added on the end, of the form
37396 .display
37397 &`ST=<`&&'shadow transport name'&&`>`&
37398 .endd
37399 If the shadow transport did not succeed, the error message is put in
37400 parentheses afterwards.
37401
37402 .cindex "asterisk" "after IP address"
37403 When more than one address is included in a single delivery (for example, two
37404 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37405 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37406 down a single SMTP connection, an asterisk follows the IP address in the log
37407 lines for the second and subsequent messages.
37408 When two or more messages are delivered down a single TLS connection, the
37409 DNS and some TLS-related information logged for the first message delivered
37410 will not be present in the log lines for the second and subsequent messages.
37411 TLS cipher information is still available.
37412
37413 .cindex "delivery" "cutthrough; logging"
37414 .cindex "cutthrough" "logging"
37415 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37416 line precedes the reception line, since cutthrough waits for a possible
37417 rejection from the destination in case it can reject the sourced item.
37418
37419 The generation of a reply message by a filter file gets logged as a
37420 &"delivery"& to the addressee, preceded by &">"&.
37421
37422 The &%log_selector%& option can be used to request the logging of additional
37423 data when a message is delivered. See section &<<SECTlogselector>>& below.
37424
37425
37426 .section "Discarded deliveries" "SECID253"
37427 .cindex "discarded messages"
37428 .cindex "message" "discarded"
37429 .cindex "delivery" "discarded; logging"
37430 When a message is discarded as a result of the command &"seen finish"& being
37431 obeyed in a filter file which generates no deliveries, a log entry of the form
37432 .code
37433 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37434   <low.club@bridge.example> R=userforward
37435 .endd
37436 is written, to record why no deliveries are logged. When a message is discarded
37437 because it is aliased to &":blackhole:"& the log line is like this:
37438 .code
37439 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37440   <hole@nowhere.example> R=blackhole_router
37441 .endd
37442
37443
37444 .section "Deferred deliveries" "SECID254"
37445 When a delivery is deferred, a line of the following form is logged:
37446 .code
37447 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37448   R=dnslookup T=smtp defer (146): Connection refused
37449 .endd
37450 In the case of remote deliveries, the error is the one that was given for the
37451 last IP address that was tried. Details of individual SMTP failures are also
37452 written to the log, so the above line would be preceded by something like
37453 .code
37454 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37455   mail1.endrest.example [192.168.239.239]: Connection refused
37456 .endd
37457 When a deferred address is skipped because its retry time has not been reached,
37458 a message is written to the log, but this can be suppressed by setting an
37459 appropriate value in &%log_selector%&.
37460
37461
37462
37463 .section "Delivery failures" "SECID255"
37464 .cindex "delivery" "failure; logging"
37465 If a delivery fails because an address cannot be routed, a line of the
37466 following form is logged:
37467 .code
37468 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37469   <jim@trek99.example>: unknown mail domain
37470 .endd
37471 If a delivery fails at transport time, the router and transport are shown, and
37472 the response from the remote host is included, as in this example:
37473 .code
37474 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37475   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37476   after pipelined RCPT TO:<ace400@pb.example>: host
37477   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37478   <ace400@pb.example>...Addressee unknown
37479 .endd
37480 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37481 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37482 disabling PIPELINING. The log lines for all forms of delivery failure are
37483 flagged with &`**`&.
37484
37485
37486
37487 .section "Fake deliveries" "SECID256"
37488 .cindex "delivery" "fake; logging"
37489 If a delivery does not actually take place because the &%-N%& option has been
37490 used to suppress it, a normal delivery line is written to the log, except that
37491 &"=>"& is replaced by &"*>"&.
37492
37493
37494
37495 .section "Completion" "SECID257"
37496 A line of the form
37497 .code
37498 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37499 .endd
37500 is written to the main log when a message is about to be removed from the spool
37501 at the end of its processing.
37502
37503
37504
37505
37506 .section "Summary of Fields in Log Lines" "SECID258"
37507 .cindex "log" "summary of fields"
37508 A summary of the field identifiers that are used in log lines is shown in
37509 the following table:
37510 .display
37511 &`A   `&        authenticator name (and optional id and sender)
37512 &`C   `&        SMTP confirmation on delivery
37513 &`    `&        command list for &"no mail in SMTP session"&
37514 &`CV  `&        certificate verification status
37515 &`D   `&        duration of &"no mail in SMTP session"&
37516 &`DKIM`&        domain verified in incoming message
37517 &`DN  `&        distinguished name from peer certificate
37518 &`DS  `&        DNSSEC secured lookups
37519 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37520 &`F   `&        sender address (on delivery lines)
37521 &`H   `&        host name and IP address
37522 &`I   `&        local interface used
37523 &`id  `&        message id (from header) for incoming message
37524 &`K   `&        CHUNKING extension used
37525 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37526 &`M8S `&        8BITMIME status for incoming message
37527 &`P   `&        on &`<=`& lines: protocol used
37528 &`    `&        on &`=>`& and &`**`& lines: return path
37529 &`PRDR`&        PRDR extension used
37530 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37531 &`Q   `&        alternate queue name
37532 &`QT  `&        on &`=>`& lines: time spent on queue so far
37533 &`    `&        on &"Completed"& lines: time spent on queue
37534 &`R   `&        on &`<=`& lines: reference for local bounce
37535 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37536 &`RT  `&        on &`<=`& lines: time taken for reception
37537 &`S   `&        size of message in bytes
37538 &`SNI `&        server name indication from TLS client hello
37539 &`ST  `&        shadow transport name
37540 &`T   `&        on &`<=`& lines: message subject (topic)
37541 &`TFO `&        connection took advantage of TCP Fast Open
37542 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37543 &`U   `&        local user or RFC 1413 identity
37544 &`X   `&        TLS cipher suite
37545 .endd
37546
37547
37548 .section "Other log entries" "SECID259"
37549 Various other types of log entry are written from time to time. Most should be
37550 self-explanatory. Among the more common are:
37551
37552 .ilist
37553 .cindex "retry" "time not reached"
37554 &'retry time not reached'&&~&~An address previously suffered a temporary error
37555 during routing or local delivery, and the time to retry has not yet arrived.
37556 This message is not written to an individual message log file unless it happens
37557 during the first delivery attempt.
37558 .next
37559 &'retry time not reached for any host'&&~&~An address previously suffered
37560 temporary errors during remote delivery, and the retry time has not yet arrived
37561 for any of the hosts to which it is routed.
37562 .next
37563 .cindex "spool directory" "file locked"
37564 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37565 some other Exim process is already working on the message. This can be quite
37566 common if queue running processes are started at frequent intervals. The
37567 &'exiwhat'& utility script can be used to find out what Exim processes are
37568 doing.
37569 .next
37570 .cindex "error" "ignored"
37571 &'error ignored'&&~&~There are several circumstances that give rise to this
37572 message:
37573 .olist
37574 Exim failed to deliver a bounce message whose age was greater than
37575 &%ignore_bounce_errors_after%&. The bounce was discarded.
37576 .next
37577 A filter file set up a delivery using the &"noerror"& option, and the delivery
37578 failed. The delivery was discarded.
37579 .next
37580 A delivery set up by a router configured with
37581 . ==== As this is a nested list, any displays it contains must be indented
37582 . ==== as otherwise they are too far to the left.
37583 .code
37584     errors_to = <>
37585 .endd
37586 failed. The delivery was discarded.
37587 .endlist olist
37588 .next
37589 .cindex DKIM "log line"
37590 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37591 logging and the message has a DKIM signature header.
37592 .endlist ilist
37593
37594
37595
37596
37597
37598 .section "Reducing or increasing what is logged" "SECTlogselector"
37599 .cindex "log" "selectors"
37600 By setting the &%log_selector%& global option, you can disable some of Exim's
37601 default logging, or you can request additional logging. The value of
37602 &%log_selector%& is made up of names preceded by plus or minus characters. For
37603 example:
37604 .code
37605 log_selector = +arguments -retry_defer
37606 .endd
37607 The list of optional log items is in the following table, with the default
37608 selection marked by asterisks:
37609 .display
37610 &` 8bitmime                   `&  received 8BITMIME status
37611 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37612 &` address_rewrite            `&  address rewriting
37613 &` all_parents                `&  all parents in => lines
37614 &` arguments                  `&  command line arguments
37615 &`*connection_reject          `&  connection rejections
37616 &`*delay_delivery             `&  immediate delivery delayed
37617 &` deliver_time               `&  time taken to attempt delivery
37618 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37619 &`*dkim                       `&  DKIM verified domain on <= lines
37620 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37621 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37622 &` dnssec                     `&  DNSSEC secured lookups
37623 &`*etrn                       `&  ETRN commands
37624 &`*host_lookup_failed         `&  as it says
37625 &` ident_timeout              `&  timeout for ident connection
37626 &` incoming_interface         `&  local interface on <= and => lines
37627 &` incoming_port              `&  remote port on <= lines
37628 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37629 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37630 &`*msg_id                     `&  on <= lines, Message-ID: header value
37631 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37632 &` outgoing_interface         `&  local interface on => lines
37633 &` outgoing_port              `&  add remote port to => lines
37634 &`*queue_run                  `&  start and end queue runs
37635 &` queue_time                 `&  time on queue for one recipient
37636 &` queue_time_overall         `&  time on queue for whole message
37637 &` pid                        `&  Exim process id
37638 &` pipelining                 `&  PIPELINING use, on <= and => lines
37639 &` proxy                      `&  proxy address on <= and => lines
37640 &` receive_time               `&  time taken to receive message
37641 &` received_recipients        `&  recipients on <= lines
37642 &` received_sender            `&  sender on <= lines
37643 &`*rejected_header            `&  header contents on reject log
37644 &`*retry_defer                `&  &"retry time not reached"&
37645 &` return_path_on_delivery    `&  put return path on => and ** lines
37646 &` sender_on_delivery         `&  add sender to => lines
37647 &`*sender_verify_fail         `&  sender verification failures
37648 &`*size_reject                `&  rejection because too big
37649 &`*skip_delivery              `&  delivery skipped in a queue run
37650 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37651 &` smtp_connection            `&  incoming SMTP connections
37652 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37653 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37654 &` smtp_no_mail               `&  session with no MAIL commands
37655 &` smtp_protocol_error        `&  SMTP protocol errors
37656 &` smtp_syntax_error          `&  SMTP syntax errors
37657 &` subject                    `&  contents of &'Subject:'& on <= lines
37658 &`*tls_certificate_verified   `&  certificate verification status
37659 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37660 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37661 &` tls_sni                    `&  TLS SNI on <= lines
37662 &` unknown_in_list            `&  DNS lookup failed in list match
37663
37664 &` all                        `&  all of the above
37665 .endd
37666 See also the &%slow_lookup_log%& main configuration option,
37667 section &<<SECID99>>&
37668
37669 More details on each of these items follows:
37670
37671 .ilist
37672 .cindex "8BITMIME"
37673 .cindex "log" "8BITMIME"
37674 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37675 which may help in tracking down interoperability issues with ancient MTAs
37676 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37677 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37678 &`7BIT`& and &`8BITMIME`& respectively.
37679 .next
37680 .cindex "&%warn%& ACL verb" "log when skipping"
37681 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37682 its conditions cannot be evaluated, a log line to this effect is written if
37683 this log selector is set.
37684 .next
37685 .cindex "log" "rewriting"
37686 .cindex "rewriting" "logging"
37687 &%address_rewrite%&: This applies both to global rewrites and per-transport
37688 rewrites, but not to rewrites in filters run as an unprivileged user (because
37689 such users cannot access the log).
37690 .next
37691 .cindex "log" "full parentage"
37692 &%all_parents%&: Normally only the original and final addresses are logged on
37693 delivery lines; with this selector, intermediate parents are given in
37694 parentheses between them.
37695 .next
37696 .cindex "log" "Exim arguments"
37697 .cindex "Exim arguments, logging"
37698 &%arguments%&: This causes Exim to write the arguments with which it was called
37699 to the main log, preceded by the current working directory. This is a debugging
37700 feature, added to make it easier to find out how certain MUAs call
37701 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37702 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37703 that are empty or that contain white space are quoted. Non-printing characters
37704 are shown as escape sequences. This facility cannot log unrecognized arguments,
37705 because the arguments are checked before the configuration file is read. The
37706 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37707 between the caller and Exim.
37708 .next
37709 .cindex "log" "connection rejections"
37710 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37711 connection is rejected, for whatever reason.
37712 .next
37713 .cindex "log" "delayed delivery"
37714 .cindex "delayed delivery, logging"
37715 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37716 started for an incoming message because the load is too high or too many
37717 messages were received on one connection. Logging does not occur if no delivery
37718 process is started because &%queue_only%& is set or &%-odq%& was used.
37719 .next
37720 .cindex "log" "delivery duration"
37721 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37722 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37723 If millisecond logging is enabled, short times will be shown with greater
37724 precision, eg. &`DT=0.304s`&.
37725 .next
37726 .cindex "log" "message size on delivery"
37727 .cindex "size" "of message"
37728 &%delivery_size%&: For each delivery, the size of message delivered is added to
37729 the &"=>"& line, tagged with S=.
37730 .next
37731 .cindex log "DKIM verification"
37732 .cindex DKIM "verification logging"
37733 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37734 verifies successfully a tag of DKIM is added, with one of the verified domains.
37735 .next
37736 .cindex log "DKIM verification"
37737 .cindex DKIM "verification logging"
37738 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37739 .next
37740 .cindex "log" "dnslist defer"
37741 .cindex "DNS list" "logging defer"
37742 .cindex "black list (DNS)"
37743 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37744 DNS black list suffers a temporary error.
37745 .next
37746 .cindex log dnssec
37747 .cindex dnssec logging
37748 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37749 dns lookups gave secure results a tag of DS is added.
37750 For acceptance this covers the reverse and forward lookups for host name verification.
37751 It does not cover helo-name verification.
37752 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37753 .next
37754 .cindex "log" "ETRN commands"
37755 .cindex "ETRN" "logging"
37756 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37757 is run to determine whether or not it is actually accepted. An invalid ETRN
37758 command, or one received within a message transaction is not logged by this
37759 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37760 .next
37761 .cindex "log" "host lookup failure"
37762 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37763 any addresses, or when a lookup of an IP address fails to find a host name, a
37764 log line is written. This logging does not apply to direct DNS lookups when
37765 routing email addresses, but it does apply to &"byname"& lookups.
37766 .next
37767 .cindex "log" "ident timeout"
37768 .cindex "RFC 1413" "logging timeout"
37769 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37770 client's ident port times out.
37771 .next
37772 .cindex "log" "incoming interface"
37773 .cindex "log" "local interface"
37774 .cindex "log" "local address and port"
37775 .cindex "TCP/IP" "logging local address and port"
37776 .cindex "interface" "logging"
37777 &%incoming_interface%&: The interface on which a message was received is added
37778 to the &"<="& line as an IP address in square brackets, tagged by I= and
37779 followed by a colon and the port number. The local interface and port are also
37780 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37781 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37782 The latter can be disabled by turning off the &%outgoing_interface%& option.
37783 .next
37784 .cindex log "incoming proxy address"
37785 .cindex proxy "logging proxy address"
37786 .cindex "TCP/IP" "logging proxy address"
37787 &%proxy%&: The internal (closest to the system running Exim) IP address
37788 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37789 on a proxied connection
37790 or the &"=>"& line for a message delivered on a proxied connection.
37791 See &<<SECTproxyInbound>>& for more information.
37792 .next
37793 .cindex "log" "incoming remote port"
37794 .cindex "port" "logging remote"
37795 .cindex "TCP/IP" "logging incoming remote port"
37796 .vindex "&$sender_fullhost$&"
37797 .vindex "&$sender_rcvhost$&"
37798 &%incoming_port%&: The remote port number from which a message was received is
37799 added to log entries and &'Received:'& header lines, following the IP address
37800 in square brackets, and separated from it by a colon. This is implemented by
37801 changing the value that is put in the &$sender_fullhost$& and
37802 &$sender_rcvhost$& variables. Recording the remote port number has become more
37803 important with the widening use of NAT (see RFC 2505).
37804 .next
37805 .cindex "log" "dropped connection"
37806 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37807 connection is unexpectedly dropped.
37808 .next
37809 .cindex "log" "millisecond timestamps"
37810 .cindex millisecond logging
37811 .cindex timestamps "millisecond, in logs"
37812 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37813 appended to the seconds value.
37814 .next
37815 .cindex "log" "message id"
37816 &%msg_id%&: The value of the Message-ID: header.
37817 .next
37818 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37819 This will be either because the message is a bounce, or was submitted locally
37820 (submission mode) without one.
37821 The field identifier will have an asterix appended: &"id*="&.
37822 .next
37823 .cindex "log" "outgoing interface"
37824 .cindex "log" "local interface"
37825 .cindex "log" "local address and port"
37826 .cindex "TCP/IP" "logging local address and port"
37827 .cindex "interface" "logging"
37828 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37829 interface on which a message was sent is added to delivery lines as an I= tag
37830 followed by IP address in square brackets. You can disable this by turning
37831 off the &%outgoing_interface%& option.
37832 .next
37833 .cindex "log" "outgoing remote port"
37834 .cindex "port" "logging outgoing remote"
37835 .cindex "TCP/IP" "logging outgoing remote port"
37836 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37837 containing => tags) following the IP address.
37838 The local port is also added if &%incoming_interface%& and
37839 &%outgoing_interface%& are both enabled.
37840 This option is not included in the default setting, because for most ordinary
37841 configurations, the remote port number is always 25 (the SMTP port), and the
37842 local port is a random ephemeral port.
37843 .next
37844 .cindex "log" "process ids in"
37845 .cindex "pid (process id)" "in log lines"
37846 &%pid%&: The current process id is added to every log line, in square brackets,
37847 immediately after the time and date.
37848 .next
37849 .cindex log pipelining
37850 .cindex pipelining "logging outgoing"
37851 &%pipelining%&: A field is added to delivery and accept
37852 log lines when the ESMTP PIPELINING extension was used.
37853 The field is a single "L".
37854
37855 On accept lines, where PIPELINING was offered but not used by the client,
37856 the field has a minus appended.
37857
37858 .cindex "pipelining" "early connection"
37859 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37860 accept "L" fields have a period appended if the feature was
37861 offered but not used, or an asterisk appended if used.
37862 Delivery "L" fields have an asterisk appended if used.
37863
37864 .next
37865 .cindex "log" "queue run"
37866 .cindex "queue runner" "logging"
37867 &%queue_run%&: The start and end of every queue run are logged.
37868 .next
37869 .cindex "log" "queue time"
37870 &%queue_time%&: The amount of time the message has been in the queue on the
37871 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37872 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37873 includes reception time as well as the delivery time for the current address.
37874 This means that it may be longer than the difference between the arrival and
37875 delivery log line times, because the arrival log line is not written until the
37876 message has been successfully received.
37877 If millisecond logging is enabled, short times will be shown with greater
37878 precision, eg. &`QT=1.578s`&.
37879 .next
37880 &%queue_time_overall%&: The amount of time the message has been in the queue on
37881 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37882 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37883 message, so it includes reception time as well as the total delivery time.
37884 .next
37885 .cindex "log" "receive duration"
37886 &%receive_time%&: For each message, the amount of real time it has taken to
37887 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37888 If millisecond logging is enabled, short times will be shown with greater
37889 precision, eg. &`RT=0.204s`&.
37890 .next
37891 .cindex "log" "recipients"
37892 &%received_recipients%&: The recipients of a message are listed in the main log
37893 as soon as the message is received. The list appears at the end of the log line
37894 that is written when a message is received, preceded by the word &"for"&. The
37895 addresses are listed after they have been qualified, but before any rewriting
37896 has taken place.
37897 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37898 in the list.
37899 .next
37900 .cindex "log" "sender reception"
37901 &%received_sender%&: The unrewritten original sender of a message is added to
37902 the end of the log line that records the message's arrival, after the word
37903 &"from"& (before the recipients if &%received_recipients%& is also set).
37904 .next
37905 .cindex "log" "header lines for rejection"
37906 &%rejected_header%&: If a message's header has been received at the time a
37907 rejection is written to the reject log, the complete header is added to the
37908 log. Header logging can be turned off individually for messages that are
37909 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37910 .next
37911 .cindex "log" "retry defer"
37912 &%retry_defer%&: A log line is written if a delivery is deferred because a
37913 retry time has not yet been reached. However, this &"retry time not reached"&
37914 message is always omitted from individual message logs after the first delivery
37915 attempt.
37916 .next
37917 .cindex "log" "return path"
37918 &%return_path_on_delivery%&: The return path that is being transmitted with
37919 the message is included in delivery and bounce lines, using the tag P=.
37920 This is omitted if no delivery actually happens, for example, if routing fails,
37921 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37922 .next
37923 .cindex "log" "sender on delivery"
37924 &%sender_on_delivery%&: The message's sender address is added to every delivery
37925 and bounce line, tagged by F= (for &"from"&).
37926 This is the original sender that was received with the message; it is not
37927 necessarily the same as the outgoing return path.
37928 .next
37929 .cindex "log" "sender verify failure"
37930 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37931 gives details of a sender verification failure is not written. Log lines for
37932 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37933 detail is lost.
37934 .next
37935 .cindex "log" "size rejection"
37936 &%size_reject%&: A log line is written whenever a message is rejected because
37937 it is too big.
37938 .next
37939 .cindex "log" "frozen messages; skipped"
37940 .cindex "frozen messages" "logging skipping"
37941 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37942 queue run because it is frozen or because another process is already delivering
37943 it.
37944 .cindex "&""spool file is locked""&"
37945 The message that is written is &"spool file is locked"&.
37946 .next
37947 .cindex "log" "smtp confirmation"
37948 .cindex "SMTP" "logging confirmation"
37949 .cindex "LMTP" "logging confirmation"
37950 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37951 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37952 A number of MTAs (including Exim) return an identifying string in this
37953 response.
37954 .next
37955 .cindex "log" "SMTP connections"
37956 .cindex "SMTP" "logging connections"
37957 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37958 established or closed, unless the connection is from a host that matches
37959 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37960 only when the closure is unexpected.) This applies to connections from local
37961 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37962 dropped in the middle of a message, a log line is always written, whether or
37963 not this selector is set, but otherwise nothing is written at the start and end
37964 of connections unless this selector is enabled.
37965
37966 For TCP/IP connections to an Exim daemon, the current number of connections is
37967 included in the log message for each new connection, but note that the count is
37968 reset if the daemon is restarted.
37969 Also, because connections are closed (and the closure is logged) in
37970 subprocesses, the count may not include connections that have been closed but
37971 whose termination the daemon has not yet noticed. Thus, while it is possible to
37972 match up the opening and closing of connections in the log, the value of the
37973 logged counts may not be entirely accurate.
37974 .next
37975 .cindex "log" "SMTP transaction; incomplete"
37976 .cindex "SMTP" "logging incomplete transactions"
37977 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37978 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37979 and the message sender plus any accepted recipients are included in the log
37980 line. This can provide evidence of dictionary attacks.
37981 .next
37982 .cindex "log" "non-MAIL SMTP sessions"
37983 .cindex "MAIL" "logging session without"
37984 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37985 connection terminates without having issued a MAIL command. This includes both
37986 the case when the connection is dropped, and the case when QUIT is used. It
37987 does not include cases where the connection is rejected right at the start (by
37988 an ACL, or because there are too many connections, or whatever). These cases
37989 already have their own log lines.
37990
37991 The log line that is written contains the identity of the client in the usual
37992 way, followed by D= and a time, which records the duration of the connection.
37993 If the connection was authenticated, this fact is logged exactly as it is for
37994 an incoming message, with an A= item. If the connection was encrypted, CV=,
37995 DN=, and X= items may appear as they do for an incoming message, controlled by
37996 the same logging options.
37997
37998 Finally, if any SMTP commands were issued during the connection, a C= item
37999 is added to the line, listing the commands that were used. For example,
38000 .code
38001 C=EHLO,QUIT
38002 .endd
38003 shows that the client issued QUIT straight after EHLO. If there were fewer
38004 than 20 commands, they are all listed. If there were more than 20 commands,
38005 the last 20 are listed, preceded by &"..."&. However, with the default
38006 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38007 have been aborted before 20 non-mail commands are processed.
38008 .next
38009 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38010 colon-separated, is appended to the A= item for a message arrival or delivery
38011 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38012 was accepted or used.
38013 .next
38014 .cindex "log" "SMTP protocol error"
38015 .cindex "SMTP" "logging protocol error"
38016 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38017 encountered. Exim does not have perfect detection of all protocol errors
38018 because of transmission delays and the use of pipelining. If PIPELINING has
38019 been advertised to a client, an Exim server assumes that the client will use
38020 it, and therefore it does not count &"expected"& errors (for example, RCPT
38021 received after rejecting MAIL) as protocol errors.
38022 .next
38023 .cindex "SMTP" "logging syntax errors"
38024 .cindex "SMTP" "syntax errors; logging"
38025 .cindex "SMTP" "unknown command; logging"
38026 .cindex "log" "unknown SMTP command"
38027 .cindex "log" "SMTP syntax error"
38028 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38029 encountered. An unrecognized command is treated as a syntax error. For an
38030 external connection, the host identity is given; for an internal connection
38031 using &%-bs%& the sender identification (normally the calling user) is given.
38032 .next
38033 .cindex "log" "subject"
38034 .cindex "subject, logging"
38035 &%subject%&: The subject of the message is added to the arrival log line,
38036 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38037 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38038 specifies whether characters with values greater than 127 should be logged
38039 unchanged, or whether they should be rendered as escape sequences.
38040 .next
38041 .cindex "log" "certificate verification"
38042 .cindex log DANE
38043 .cindex DANE logging
38044 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38045 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38046 verified
38047 using a CA trust anchor,
38048 &`CA=dane`& if using a DNS trust anchor,
38049 and &`CV=no`& if not.
38050 .next
38051 .cindex "log" "TLS cipher"
38052 .cindex "TLS" "logging cipher"
38053 &%tls_cipher%&: When a message is sent or received over an encrypted
38054 connection, the cipher suite used is added to the log line, preceded by X=.
38055 .next
38056 .cindex "log" "TLS peer DN"
38057 .cindex "TLS" "logging peer DN"
38058 &%tls_peerdn%&: When a message is sent or received over an encrypted
38059 connection, and a certificate is supplied by the remote host, the peer DN is
38060 added to the log line, preceded by DN=.
38061 .next
38062 .cindex "log" "TLS SNI"
38063 .cindex "TLS" "logging SNI"
38064 &%tls_sni%&: When a message is received over an encrypted connection, and
38065 the remote host provided the Server Name Indication extension, the SNI is
38066 added to the log line, preceded by SNI=.
38067 .next
38068 .cindex "log" "DNS failure in list"
38069 &%unknown_in_list%&: This setting causes a log entry to be written when the
38070 result of a list match is failure because a DNS lookup failed.
38071 .endlist
38072
38073
38074 .section "Message log" "SECID260"
38075 .cindex "message" "log file for"
38076 .cindex "log" "message log; description of"
38077 .cindex "&_msglog_& directory"
38078 .oindex "&%preserve_message_logs%&"
38079 In addition to the general log files, Exim writes a log file for each message
38080 that it handles. The names of these per-message logs are the message ids, and
38081 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38082 message log contains copies of the log lines that apply to the message. This
38083 makes it easier to inspect the status of an individual message without having
38084 to search the main log. A message log is deleted when processing of the message
38085 is complete, unless &%preserve_message_logs%& is set, but this should be used
38086 only with great care because they can fill up your disk very quickly.
38087
38088 On a heavily loaded system, it may be desirable to disable the use of
38089 per-message logs, in order to reduce disk I/O. This can be done by setting the
38090 &%message_logs%& option false.
38091 .ecindex IIDloggen
38092
38093
38094
38095
38096 . ////////////////////////////////////////////////////////////////////////////
38097 . ////////////////////////////////////////////////////////////////////////////
38098
38099 .chapter "Exim utilities" "CHAPutils"
38100 .scindex IIDutils "utilities"
38101 A number of utility scripts and programs are supplied with Exim and are
38102 described in this chapter. There is also the Exim Monitor, which is covered in
38103 the next chapter. The utilities described here are:
38104
38105 .itable none 0 0 3  7* left  15* left  40* left
38106 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38107   "list what Exim processes are doing"
38108 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38109 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38110 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38111 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38112                                                 various criteria"
38113 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38114 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38115   "extract statistics from the log"
38116 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38117   "check address acceptance from given IP"
38118 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38119 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38120 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38121 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38122 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38123 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38124 .endtable
38125
38126 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38127 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38128 &url(https://duncanthrax.net/exilog/) for details.
38129
38130
38131
38132
38133 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38134 .cindex "&'exiwhat'&"
38135 .cindex "process, querying"
38136 .cindex "SIGUSR1"
38137 On operating systems that can restart a system call after receiving a signal
38138 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38139 a line describing what it is doing to the file &_exim-process.info_& in the
38140 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38141 processes it can find, having first emptied the file. It then waits for one
38142 second to allow the Exim processes to react before displaying the results. In
38143 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38144 send the signal to the Exim processes, so it is normally run as root.
38145
38146 &*Warning*&: This is not an efficient process. It is intended for occasional
38147 use by system administrators. It is not sensible, for example, to set up a
38148 script that sends SIGUSR1 signals to Exim processes at short intervals.
38149
38150
38151 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38152 varies in different operating systems. Not only are different options used,
38153 but the format of the output is different. For this reason, there are some
38154 system configuration options that configure exactly how &'exiwhat'& works. If
38155 it doesn't seem to be working for you, check the following compile-time
38156 options:
38157 .display
38158 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38159 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38160 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38161 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38162 .endd
38163 An example of typical output from &'exiwhat'& is
38164 .code
38165 164 daemon: -q1h, listening on port 25
38166 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38167 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38168   [10.19.42.42] (editor@ref.example)
38169 10592 handling incoming call from [192.168.243.242]
38170 10628 accepting a local non-SMTP message
38171 .endd
38172 The first number in the output line is the process number. The third line has
38173 been split here, in order to fit it on the page.
38174
38175
38176
38177 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38178 .cindex "&'exiqgrep'&"
38179 .cindex "queue" "grepping"
38180 This utility is a Perl script contributed by Matt Hubbard. It runs
38181 .code
38182 exim -bpu
38183 .endd
38184 or (in case &*-a*& switch is specified)
38185 .code
38186 exim -bp
38187 .endd
38188 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38189 contain alternate exim configuration the queue management might be using.
38190
38191 to obtain a queue listing, and then greps the output to select messages
38192 that match given criteria. The following selection options are available:
38193
38194 .vlist
38195 .vitem &*-f*&&~<&'regex'&>
38196 Match the sender address using a case-insensitive search. The field that is
38197 tested is enclosed in angle brackets, so you can test for bounce messages with
38198 .code
38199 exiqgrep -f '^<>$'
38200 .endd
38201 .vitem &*-r*&&~<&'regex'&>
38202 Match a recipient address using a case-insensitive search. The field that is
38203 tested is not enclosed in angle brackets.
38204
38205 .vitem &*-s*&&~<&'regex'&>
38206 Match against the size field.
38207
38208 .vitem &*-y*&&~<&'seconds'&>
38209 Match messages that are younger than the given time.
38210
38211 .vitem &*-o*&&~<&'seconds'&>
38212 Match messages that are older than the given time.
38213
38214 .vitem &*-z*&
38215 Match only frozen messages.
38216
38217 .vitem &*-x*&
38218 Match only non-frozen messages.
38219
38220 .vitem &*-G*&&~<&'queuename'&>
38221 Match only messages in the given queue.  Without this, the default queue is searched.
38222 .endlist
38223
38224 The following options control the format of the output:
38225
38226 .vlist
38227 .vitem &*-c*&
38228 Display only the count of matching messages.
38229
38230 .vitem &*-l*&
38231 Long format &-- display the full message information as output by Exim. This is
38232 the default.
38233
38234 .vitem &*-i*&
38235 Display message ids only.
38236
38237 .vitem &*-b*&
38238 Brief format &-- one line per message.
38239
38240 .vitem &*-R*&
38241 Display messages in reverse order.
38242
38243 .vitem &*-a*&
38244 Include delivered recipients in queue listing.
38245 .endlist
38246
38247 There is one more option, &%-h%&, which outputs a list of options.
38248
38249
38250
38251 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38252 .cindex "&'exiqsumm'&"
38253 .cindex "queue" "summary"
38254 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38255 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38256 running a command such as
38257 .code
38258 exim -bp | exiqsumm
38259 .endd
38260 The output consists of one line for each domain that has messages waiting for
38261 it, as in the following example:
38262 .code
38263 3   2322   74m   66m  msn.com.example
38264 .endd
38265 Each line lists the number of pending deliveries for a domain, their total
38266 volume, and the length of time that the oldest and the newest messages have
38267 been waiting. Note that the number of pending deliveries is greater than the
38268 number of messages when messages have more than one recipient.
38269
38270 A summary line is output at the end. By default the output is sorted on the
38271 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38272 the output to be sorted by oldest message and by count of messages,
38273 respectively. There are also three options that split the messages for each
38274 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38275 separates frozen messages, and &%-s%& separates messages according to their
38276 sender.
38277
38278 The output of &'exim -bp'& contains the original addresses in the message, so
38279 this also applies to the output from &'exiqsumm'&. No domains from addresses
38280 generated by aliasing or forwarding are included (unless the &%one_time%&
38281 option of the &(redirect)& router has been used to convert them into &"top
38282 level"& addresses).
38283
38284
38285
38286
38287 .section "Extracting specific information from the log (exigrep)" &&&
38288          "SECTextspeinf"
38289 .cindex "&'exigrep'&"
38290 .cindex "log" "extracts; grepping for"
38291 The &'exigrep'& utility is a Perl script that searches one or more main log
38292 files for entries that match a given pattern. When it finds a match, it
38293 extracts all the log entries for the relevant message, not just those that
38294 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38295 given message, or all mail for a given user, or for a given host, for example.
38296 The input files can be in Exim log format or syslog format.
38297 If a matching log line is not associated with a specific message, it is
38298 included in &'exigrep'&'s output without any additional lines. The usage is:
38299 .display
38300 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38301 .endd
38302 If no log filenames are given on the command line, the standard input is read.
38303
38304 The &%-t%& argument specifies a number of seconds. It adds an additional
38305 condition for message selection. Messages that are complete are shown only if
38306 they spent more than <&'n'&> seconds in the queue.
38307
38308 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38309 makes it case-sensitive. This may give a performance improvement when searching
38310 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38311 option; with &%-I%& they do not. In both cases it is possible to change the
38312 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38313
38314 The &%-l%& option means &"literal"&, that is, treat all characters in the
38315 pattern as standing for themselves. Otherwise the pattern must be a Perl
38316 regular expression.
38317
38318 The &%-v%& option inverts the matching condition. That is, a line is selected
38319 if it does &'not'& match the pattern.
38320
38321 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38322 that are generated as a result/response to a message that &'exigrep'& matched
38323 normally.
38324
38325 Example of &%-M%&:
38326 user_a sends a message to user_b, which generates a bounce back to user_b. If
38327 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38328 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38329 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38330 when searching for &"user_a"& will show both messages since the bounce is
38331 &"related"& to or a &"result"& of the first message that was found by the
38332 search term.
38333
38334 If the location of a &'zcat'& command is known from the definition of
38335 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38336 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38337 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38338 autodetection of some well known compression extensions.
38339
38340
38341 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38342 .cindex "&'exipick'&"
38343 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38344 lists messages from the queue according to a variety of criteria. For details
38345 of &'exipick'&'s facilities, run &'exipick'& with
38346 the &%--help%& option.
38347
38348
38349 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38350 .cindex "log" "cycling local files"
38351 .cindex "cycling logs"
38352 .cindex "&'exicyclog'&"
38353 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38354 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38355 you are using log files with datestamps in their names (see section
38356 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38357 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38358 There are two command line options for &'exicyclog'&:
38359 .ilist
38360 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38361 default that is set when Exim is built. The default default is 10.
38362 .next
38363 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38364 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38365 overriding the script's default, which is to find the setting from Exim's
38366 configuration.
38367 .endlist
38368
38369 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38370 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38371 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38372 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38373 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38374 logs are handled similarly.
38375
38376 If the limit is greater than 99, the script uses 3-digit numbers such as
38377 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38378 to one that is greater, or &'vice versa'&, you will have to fix the names of
38379 any existing log files.
38380
38381 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38382 the end are deleted. All files with numbers greater than 01 are compressed,
38383 using a compression command which is configured by the COMPRESS_COMMAND
38384 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38385 root &%crontab%& entry of the form
38386 .code
38387 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38388 .endd
38389 assuming you have used the name &"exim"& for the Exim user. You can run
38390 &'exicyclog'& as root if you wish, but there is no need.
38391
38392
38393
38394 .section "Mail statistics (eximstats)" "SECTmailstat"
38395 .cindex "statistics"
38396 .cindex "&'eximstats'&"
38397 A Perl script called &'eximstats'& is provided for extracting statistical
38398 information from log files. The output is either plain text, or HTML.
38399 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38400 . --- 404 error and everything else points to that.
38401
38402 The &'eximstats'& script has been hacked about quite a bit over time. The
38403 latest version is the result of some extensive revision by Steve Campbell. A
38404 lot of information is given by default, but there are options for suppressing
38405 various parts of it. Following any options, the arguments to the script are a
38406 list of files, which should be main log files. For example:
38407 .code
38408 eximstats -nr /var/spool/exim/log/mainlog.01
38409 .endd
38410 By default, &'eximstats'& extracts information about the number and volume of
38411 messages received from or delivered to various hosts. The information is sorted
38412 both by message count and by volume, and the top fifty hosts in each category
38413 are listed on the standard output. Similar information, based on email
38414 addresses or domains instead of hosts can be requested by means of various
38415 options. For messages delivered and received locally, similar statistics are
38416 also produced per user.
38417
38418 The output also includes total counts and statistics about delivery errors, and
38419 histograms showing the number of messages received and deliveries made in each
38420 hour of the day. A delivery with more than one address in its envelope (for
38421 example, an SMTP transaction with more than one RCPT command) is counted
38422 as a single delivery by &'eximstats'&.
38423
38424 Though normally more deliveries than receipts are reported (as messages may
38425 have multiple recipients), it is possible for &'eximstats'& to report more
38426 messages received than delivered, even though the queue is empty at the start
38427 and end of the period in question. If an incoming message contains no valid
38428 recipients, no deliveries are recorded for it. A bounce message is handled as
38429 an entirely separate message.
38430
38431 &'eximstats'& always outputs a grand total summary giving the volume and number
38432 of messages received and deliveries made, and the number of hosts involved in
38433 each case. It also outputs the number of messages that were delayed (that is,
38434 not completely delivered at the first attempt), and the number that had at
38435 least one address that failed.
38436
38437 The remainder of the output is in sections that can be independently disabled
38438 or modified by various options. It consists of a summary of deliveries by
38439 transport, histograms of messages received and delivered per time interval
38440 (default per hour), information about the time messages spent in the queue,
38441 a list of relayed messages, lists of the top fifty sending hosts, local
38442 senders, destination hosts, and destination local users by count and by volume,
38443 and a list of delivery errors that occurred.
38444
38445 The relay information lists messages that were actually relayed, that is, they
38446 came from a remote host and were directly delivered to some other remote host,
38447 without being processed (for example, for aliasing or forwarding) locally.
38448
38449 There are quite a few options for &'eximstats'& to control exactly what it
38450 outputs. These are documented in the Perl script itself, and can be extracted
38451 by running the command &(perldoc)& on the script. For example:
38452 .code
38453 perldoc /usr/exim/bin/eximstats
38454 .endd
38455
38456 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38457 .cindex "&'exim_checkaccess'&"
38458 .cindex "policy control" "checking access"
38459 .cindex "checking access"
38460 The &%-bh%& command line argument allows you to run a fake SMTP session with
38461 debugging output, in order to check what Exim is doing when it is applying
38462 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38463 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38464 sometimes you just want to answer the question &"Does this address have
38465 access?"& without bothering with any further details.
38466
38467 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38468 two arguments, an IP address and an email address:
38469 .code
38470 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38471 .endd
38472 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38473 given email address would be accepted in a RCPT command in a TCP/IP
38474 connection from the host with the given IP address. The output of the utility
38475 is either the word &"accepted"&, or the SMTP error response, for example:
38476 .code
38477 Rejected:
38478 550 Relay not permitted
38479 .endd
38480 When running this test, the utility uses &`<>`& as the envelope sender address
38481 for the MAIL command, but you can change this by providing additional
38482 options. These are passed directly to the Exim command. For example, to specify
38483 that the test is to be run with the sender address &'himself@there.example'&
38484 you can use:
38485 .code
38486 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38487                  -f himself@there.example
38488 .endd
38489 Note that these additional Exim command line items must be given after the two
38490 mandatory arguments.
38491
38492 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38493 while running its checks. You can run checks that include callouts by using
38494 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38495
38496
38497
38498 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38499 .cindex "DBM" "building dbm files"
38500 .cindex "building DBM files"
38501 .cindex "&'exim_dbmbuild'&"
38502 .cindex "lower casing"
38503 .cindex "binary zero" "in lookup key"
38504 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38505 the format used by the &(lsearch)& lookup (see section
38506 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38507 names as keys and the remainder of the information as data. The lower-casing
38508 can be prevented by calling the program with the &%-nolc%& option.
38509
38510 A terminating zero is included as part of the key string. This is expected by
38511 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38512 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38513 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38514 files.
38515
38516 The program requires two arguments: the name of the input file (which can be a
38517 single hyphen to indicate the standard input), and the name of the output file.
38518 It creates the output under a temporary name, and then renames it if all went
38519 well.
38520
38521 .cindex "USE_DB"
38522 If the native DB interface is in use (USE_DB is set in a compile-time
38523 configuration file &-- this is common in free versions of Unix) the two
38524 filenames must be different, because in this mode the Berkeley DB functions
38525 create a single output file using exactly the name given. For example,
38526 .code
38527 exim_dbmbuild /etc/aliases /etc/aliases.db
38528 .endd
38529 reads the system alias file and creates a DBM version of it in
38530 &_/etc/aliases.db_&.
38531
38532 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38533 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38534 environment, the suffixes are added to the second argument of
38535 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38536 when the Berkeley functions are used in compatibility mode (though this is not
38537 recommended), because in that case it adds a &_.db_& suffix to the filename.
38538
38539 If a duplicate key is encountered, the program outputs a warning, and when it
38540 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38541 option is used. By default, only the first of a set of duplicates is used &--
38542 this makes it compatible with &(lsearch)& lookups. There is an option
38543 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38544 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38545 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38546 return code is 2.
38547
38548
38549
38550
38551 .section "Finding individual retry times (exinext)" "SECTfinindret"
38552 .cindex "retry" "times"
38553 .cindex "&'exinext'&"
38554 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38555 fish specific information out of the retry database. Given a mail domain (or a
38556 complete address), it looks up the hosts for that domain, and outputs any retry
38557 information for the hosts or for the domain. At present, the retry information
38558 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38559 output. For example:
38560 .code
38561 $ exinext piglet@milne.fict.example
38562 kanga.milne.example:192.168.8.1 error 146: Connection refused
38563   first failed: 21-Feb-1996 14:57:34
38564   last tried:   21-Feb-1996 14:57:34
38565   next try at:  21-Feb-1996 15:02:34
38566 roo.milne.example:192.168.8.3 error 146: Connection refused
38567   first failed: 20-Jan-1996 13:12:08
38568   last tried:   21-Feb-1996 11:42:03
38569   next try at:  21-Feb-1996 19:42:03
38570   past final cutoff time
38571 .endd
38572 You can also give &'exinext'& a local part, without a domain, and it
38573 will give any retry information for that local part in your default domain.
38574 A message id can be used to obtain retry information pertaining to a specific
38575 message. This exists only when an attempt to deliver a message to a remote host
38576 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38577 &'exinext'& is not particularly efficient, but then it is not expected to be
38578 run very often.
38579
38580 The &'exinext'& utility calls Exim to find out information such as the location
38581 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38582 passed on to the &'exim'& commands. The first specifies an alternate Exim
38583 configuration file, and the second sets macros for use within the configuration
38584 file. These features are mainly to help in testing, but might also be useful in
38585 environments where more than one configuration file is in use.
38586
38587
38588
38589 .section "Hints database maintenance" "SECThindatmai"
38590 .cindex "hints database" "maintenance"
38591 .cindex "maintaining Exim's hints database"
38592 Three utility programs are provided for maintaining the DBM files that Exim
38593 uses to contain its delivery hint information. Each program requires two
38594 arguments. The first specifies the name of Exim's spool directory, and the
38595 second is the name of the database it is to operate on. These are as follows:
38596
38597 .ilist
38598 &'retry'&: the database of retry information
38599 .next
38600 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38601 for remote hosts
38602 .next
38603 &'callout'&: the callout cache
38604 .next
38605 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38606 .next
38607 &'misc'&: other hints data
38608 .endlist
38609
38610 The &'misc'& database is used for
38611
38612 .ilist
38613 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38614 .next
38615 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38616 &(smtp)& transport)
38617 .next
38618 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38619 in a transport)
38620 .endlist
38621
38622
38623
38624 .section "exim_dumpdb" "SECID261"
38625 .cindex "&'exim_dumpdb'&"
38626 The entire contents of a database are written to the standard output by the
38627 &'exim_dumpdb'& program, which has no options or arguments other than the
38628 spool and database names. For example, to dump the retry database:
38629 .code
38630 exim_dumpdb /var/spool/exim retry
38631 .endd
38632 Two lines of output are produced for each entry:
38633 .code
38634 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38635 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38636 .endd
38637 The first item on the first line is the key of the record. It starts with one
38638 of the letters R, or T, depending on whether it refers to a routing or
38639 transport retry. For a local delivery, the next part is the local address; for
38640 a remote delivery it is the name of the remote host, followed by its failing IP
38641 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38642 transport). If the remote port is not the standard one (port 25), it is added
38643 to the IP address. Then there follows an error code, an additional error code,
38644 and a textual description of the error.
38645
38646 The three times on the second line are the time of first failure, the time of
38647 the last delivery attempt, and the computed time for the next attempt. The line
38648 ends with an asterisk if the cutoff time for the last retry rule has been
38649 exceeded.
38650
38651 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38652 consists of a host name followed by a list of ids for messages that are or were
38653 waiting to be delivered to that host. If there are a very large number for any
38654 one host, continuation records, with a sequence number added to the host name,
38655 may be seen. The data in these records is often out of date, because a message
38656 may be routed to several alternative hosts, and Exim makes no effort to keep
38657 cross-references.
38658
38659
38660
38661 .section "exim_tidydb" "SECID262"
38662 .cindex "&'exim_tidydb'&"
38663 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38664 database. If run with no options, it removes all records that are more than 30
38665 days old. The age is calculated from the date and time that the record was last
38666 updated. Note that, in the case of the retry database, it is &'not'& the time
38667 since the first delivery failure. Information about a host that has been down
38668 for more than 30 days will remain in the database, provided that the record is
38669 updated sufficiently often.
38670
38671 The cutoff date can be altered by means of the &%-t%& option, which must be
38672 followed by a time. For example, to remove all records older than a week from
38673 the retry database:
38674 .code
38675 exim_tidydb -t 7d /var/spool/exim retry
38676 .endd
38677 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38678 message ids. In the former these appear as data in records keyed by host &--
38679 they were messages that were waiting for that host &-- and in the latter they
38680 are the keys for retry information for messages that have suffered certain
38681 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38682 message ids in database records are those of messages that are still on the
38683 queue. Message ids for messages that no longer exist are removed from
38684 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38685 For the &'retry'& database, records whose keys are non-existent message ids are
38686 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38687 whenever it removes information from the database.
38688
38689 Certain records are automatically removed by Exim when they are no longer
38690 needed, but others are not. For example, if all the MX hosts for a domain are
38691 down, a retry record is created for each one. If the primary MX host comes back
38692 first, its record is removed when Exim successfully delivers to it, but the
38693 records for the others remain because Exim has not tried to use those hosts.
38694
38695 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38696 hints databases. You should do this at a quiet time of day, because it requires
38697 a database to be locked (and therefore inaccessible to Exim) while it does its
38698 work. Removing records from a DBM file does not normally make the file smaller,
38699 but all the common DBM libraries are able to re-use the space that is released.
38700 After an initial phase of increasing in size, the databases normally reach a
38701 point at which they no longer get any bigger, as long as they are regularly
38702 tidied.
38703
38704 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38705 databases is likely to keep on increasing.
38706
38707
38708
38709
38710 .section "exim_fixdb" "SECID263"
38711 .cindex "&'exim_fixdb'&"
38712 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38713 Its main use is for testing Exim, but it might also be occasionally useful for
38714 getting round problems in a live system. It has no options, and its interface
38715 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38716 key of a database record can then be entered, and the data for that record is
38717 displayed.
38718
38719 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38720 except the &'retry'& database, that is the only operation that can be carried
38721 out. For the &'retry'& database, each field is output preceded by a number, and
38722 data for individual fields can be changed by typing the field number followed
38723 by new data, for example:
38724 .code
38725 > 4 951102:1000
38726 .endd
38727 resets the time of the next delivery attempt. Time values are given as a
38728 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38729 used as optional separators.
38730
38731
38732
38733
38734 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38735 .cindex "mailbox" "maintenance"
38736 .cindex "&'exim_lock'&"
38737 .cindex "locking mailboxes"
38738 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38739 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38740 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38741 a user agent while investigating a problem. The utility requires the name of
38742 the file as its first argument. If the locking is successful, the second
38743 argument is run as a command (using C's &[system()]& function); if there is no
38744 second argument, the value of the SHELL environment variable is used; if this
38745 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38746 is unlocked and the utility ends. The following options are available:
38747
38748 .vlist
38749 .vitem &%-fcntl%&
38750 Use &[fcntl()]& locking on the open mailbox.
38751
38752 .vitem &%-flock%&
38753 Use &[flock()]& locking on the open mailbox, provided the operating system
38754 supports it.
38755
38756 .vitem &%-interval%&
38757 This must be followed by a number, which is a number of seconds; it sets the
38758 interval to sleep between retries (default 3).
38759
38760 .vitem &%-lockfile%&
38761 Create a lock file before opening the mailbox.
38762
38763 .vitem &%-mbx%&
38764 Lock the mailbox using MBX rules.
38765
38766 .vitem &%-q%&
38767 Suppress verification output.
38768
38769 .vitem &%-retries%&
38770 This must be followed by a number; it sets the number of times to try to get
38771 the lock (default 10).
38772
38773 .vitem &%-restore_time%&
38774 This option causes &%exim_lock%& to restore the modified and read times to the
38775 locked file before exiting. This allows you to access a locked mailbox (for
38776 example, to take a backup copy) without disturbing the times that the user
38777 subsequently sees.
38778
38779 .vitem &%-timeout%&
38780 This must be followed by a number, which is a number of seconds; it sets a
38781 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38782 default), a non-blocking call is used.
38783
38784 .vitem &%-v%&
38785 Generate verbose output.
38786 .endlist
38787
38788 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38789 default is to create a lock file and also to use &[fcntl()]& locking on the
38790 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38791 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38792 requires that the directory containing the file be writeable. Locking by lock
38793 file does not last forever; Exim assumes that a lock file is expired if it is
38794 more than 30 minutes old.
38795
38796 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38797 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38798 to be taken out on the open mailbox, and an exclusive lock on the file
38799 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38800 number of the mailbox file. When the locking is released, if an exclusive lock
38801 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38802
38803 The default output contains verification of the locking that takes place. The
38804 &%-v%& option causes some additional information to be given. The &%-q%& option
38805 suppresses all output except error messages.
38806
38807 A command such as
38808 .code
38809 exim_lock /var/spool/mail/spqr
38810 .endd
38811 runs an interactive shell while the file is locked, whereas
38812 .display
38813 &`exim_lock -q /var/spool/mail/spqr <<End`&
38814 <&'some commands'&>
38815 &`End`&
38816 .endd
38817 runs a specific non-interactive sequence of commands while the file is locked,
38818 suppressing all verification output. A single command can be run by a command
38819 such as
38820 .code
38821 exim_lock -q /var/spool/mail/spqr \
38822   "cp /var/spool/mail/spqr /some/where"
38823 .endd
38824 Note that if a command is supplied, it must be entirely contained within the
38825 second argument &-- hence the quotes.
38826 .ecindex IIDutils
38827
38828
38829 . ////////////////////////////////////////////////////////////////////////////
38830 . ////////////////////////////////////////////////////////////////////////////
38831
38832 .chapter "The Exim monitor" "CHAPeximon"
38833 .scindex IIDeximon "Exim monitor" "description"
38834 .cindex "X-windows"
38835 .cindex "&'eximon'&"
38836 .cindex "Local/eximon.conf"
38837 .cindex "&_exim_monitor/EDITME_&"
38838 The Exim monitor is an application which displays in an X window information
38839 about the state of Exim's queue and what Exim is doing. An admin user can
38840 perform certain operations on messages from this GUI interface; however all
38841 such facilities are also available from the command line, and indeed, the
38842 monitor itself makes use of the command line to perform any actions requested.
38843
38844
38845
38846 .section "Running the monitor" "SECID264"
38847 The monitor is started by running the script called &'eximon'&. This is a shell
38848 script that sets up a number of environment variables, and then runs the
38849 binary called &_eximon.bin_&. The default appearance of the monitor window can
38850 be changed by editing the &_Local/eximon.conf_& file created by editing
38851 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38852 parameters are for.
38853
38854 The parameters that get built into the &'eximon'& script can be overridden for
38855 a particular invocation by setting up environment variables of the same names,
38856 preceded by &`EXIMON_`&. For example, a shell command such as
38857 .code
38858 EXIMON_LOG_DEPTH=400 eximon
38859 .endd
38860 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38861 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38862 overrides the Exim log file configuration. This makes it possible to have
38863 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38864 syslog messages are routed to a file on the local host.
38865
38866 X resources can be used to change the appearance of the window in the normal
38867 way. For example, a resource setting of the form
38868 .code
38869 Eximon*background: gray94
38870 .endd
38871 changes the colour of the background to light grey rather than white. The
38872 stripcharts are drawn with both the data lines and the reference lines in
38873 black. This means that the reference lines are not visible when on top of the
38874 data. However, their colour can be changed by setting a resource called
38875 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38876 For example, if your X server is running Unix, you could set up lighter
38877 reference lines in the stripcharts by obeying
38878 .code
38879 xrdb -merge <<End
38880 Eximon*highlight: gray
38881 End
38882 .endd
38883 .cindex "admin user"
38884 In order to see the contents of messages in the queue, and to operate on them,
38885 &'eximon'& must either be run as root or by an admin user.
38886
38887 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38888 contain X11 resource parameters interpreted by the X11 library.  In addition,
38889 if the first parameter starts with the string "gdb" then it is removed and the
38890 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38891 versioned variants of gdb can be invoked).
38892
38893 The monitor's window is divided into three parts. The first contains one or
38894 more stripcharts and two action buttons, the second contains a &"tail"& of the
38895 main log file, and the third is a display of the queue of messages awaiting
38896 delivery, with two more action buttons. The following sections describe these
38897 different parts of the display.
38898
38899
38900
38901
38902 .section "The stripcharts" "SECID265"
38903 .cindex "stripchart"
38904 The first stripchart is always a count of messages in the queue. Its name can
38905 be configured by setting QUEUE_STRIPCHART_NAME in the
38906 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38907 configuration script by regular expression matches on log file entries, making
38908 it possible to display, for example, counts of messages delivered to certain
38909 hosts or using certain transports. The supplied defaults display counts of
38910 received and delivered messages, and of local and SMTP deliveries. The default
38911 period between stripchart updates is one minute; this can be adjusted by a
38912 parameter in the &_Local/eximon.conf_& file.
38913
38914 The stripchart displays rescale themselves automatically as the value they are
38915 displaying changes. There are always 10 horizontal lines in each chart; the
38916 title string indicates the value of each division when it is greater than one.
38917 For example, &"x2"& means that each division represents a value of 2.
38918
38919 It is also possible to have a stripchart which shows the percentage fullness of
38920 a particular disk partition, which is useful when local deliveries are confined
38921 to a single partition.
38922
38923 .cindex "&%statvfs%& function"
38924 This relies on the availability of the &[statvfs()]& function or equivalent in
38925 the operating system. Most, but not all versions of Unix that support Exim have
38926 this. For this particular stripchart, the top of the chart always represents
38927 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38928 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38929 &_Local/eximon.conf_& file.
38930
38931
38932
38933
38934 .section "Main action buttons" "SECID266"
38935 .cindex "size" "of monitor window"
38936 .cindex "Exim monitor" "window size"
38937 .cindex "window size"
38938 Below the stripcharts there is an action button for quitting the monitor. Next
38939 to this is another button marked &"Size"&. They are placed here so that
38940 shrinking the window to its default minimum size leaves just the queue count
38941 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38942 the window to expand to its maximum size, unless it is already at the maximum,
38943 in which case it is reduced to its minimum.
38944
38945 When expanding to the maximum, if the window cannot be fully seen where it
38946 currently is, it is moved back to where it was the last time it was at full
38947 size. When it is expanding from its minimum size, the old position is
38948 remembered, and next time it is reduced to the minimum it is moved back there.
38949
38950 The idea is that you can keep a reduced window just showing one or two
38951 stripcharts at a convenient place on your screen, easily expand it to show
38952 the full window when required, and just as easily put it back to what it was.
38953 The idea is copied from what the &'twm'& window manager does for its
38954 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38955 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38956
38957 Normally, the monitor starts up with the window at its full size, but it can be
38958 built so that it starts up with the window at its smallest size, by setting
38959 START_SMALL=yes in &_Local/eximon.conf_&.
38960
38961
38962
38963 .section "The log display" "SECID267"
38964 .cindex "log" "tail of; in monitor"
38965 The second section of the window is an area in which a display of the tail of
38966 the main log is maintained.
38967 To save space on the screen, the timestamp on each log line is shortened by
38968 removing the date and, if &%log_timezone%& is set, the timezone.
38969 The log tail is not available when the only destination for logging data is
38970 syslog, unless the syslog lines are routed to a local file whose name is passed
38971 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38972
38973 The log sub-window has a scroll bar at its lefthand side which can be used to
38974 move back to look at earlier text, and the up and down arrow keys also have a
38975 scrolling effect. The amount of log that is kept depends on the setting of
38976 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38977 to use. When this is full, the earlier 50% of data is discarded &-- this is
38978 much more efficient than throwing it away line by line. The sub-window also has
38979 a horizontal scroll bar for accessing the ends of long log lines. This is the
38980 only means of horizontal scrolling; the right and left arrow keys are not
38981 available. Text can be cut from this part of the window using the mouse in the
38982 normal way. The size of this subwindow is controlled by parameters in the
38983 configuration file &_Local/eximon.conf_&.
38984
38985 Searches of the text in the log window can be carried out by means of the ^R
38986 and ^S keystrokes, which default to a reverse and a forward search,
38987 respectively. The search covers only the text that is displayed in the window.
38988 It cannot go further back up the log.
38989
38990 The point from which the search starts is indicated by a caret marker. This is
38991 normally at the end of the text in the window, but can be positioned explicitly
38992 by pointing and clicking with the left mouse button, and is moved automatically
38993 by a successful search. If new text arrives in the window when it is scrolled
38994 back, the caret remains where it is, but if the window is not scrolled back,
38995 the caret is moved to the end of the new text.
38996
38997 Pressing ^R or ^S pops up a window into which the search text can be typed.
38998 There are buttons for selecting forward or reverse searching, for carrying out
38999 the search, and for cancelling. If the &"Search"& button is pressed, the search
39000 happens and the window remains so that further searches can be done. If the
39001 &"Return"& key is pressed, a single search is done and the window is closed. If
39002 ^C is typed the search is cancelled.
39003
39004 The searching facility is implemented using the facilities of the Athena text
39005 widget. By default this pops up a window containing both &"search"& and
39006 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39007 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39008 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39009 provided version of &%TextPop%& when the remaining parts of the text widget
39010 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39011 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39012 on these systems, at the expense of having unwanted items in the search popup
39013 window.
39014
39015
39016
39017 .section "The queue display" "SECID268"
39018 .cindex "queue" "display in monitor"
39019 The bottom section of the monitor window contains a list of all messages that
39020 are in the queue, which includes those currently being received or delivered,
39021 as well as those awaiting delivery. The size of this subwindow is controlled by
39022 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39023 at which it is updated is controlled by another parameter in the same file &--
39024 the default is 5 minutes, since queue scans can be quite expensive. However,
39025 there is an &"Update"& action button just above the display which can be used
39026 to force an update of the queue display at any time.
39027
39028 When a host is down for some time, a lot of pending mail can build up for it,
39029 and this can make it hard to deal with other messages in the queue. To help
39030 with this situation there is a button next to &"Update"& called &"Hide"&. If
39031 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39032 type anything in here and press &"Return"&, the text is added to a chain of
39033 such texts, and if every undelivered address in a message matches at least one
39034 of the texts, the message is not displayed.
39035
39036 If there is an address that does not match any of the texts, all the addresses
39037 are displayed as normal. The matching happens on the ends of addresses so, for
39038 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39039 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39040 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39041 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39042 a hide request is automatically cancelled after one hour.
39043
39044 While the dialogue box is displayed, you can't press any buttons or do anything
39045 else to the monitor window. For this reason, if you want to cut text from the
39046 queue display to use in the dialogue box, you have to do the cutting before
39047 pressing the &"Hide"& button.
39048
39049 The queue display contains, for each unhidden queued message, the length of
39050 time it has been in the queue, the size of the message, the message id, the
39051 message sender, and the first undelivered recipient, all on one line. If it is
39052 a bounce message, the sender is shown as &"<>"&. If there is more than one
39053 recipient to which the message has not yet been delivered, subsequent ones are
39054 listed on additional lines, up to a maximum configured number, following which
39055 an ellipsis is displayed. Recipients that have already received the message are
39056 not shown.
39057
39058 .cindex "frozen messages" "display"
39059 If a message is frozen, an asterisk is displayed at the left-hand side.
39060
39061 The queue display has a vertical scroll bar, and can also be scrolled by means
39062 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39063 The text searching facilities, as described above for the log window, are also
39064 available, but the caret is always moved to the end of the text when the queue
39065 display is updated.
39066
39067
39068
39069 .section "The queue menu" "SECID269"
39070 .cindex "queue" "menu in monitor"
39071 If the &%shift%& key is held down and the left button is clicked when the mouse
39072 pointer is over the text for any message, an action menu pops up, and the first
39073 line of the queue display for the message is highlighted. This does not affect
39074 any selected text.
39075
39076 If you want to use some other event for popping up the menu, you can set the
39077 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39078 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39079 value set in this parameter is a standard X event description. For example, to
39080 run eximon using &%ctrl%& rather than &%shift%& you could use
39081 .code
39082 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39083 .endd
39084 The title of the menu is the message id, and it contains entries which act as
39085 follows:
39086
39087 .ilist
39088 &'message log'&: The contents of the message log for the message are displayed
39089 in a new text window.
39090 .next
39091 &'headers'&: Information from the spool file that contains the envelope
39092 information and headers is displayed in a new text window. See chapter
39093 &<<CHAPspool>>& for a description of the format of spool files.
39094 .next
39095 &'body'&: The contents of the spool file containing the body of the message are
39096 displayed in a new text window. There is a default limit of 20,000 bytes to the
39097 amount of data displayed. This can be changed by setting the BODY_MAX
39098 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39099 .next
39100 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39101 delivery of the message. This causes an automatic thaw if the message is
39102 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39103 a new text window. The delivery is run in a separate process, to avoid holding
39104 up the monitor while the delivery proceeds.
39105 .next
39106 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39107 that the message be frozen.
39108 .next
39109 .cindex "thawing messages"
39110 .cindex "unfreezing messages"
39111 .cindex "frozen messages" "thawing"
39112 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39113 that the message be thawed.
39114 .next
39115 .cindex "delivery" "forcing failure"
39116 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39117 that Exim gives up trying to deliver the message. A bounce message is generated
39118 for any remaining undelivered addresses.
39119 .next
39120 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39121 that the message be deleted from the system without generating a bounce
39122 message.
39123 .next
39124 &'add recipient'&: A dialog box is displayed into which a recipient address can
39125 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39126 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39127 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39128 causes a call to Exim to be made using the &%-Mar%& option to request that an
39129 additional recipient be added to the message, unless the entry box is empty, in
39130 which case no action is taken.
39131 .next
39132 &'mark delivered'&: A dialog box is displayed into which a recipient address
39133 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39134 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39135 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39136 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39137 recipient address as already delivered, unless the entry box is empty, in which
39138 case no action is taken.
39139 .next
39140 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39141 mark all recipient addresses as already delivered.
39142 .next
39143 &'edit sender'&: A dialog box is displayed initialized with the current
39144 sender's address. Pressing RETURN causes a call to Exim to be made using the
39145 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39146 in which case no action is taken. If you want to set an empty sender (as in
39147 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39148 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39149 the address is qualified with that domain.
39150 .endlist
39151
39152 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39153 other cases when a call to Exim is made, if there is any output from Exim (in
39154 particular, if the command fails) a window containing the command and the
39155 output is displayed. Otherwise, the results of the action are normally apparent
39156 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39157 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39158 if no output is generated.
39159
39160 The queue display is automatically updated for actions such as freezing and
39161 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39162 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39163 force an update of the display after one of these actions.
39164
39165 In any text window that is displayed as result of a menu action, the normal
39166 cut-and-paste facility is available, and searching can be carried out using ^R
39167 and ^S, as described above for the log tail window.
39168 .ecindex IIDeximon
39169
39170
39171
39172
39173
39174 . ////////////////////////////////////////////////////////////////////////////
39175 . ////////////////////////////////////////////////////////////////////////////
39176
39177 .chapter "Security considerations" "CHAPsecurity"
39178 .scindex IIDsecurcon "security" "discussion of"
39179 This chapter discusses a number of issues concerned with security, some of
39180 which are also covered in other parts of this manual.
39181
39182 For reasons that this author does not understand, some people have promoted
39183 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39184 existence of this chapter in the documentation. However, the intent of the
39185 chapter is simply to describe the way Exim works in relation to certain
39186 security concerns, not to make any specific claims about the effectiveness of
39187 its security as compared with other MTAs.
39188
39189 What follows is a description of the way Exim is supposed to be. Best efforts
39190 have been made to try to ensure that the code agrees with the theory, but an
39191 absence of bugs can never be guaranteed. Any that are reported will get fixed
39192 as soon as possible.
39193
39194
39195 .section "Building a more &""hardened""& Exim" "SECID286"
39196 .cindex "security" "build-time features"
39197 There are a number of build-time options that can be set in &_Local/Makefile_&
39198 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39199 Exim administrator who does not have the root password, or by someone who has
39200 penetrated the Exim (but not the root) account. These options are as follows:
39201
39202 .ilist
39203 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39204 start of any filenames used with the &%-C%& option. When it is set, these
39205 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39206 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39207 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39208 default setting for &%ALT_CONFIG_PREFIX%&.
39209
39210 If the permitted configuration files are confined to a directory to
39211 which only root has access, this guards against someone who has broken
39212 into the Exim account from running a privileged Exim with an arbitrary
39213 configuration file, and using it to break into other accounts.
39214 .next
39215
39216 If a non-trusted configuration file (i.e. not the default configuration file
39217 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39218 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39219 the next item), then root privilege is retained only if the caller of Exim is
39220 root. This locks out the possibility of testing a configuration using &%-C%&
39221 right through message reception and delivery, even if the caller is root. The
39222 reception works, but by that time, Exim is running as the Exim user, so when
39223 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39224 privilege to be lost. However, root can test reception and delivery using two
39225 separate commands.
39226
39227 .next
39228 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39229 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39230 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39231 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39232 the restrictive side.  Requiring build-time selection of safe macros is onerous
39233 but this option is intended solely as a transition mechanism to permit
39234 previously-working configurations to continue to work after release 4.73.
39235 .next
39236 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39237 is disabled.
39238 .next
39239 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39240 never to be used for any deliveries. This is like the &%never_users%& runtime
39241 option, but it cannot be overridden; the runtime option adds additional users
39242 to the list. The default setting is &"root"&; this prevents a non-root user who
39243 is permitted to modify the runtime file from using Exim as a way to get root.
39244 .endlist
39245
39246
39247
39248 .section "Root privilege" "SECID270"
39249 .cindex "setuid"
39250 .cindex "root privilege"
39251 The Exim binary is normally setuid to root, which means that it gains root
39252 privilege (runs as root) when it starts execution. In some special cases (for
39253 example, when the daemon is not in use and there are no local deliveries), it
39254 may be possible to run Exim setuid to some user other than root. This is
39255 discussed in the next section. However, in most installations, root privilege
39256 is required for two things:
39257
39258 .ilist
39259 To set up a socket connected to the standard SMTP port (25) when initialising
39260 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39261 not required.
39262 .next
39263 To be able to change uid and gid in order to read users' &_.forward_& files and
39264 perform local deliveries as the receiving user or as specified in the
39265 configuration.
39266 .endlist
39267
39268 It is not necessary to be root to do any of the other things Exim does, such as
39269 receiving messages and delivering them externally over SMTP, and it is
39270 obviously more secure if Exim does not run as root except when necessary.
39271 For this reason, a user and group for Exim to use must be defined in
39272 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39273 group"&. Their values can be changed by the runtime configuration, though this
39274 is not recommended. Often a user called &'exim'& is used, but some sites use
39275 &'mail'& or another user name altogether.
39276
39277 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39278 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39279 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39280
39281 After a new Exim process has interpreted its command line options, it changes
39282 uid and gid in the following cases:
39283
39284 .ilist
39285 .oindex "&%-C%&"
39286 .oindex "&%-D%&"
39287 If the &%-C%& option is used to specify an alternate configuration file, or if
39288 the &%-D%& option is used to define macro values for the configuration, and the
39289 calling process is not running as root, the uid and gid are changed to those of
39290 the calling process.
39291 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39292 option may not be used at all.
39293 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39294 can be supplied if the calling process is running as root, the Exim run-time
39295 user or CONFIGURE_OWNER, if defined.
39296 .next
39297 .oindex "&%-be%&"
39298 .oindex "&%-bf%&"
39299 .oindex "&%-bF%&"
39300 If the expansion test option (&%-be%&) or one of the filter testing options
39301 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39302 calling process.
39303 .next
39304 If the process is not a daemon process or a queue runner process or a delivery
39305 process or a process for testing address routing (started with &%-bt%&), the
39306 uid and gid are changed to the Exim user and group. This means that Exim always
39307 runs under its own uid and gid when receiving messages. This also applies when
39308 testing address verification
39309 .oindex "&%-bv%&"
39310 .oindex "&%-bh%&"
39311 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39312 option).
39313 .next
39314 For a daemon, queue runner, delivery, or address testing process, the uid
39315 remains as root at this stage, but the gid is changed to the Exim group.
39316 .endlist
39317
39318 The processes that initially retain root privilege behave as follows:
39319
39320 .ilist
39321 A daemon process changes the gid to the Exim group and the uid to the Exim
39322 user after setting up one or more listening sockets. The &[initgroups()]&
39323 function is called, so that if the Exim user is in any additional groups, they
39324 will be used during message reception.
39325 .next
39326 A queue runner process retains root privilege throughout its execution. Its
39327 job is to fork a controlled sequence of delivery processes.
39328 .next
39329 A delivery process retains root privilege throughout most of its execution,
39330 but any actual deliveries (that is, the transports themselves) are run in
39331 subprocesses which always change to a non-root uid and gid. For local
39332 deliveries this is typically the uid and gid of the owner of the mailbox; for
39333 remote deliveries, the Exim uid and gid are used. Once all the delivery
39334 subprocesses have been run, a delivery process changes to the Exim uid and gid
39335 while doing post-delivery tidying up such as updating the retry database and
39336 generating bounce and warning messages.
39337
39338 While the recipient addresses in a message are being routed, the delivery
39339 process runs as root. However, if a user's filter file has to be processed,
39340 this is done in a subprocess that runs under the individual user's uid and
39341 gid. A system filter is run as root unless &%system_filter_user%& is set.
39342 .next
39343 A process that is testing addresses (the &%-bt%& option) runs as root so that
39344 the routing is done in the same environment as a message delivery.
39345 .endlist
39346
39347
39348
39349
39350 .section "Running Exim without privilege" "SECTrunexiwitpri"
39351 .cindex "privilege, running without"
39352 .cindex "unprivileged running"
39353 .cindex "root privilege" "running without"
39354 Some installations like to run Exim in an unprivileged state for more of its
39355 operation, for added security. Support for this mode of operation is provided
39356 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39357 gid are changed to the Exim user and group at the start of a delivery process
39358 (and also queue runner and address testing processes). This means that address
39359 routing is no longer run as root, and the deliveries themselves cannot change
39360 to any other uid.
39361
39362 .cindex SIGHUP
39363 .cindex "daemon" "restarting"
39364 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39365 that the daemon can still be started in the usual way, and it can respond
39366 correctly to SIGHUP because the re-invocation regains root privilege.
39367
39368 An alternative approach is to make Exim setuid to the Exim user and also setgid
39369 to the Exim group. If you do this, the daemon must be started from a root
39370 process. (Calling Exim from a root process makes it behave in the way it does
39371 when it is setuid root.) However, the daemon cannot restart itself after a
39372 SIGHUP signal because it cannot regain privilege.
39373
39374 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39375 stops Exim from trying to re-invoke itself to do a delivery after a message has
39376 been received. Such a re-invocation is a waste of resources because it has no
39377 effect.
39378
39379 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39380 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39381 to the Exim user seems a clean approach, but there is one complication:
39382
39383 In this style of operation, Exim is running with the real uid and gid set to
39384 those of the calling process, and the effective uid/gid set to Exim's values.
39385 Ideally, any association with the calling process' uid/gid should be dropped,
39386 that is, the real uid/gid should be reset to the effective values so as to
39387 discard any privileges that the caller may have. While some operating systems
39388 have a function that permits this action for a non-root effective uid, quite a
39389 number of them do not. Because of this lack of standardization, Exim does not
39390 address this problem at this time.
39391
39392 For this reason, the recommended approach for &"mostly unprivileged"& running
39393 is to keep the Exim binary setuid to root, and to set
39394 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39395 be used in the most straightforward way.
39396
39397 If you configure Exim not to run delivery processes as root, there are a
39398 number of restrictions on what you can do:
39399
39400 .ilist
39401 You can deliver only as the Exim user/group. You should  explicitly use the
39402 &%user%& and &%group%& options to override routers or local transports that
39403 normally deliver as the recipient. This makes sure that configurations that
39404 work in this mode function the same way in normal mode. Any implicit or
39405 explicit specification of another user causes an error.
39406 .next
39407 Use of &_.forward_& files is severely restricted, such that it is usually
39408 not worthwhile to include them in the configuration.
39409 .next
39410 Users who wish to use &_.forward_& would have to make their home directory and
39411 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39412 and their equivalents in Exim filters, cannot be used. While they could be
39413 enabled in the Exim user's name, that would be insecure and not very useful.
39414 .next
39415 Unless the local user mailboxes are all owned by the Exim user (possible in
39416 some POP3 or IMAP-only environments):
39417
39418 .olist
39419 They must be owned by the Exim group and be writeable by that group. This
39420 implies you must set &%mode%& in the appendfile configuration, as well as the
39421 mode of the mailbox files themselves.
39422 .next
39423 You must set &%no_check_owner%&, since most or all of the files will not be
39424 owned by the Exim user.
39425 .next
39426 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39427 on a newly created mailbox when unprivileged. This also implies that new
39428 mailboxes need to be created manually.
39429 .endlist olist
39430 .endlist ilist
39431
39432
39433 These restrictions severely restrict what can be done in local deliveries.
39434 However, there are no restrictions on remote deliveries. If you are running a
39435 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39436 gives more security at essentially no cost.
39437
39438 If you are using the &%mua_wrapper%& facility (see chapter
39439 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39440
39441
39442
39443
39444 .section "Delivering to local files" "SECID271"
39445 Full details of the checks applied by &(appendfile)& before it writes to a file
39446 are given in chapter &<<CHAPappendfile>>&.
39447
39448
39449
39450 .section "Running local commands" "SECTsecconslocalcmds"
39451 .cindex "security" "local commands"
39452 .cindex "security" "command injection attacks"
39453 There are a number of ways in which an administrator can configure Exim to run
39454 commands based upon received, untrustworthy, data. Further, in some
39455 configurations a user who can control a &_.forward_& file can also arrange to
39456 run commands. Configuration to check includes, but is not limited to:
39457
39458 .ilist
39459 Use of &%use_shell%& in the pipe transport: various forms of shell command
39460 injection may be possible with this option present. It is dangerous and should
39461 be used only with considerable caution. Consider constraints which whitelist
39462 allowed characters in a variable which is to be used in a pipe transport that
39463 has &%use_shell%& enabled.
39464 .next
39465 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39466 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39467 &_.forward_& files in a redirect router. If Exim is running on a central mail
39468 hub to which ordinary users do not have shell access, but home directories are
39469 NFS mounted (for instance) then administrators should review the list of these
39470 forbid options available, and should bear in mind that the options that may
39471 need forbidding can change as new features are added between releases.
39472 .next
39473 The &%${run...}%& expansion item does not use a shell by default, but
39474 administrators can configure use of &_/bin/sh_& as part of the command.
39475 Such invocations should be viewed with prejudicial suspicion.
39476 .next
39477 Administrators who use embedded Perl are advised to explore how Perl's
39478 taint checking might apply to their usage.
39479 .next
39480 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39481 administrators are well advised to view its use with suspicion, in case (for
39482 instance) it allows a local-part to contain embedded Exim directives.
39483 .next
39484 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39485 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39486 each can reference arbitrary lists and files, rather than just being a list
39487 of opaque strings.
39488 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39489 real-world security vulnerabilities caused by its use with untrustworthy data
39490 injected in, for SQL injection attacks.
39491 Consider the use of the &%inlisti%& expansion condition instead.
39492 .endlist
39493
39494
39495
39496
39497 .section "Trust in configuration data" "SECTsecconfdata"
39498 .cindex "security" "data sources"
39499 .cindex "security" "regular expressions"
39500 .cindex "regular expressions" "security"
39501 .cindex "PCRE" "security"
39502 If configuration data for Exim can come from untrustworthy sources, there
39503 are some issues to be aware of:
39504
39505 .ilist
39506 Use of &%${expand...}%& may provide a path for shell injection attacks.
39507 .next
39508 Letting untrusted data provide a regular expression is unwise.
39509 .next
39510 Using &%${match...}%& to apply a fixed regular expression against untrusted
39511 data may result in pathological behaviour within PCRE.  Be aware of what
39512 "backtracking" means and consider options for being more strict with a regular
39513 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39514 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39515 possessive quantifiers or just not using regular expressions against untrusted
39516 data.
39517 .next
39518 It can be important to correctly use &%${quote:...}%&,
39519 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39520 items to ensure that data is correctly constructed.
39521 .next
39522 Some lookups might return multiple results, even though normal usage is only
39523 expected to yield one result.
39524 .endlist
39525
39526
39527
39528
39529 .section "IPv4 source routing" "SECID272"
39530 .cindex "source routing" "in IP packets"
39531 .cindex "IP source routing"
39532 Many operating systems suppress IP source-routed packets in the kernel, but
39533 some cannot be made to do this, so Exim does its own check. It logs incoming
39534 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39535 IPv6. No special checking is currently done.
39536
39537
39538
39539 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39540 Support for these SMTP commands is disabled by default. If required, they can
39541 be enabled by defining suitable ACLs.
39542
39543
39544
39545
39546 .section "Privileged users" "SECID274"
39547 .cindex "trusted users"
39548 .cindex "admin user"
39549 .cindex "privileged user"
39550 .cindex "user" "trusted"
39551 .cindex "user" "admin"
39552 Exim recognizes two sets of users with special privileges. Trusted users are
39553 able to submit new messages to Exim locally, but supply their own sender
39554 addresses and information about a sending host. For other users submitting
39555 local messages, Exim sets up the sender address from the uid, and doesn't
39556 permit a remote host to be specified.
39557
39558 .oindex "&%-f%&"
39559 However, an untrusted user is permitted to use the &%-f%& command line option
39560 in the special form &%-f <>%& to indicate that a delivery failure for the
39561 message should not cause an error report. This affects the message's envelope,
39562 but it does not affect the &'Sender:'& header. Untrusted users may also be
39563 permitted to use specific forms of address with the &%-f%& option by setting
39564 the &%untrusted_set_sender%& option.
39565
39566 Trusted users are used to run processes that receive mail messages from some
39567 other mail domain and pass them on to Exim for delivery either locally, or over
39568 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39569 as any user listed in the &%trusted_users%& configuration option, or under any
39570 group listed in the &%trusted_groups%& option.
39571
39572 Admin users are permitted to do things to the messages on Exim's queue. They
39573 can freeze or thaw messages, cause them to be returned to their senders, remove
39574 them entirely, or modify them in various ways. In addition, admin users can run
39575 the Exim monitor and see all the information it is capable of providing, which
39576 includes the contents of files on the spool.
39577
39578 .oindex "&%-M%&"
39579 .oindex "&%-q%&"
39580 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39581 delivery of messages on its queue is restricted to admin users. This
39582 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39583 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39584 queue is also restricted to admin users. This restriction can be relaxed by
39585 setting &%no_queue_list_requires_admin%&.
39586
39587 Exim recognizes an admin user if the calling process is running as root or as
39588 the Exim user or if any of the groups associated with the calling process is
39589 the Exim group. It is not necessary actually to be running under the Exim
39590 group. However, if admin users who are not root or the Exim user are to access
39591 the contents of files on the spool via the Exim monitor (which runs
39592 unprivileged), Exim must be built to allow group read access to its spool
39593 files.
39594
39595 By default, regular users are trusted to perform basic testing and
39596 introspection commands, as themselves.  This setting can be tightened by
39597 setting the &%commandline_checks_require_admin%& option.
39598 This affects most of the checking options,
39599 such as &%-be%& and anything else &%-b*%&.
39600
39601
39602 .section "Spool files" "SECID275"
39603 .cindex "spool directory" "files"
39604 Exim's spool directory and everything it contains is owned by the Exim user and
39605 set to the Exim group. The mode for spool files is defined in the
39606 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39607 any user who is a member of the Exim group can access these files.
39608
39609
39610
39611 .section "Use of argv[0]" "SECID276"
39612 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39613 of specific strings, Exim assumes certain options. For example, calling Exim
39614 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39615 to calling it with the option &%-bS%&. There are no security implications in
39616 this.
39617
39618
39619
39620 .section "Use of %f formatting" "SECID277"
39621 The only use made of &"%f"& by Exim is in formatting load average values. These
39622 are actually stored in integer variables as 1000 times the load average.
39623 Consequently, their range is limited and so therefore is the length of the
39624 converted output.
39625
39626
39627
39628 .section "Embedded Exim path" "SECID278"
39629 Exim uses its own path name, which is embedded in the code, only when it needs
39630 to re-exec in order to regain root privilege. Therefore, it is not root when it
39631 does so. If some bug allowed the path to get overwritten, it would lead to an
39632 arbitrary program's being run as exim, not as root.
39633
39634
39635
39636 .section "Dynamic module directory" "SECTdynmoddir"
39637 Any dynamically loadable modules must be installed into the directory
39638 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39639 loading it.
39640
39641
39642 .section "Use of sprintf()" "SECID279"
39643 .cindex "&[sprintf()]&"
39644 A large number of occurrences of &"sprintf"& in the code are actually calls to
39645 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39646 The intermediate formatting is done into a large fixed buffer by a function
39647 that runs through the format string itself, and checks the length of each
39648 conversion before performing it, thus preventing buffer overruns.
39649
39650 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39651 the output buffer is known to be sufficiently long to contain the converted
39652 string.
39653
39654
39655
39656 .section "Use of debug_printf() and log_write()" "SECID280"
39657 Arbitrary strings are passed to both these functions, but they do their
39658 formatting by calling the function &'string_vformat()'&, which runs through
39659 the format string itself, and checks the length of each conversion.
39660
39661
39662
39663 .section "Use of strcat() and strcpy()" "SECID281"
39664 These are used only in cases where the output buffer is known to be large
39665 enough to hold the result.
39666 .ecindex IIDsecurcon
39667
39668
39669
39670
39671 . ////////////////////////////////////////////////////////////////////////////
39672 . ////////////////////////////////////////////////////////////////////////////
39673
39674 .chapter "Format of spool files" "CHAPspool"
39675 .scindex IIDforspo1 "format" "spool files"
39676 .scindex IIDforspo2 "spool directory" "format of files"
39677 .scindex IIDforspo3 "spool files" "format of"
39678 .cindex "spool files" "editing"
39679 A message on Exim's queue consists of two files, whose names are the message id
39680 followed by -D and -H, respectively. The data portion of the message is kept in
39681 the -D file on its own. The message's envelope, status, and headers are all
39682 kept in the -H file, whose format is described in this chapter. Each of these
39683 two files contains the final component of its own name as its first line. This
39684 is insurance against disk crashes where the directory is lost but the files
39685 themselves are recoverable.
39686
39687 The file formats may be changed, or new formats added, at any release.
39688 Spool files are not intended as an interface to other programs
39689 and should not be used as such.
39690
39691 Some people are tempted into editing -D files in order to modify messages. You
39692 need to be extremely careful if you do this; it is not recommended and you are
39693 on your own if you do it. Here are some of the pitfalls:
39694
39695 .ilist
39696 You must ensure that Exim does not try to deliver the message while you are
39697 fiddling with it. The safest way is to take out a write lock on the -D file,
39698 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39699 place, the lock will be retained. If you write a new file and rename it, the
39700 lock will be lost at the instant of rename.
39701 .next
39702 .vindex "&$body_linecount$&"
39703 If you change the number of lines in the file, the value of
39704 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39705 cause incomplete transmission of messages or undeliverable messages.
39706 .next
39707 If the message is in MIME format, you must take care not to break it.
39708 .next
39709 If the message is cryptographically signed, any change will invalidate the
39710 signature.
39711 .endlist
39712 All in all, modifying -D files is fraught with danger.
39713
39714 Files whose names end with -J may also be seen in the &_input_& directory (or
39715 its subdirectories when &%split_spool_directory%& is set). These are journal
39716 files, used to record addresses to which the message has been delivered during
39717 the course of a delivery attempt. If there are still undelivered recipients at
39718 the end, the -H file is updated, and the -J file is deleted. If, however, there
39719 is some kind of crash (for example, a power outage) before this happens, the -J
39720 file remains in existence. When Exim next processes the message, it notices the
39721 -J file and uses it to update the -H file before starting the next delivery
39722 attempt.
39723
39724 Files whose names end with -K or .eml may also be seen in the spool.
39725 These are temporaries used for DKIM or malware processing, when that is used.
39726 They should be tidied up by normal operations; any old ones are probably
39727 relics of crashes and can be removed.
39728
39729 .section "Format of the -H file" "SECID282"
39730 .cindex "uid (user id)" "in spool file"
39731 .cindex "gid (group id)" "in spool file"
39732 The second line of the -H file contains the login name for the uid of the
39733 process that called Exim to read the message, followed by the numerical uid and
39734 gid. For a locally generated message, this is normally the user who sent the
39735 message. For a message received over TCP/IP via the daemon, it is
39736 normally the Exim user.
39737
39738 The third line of the file contains the address of the message's sender as
39739 transmitted in the envelope, contained in angle brackets. The sender address is
39740 empty for bounce messages. For incoming SMTP mail, the sender address is given
39741 in the MAIL command. For locally generated mail, the sender address is
39742 created by Exim from the login name of the current user and the configured
39743 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39744 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39745 &"<>"& or an address that matches &%untrusted_set_senders%&.
39746
39747 The fourth line contains two numbers. The first is the time that the message
39748 was received, in the conventional Unix form &-- the number of seconds since the
39749 start of the epoch. The second number is a count of the number of messages
39750 warning of delayed delivery that have been sent to the sender.
39751
39752 There follow a number of lines starting with a hyphen. These can appear in any
39753 order, and are omitted when not relevant:
39754
39755 .vlist
39756 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39757 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39758 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39759 recognized, to provide backward compatibility. In the old format, a line of
39760 this form is present for every ACL variable that is not empty. The number
39761 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39762 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39763 the data string for the variable. The string itself starts at the beginning of
39764 the next line, and is followed by a newline character. It may contain internal
39765 newlines.
39766
39767 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39768 A line of this form is present for every ACL connection variable that is
39769 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39770 The length is the length of the data string for the variable. The string itself
39771 starts at the beginning of the next line, and is followed by a newline
39772 character. It may contain internal newlines.
39773
39774 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39775 A line of this form is present for every ACL message variable that is defined.
39776 Note that there is a space between &%-aclm%& and the rest of the name. The
39777 length is the length of the data string for the variable. The string itself
39778 starts at the beginning of the next line, and is followed by a newline
39779 character. It may contain internal newlines.
39780
39781 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39782 This is present if, when the message was received over SMTP, the value of
39783 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39784
39785 .vitem &%-allow_unqualified_recipient%&
39786 This is present if unqualified recipient addresses are permitted in header
39787 lines (to stop such addresses from being qualified if rewriting occurs at
39788 transport time). Local messages that were input using &%-bnq%& and remote
39789 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39790
39791 .vitem &%-allow_unqualified_sender%&
39792 This is present if unqualified sender addresses are permitted in header lines
39793 (to stop such addresses from being qualified if rewriting occurs at transport
39794 time). Local messages that were input using &%-bnq%& and remote messages from
39795 hosts that match &%sender_unqualified_hosts%& set this flag.
39796
39797 .vitem "&%-auth_id%&&~<&'text'&>"
39798 The id information for a message received on an authenticated SMTP connection
39799 &-- the value of the &$authenticated_id$& variable.
39800
39801 .vitem "&%-auth_sender%&&~<&'address'&>"
39802 The address of an authenticated sender &-- the value of the
39803 &$authenticated_sender$& variable.
39804
39805 .vitem "&%-body_linecount%&&~<&'number'&>"
39806 This records the number of lines in the body of the message, and is
39807 present unless &%-spool_file_wireformat%& is.
39808
39809 .vitem "&%-body_zerocount%&&~<&'number'&>"
39810 This records the number of binary zero bytes in the body of the message, and is
39811 present if the number is greater than zero.
39812
39813 .vitem &%-deliver_firsttime%&
39814 This is written when a new message is first added to the spool. When the spool
39815 file is updated after a deferral, it is omitted.
39816
39817 .vitem "&%-frozen%&&~<&'time'&>"
39818 .cindex "frozen messages" "spool data"
39819 The message is frozen, and the freezing happened at <&'time'&>.
39820
39821 .vitem "&%-helo_name%&&~<&'text'&>"
39822 This records the host name as specified by a remote host in a HELO or EHLO
39823 command.
39824
39825 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39826 This records the IP address of the host from which the message was received and
39827 the remote port number that was used. It is omitted for locally generated
39828 messages.
39829
39830 .vitem "&%-host_auth%&&~<&'text'&>"
39831 If the message was received on an authenticated SMTP connection, this records
39832 the name of the authenticator &-- the value of the
39833 &$sender_host_authenticated$& variable.
39834
39835 .vitem &%-host_lookup_failed%&
39836 This is present if an attempt to look up the sending host's name from its IP
39837 address failed. It corresponds to the &$host_lookup_failed$& variable.
39838
39839 .vitem "&%-host_name%&&~<&'text'&>"
39840 .cindex "reverse DNS lookup"
39841 .cindex "DNS" "reverse lookup"
39842 This records the name of the remote host from which the message was received,
39843 if the host name was looked up from the IP address when the message was being
39844 received. It is not present if no reverse lookup was done.
39845
39846 .vitem "&%-ident%&&~<&'text'&>"
39847 For locally submitted messages, this records the login of the originating user,
39848 unless it was a trusted user and the &%-oMt%& option was used to specify an
39849 ident value. For messages received over TCP/IP, this records the ident string
39850 supplied by the remote host, if any.
39851
39852 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39853 This records the IP address of the local interface and the port number through
39854 which a message was received from a remote host. It is omitted for locally
39855 generated messages.
39856
39857 .vitem &%-local%&
39858 The message is from a local sender.
39859
39860 .vitem &%-localerror%&
39861 The message is a locally-generated bounce message.
39862
39863 .vitem "&%-local_scan%&&~<&'string'&>"
39864 This records the data string that was returned by the &[local_scan()]& function
39865 when the message was received &-- the value of the &$local_scan_data$&
39866 variable. It is omitted if no data was returned.
39867
39868 .vitem &%-manual_thaw%&
39869 The message was frozen but has been thawed manually, that is, by an explicit
39870 Exim command rather than via the auto-thaw process.
39871
39872 .vitem &%-N%&
39873 A testing delivery process was started using the &%-N%& option to suppress any
39874 actual deliveries, but delivery was deferred. At any further delivery attempts,
39875 &%-N%& is assumed.
39876
39877 .vitem &%-received_protocol%&
39878 This records the value of the &$received_protocol$& variable, which contains
39879 the name of the protocol by which the message was received.
39880
39881 .vitem &%-sender_set_untrusted%&
39882 The envelope sender of this message was set by an untrusted local caller (used
39883 to ensure that the caller is displayed in queue listings).
39884
39885 .vitem "&%-spam_score_int%&&~<&'number'&>"
39886 If a message was scanned by SpamAssassin, this is present. It records the value
39887 of &$spam_score_int$&.
39888
39889 .vitem &%-spool_file_wireformat%&
39890 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39891 rather than Unix-format.
39892 The line-ending is CRLF rather than newline.
39893 There is still, however, no leading-dot-stuffing.
39894
39895 .vitem &%-tls_certificate_verified%&
39896 A TLS certificate was received from the client that sent this message, and the
39897 certificate was verified by the server.
39898
39899 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39900 When the message was received over an encrypted connection, this records the
39901 name of the cipher suite that was used.
39902
39903 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39904 When the message was received over an encrypted connection, and a certificate
39905 was received from the client, this records the Distinguished Name from that
39906 certificate.
39907 .endlist
39908
39909 Any of the above may have an extra hyphen prepended, to indicate the the
39910 corresponding data is untrusted.
39911
39912 Following the options there is a list of those addresses to which the message
39913 is not to be delivered. This set of addresses is initialized from the command
39914 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39915 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39916 the address is added to this set. The addresses are kept internally as a
39917 balanced binary tree, and it is a representation of that tree which is written
39918 to the spool file. If an address is expanded via an alias or forward file, the
39919 original address is added to the tree when deliveries to all its child
39920 addresses are complete.
39921
39922 If the tree is empty, there is a single line in the spool file containing just
39923 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39924 Y or N, followed by an address. The address is the value for the node of the
39925 tree, and the letters indicate whether the node has a left branch and/or a
39926 right branch attached to it, respectively. If branches exist, they immediately
39927 follow. Here is an example of a three-node tree:
39928 .code
39929 YY darcy@austen.fict.example
39930 NN alice@wonderland.fict.example
39931 NN editor@thesaurus.ref.example
39932 .endd
39933 After the non-recipients tree, there is a list of the message's recipients.
39934 This is a simple list, preceded by a count. It includes all the original
39935 recipients of the message, including those to whom the message has already been
39936 delivered. In the simplest case, the list contains one address per line. For
39937 example:
39938 .code
39939 4
39940 editor@thesaurus.ref.example
39941 darcy@austen.fict.example
39942 rdo@foundation
39943 alice@wonderland.fict.example
39944 .endd
39945 However, when a child address has been added to the top-level addresses as a
39946 result of the use of the &%one_time%& option on a &(redirect)& router, each
39947 line is of the following form:
39948 .display
39949 <&'top-level address'&> <&'errors_to address'&> &&&
39950   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39951 .endd
39952 The 01 flag bit indicates the presence of the three other fields that follow
39953 the top-level address. Other bits may be used in future to support additional
39954 fields. The <&'parent number'&> is the offset in the recipients list of the
39955 original parent of the &"one time"& address. The first two fields are the
39956 envelope sender that is associated with this address and its length. If the
39957 length is zero, there is no special envelope sender (there are then two space
39958 characters in the line). A non-empty field can arise from a &(redirect)& router
39959 that has an &%errors_to%& setting.
39960
39961
39962 A blank line separates the envelope and status information from the headers
39963 which follow. A header may occupy several lines of the file, and to save effort
39964 when reading it in, each header is preceded by a number and an identifying
39965 character. The number is the number of characters in the header, including any
39966 embedded newlines and the terminating newline. The character is one of the
39967 following:
39968
39969 .table2 50pt
39970 .row <&'blank'&>         "header in which Exim has no special interest"
39971 .row &`B`&               "&'Bcc:'& header"
39972 .row &`C`&               "&'Cc:'& header"
39973 .row &`F`&               "&'From:'& header"
39974 .row &`I`&               "&'Message-id:'& header"
39975 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39976 .row &`R`&               "&'Reply-To:'& header"
39977 .row &`S`&               "&'Sender:'& header"
39978 .row &`T`&               "&'To:'& header"
39979 .row &`*`&               "replaced or deleted header"
39980 .endtable
39981
39982 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39983 purposes. They are not transmitted when the message is delivered. Here is a
39984 typical set of headers:
39985 .code
39986 111P Received: by hobbit.fict.example with local (Exim 4.00)
39987 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39988 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39989 038* X-rewrote-sender: bb@hobbit.fict.example
39990 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39991 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39992 099* To: alice@wonderland.fict.example, rdo@foundation,
39993 darcy@austen.fict.example, editor@thesaurus.ref.example
39994 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39995 darcy@austen.fict.example, editor@thesaurus.ref.example
39996 038  Date: Fri, 11 May 2001 10:28:59 +0100
39997 .endd
39998 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39999 &'To:'& header have been rewritten, the last one because routing expanded the
40000 unqualified domain &'foundation'&.
40001 .ecindex IIDforspo1
40002 .ecindex IIDforspo2
40003 .ecindex IIDforspo3
40004
40005 .section "Format of the -D file" "SECID282a"
40006 The data file is traditionally in Unix-standard format: lines are ended with
40007 an ASCII newline character.
40008 However, when the &%spool_wireformat%& main option is used some -D files
40009 can have an alternate format.
40010 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40011 The -D file lines (not including the first name-component line) are
40012 suitable for direct copying to the wire when transmitting using the
40013 ESMTP CHUNKING option, meaning lower processing overhead.
40014 Lines are terminated with an ASCII CRLF pair.
40015 There is no dot-stuffing (and no dot-termination).
40016
40017 . ////////////////////////////////////////////////////////////////////////////
40018 . ////////////////////////////////////////////////////////////////////////////
40019
40020 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40021          "DKIM, SPF and DMARC Support"
40022
40023 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40024 .cindex "DKIM"
40025
40026 DKIM is a mechanism by which messages sent by some entity can be provably
40027 linked to a domain which that entity controls.  It permits reputation to
40028 be tracked on a per-domain basis, rather than merely upon source IP address.
40029 DKIM is documented in RFC 6376.
40030
40031 As DKIM relies on the message being unchanged in transit, messages handled
40032 by a mailing-list (which traditionally adds to the message) will not match
40033 any original DKIM signature.
40034
40035 DKIM support is compiled into Exim by default if TLS support is present.
40036 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40037
40038 Exim's DKIM implementation allows for
40039 .olist
40040 Signing outgoing messages: This function is implemented in the SMTP transport.
40041 It can co-exist with all other Exim features
40042 (including transport filters)
40043 except cutthrough delivery.
40044 .next
40045 Verifying signatures in incoming messages: This is implemented by an additional
40046 ACL (acl_smtp_dkim), which can be called several times per message, with
40047 different signature contexts.
40048 .endlist
40049
40050 In typical Exim style, the verification implementation does not include any
40051 default "policy". Instead it enables you to build your own policy using
40052 Exim's standard controls.
40053
40054 Please note that verification of DKIM signatures in incoming mail is turned
40055 on by default for logging (in the <= line) purposes.
40056
40057 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40058 When set, for each signature in incoming email,
40059 exim will log a line displaying the most important signature details, and the
40060 signature status. Here is an example (with line-breaks added for clarity):
40061 .code
40062 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40063     d=facebookmail.com s=q1-2009b
40064     c=relaxed/relaxed a=rsa-sha1
40065     i=@facebookmail.com t=1252484542 [verification succeeded]
40066 .endd
40067
40068 You might want to turn off DKIM verification processing entirely for internal
40069 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40070 control modifier. This should typically be done in the RCPT ACL, at points
40071 where you accept mail from relay sources (internal hosts or authenticated
40072 senders).
40073
40074
40075 .section "Signing outgoing messages" "SECDKIMSIGN"
40076 .cindex "DKIM" "signing"
40077
40078 For signing to be usable you must have published a DKIM record in DNS.
40079 Note that RFC 8301 (which does not cover EC keys) says:
40080 .code
40081 rsa-sha1 MUST NOT be used for signing or verifying.
40082
40083 Signers MUST use RSA keys of at least 1024 bits for all keys.
40084 Signers SHOULD use RSA keys of at least 2048 bits.
40085 .endd
40086
40087 Note also that the key content (the 'p=' field)
40088 in the DNS record is different between RSA and EC keys;
40089 for the former it is the base64 of the ASN.1 for the RSA public key
40090 (equivalent to the private-key .pem with the header/trailer stripped)
40091 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40092
40093 Signing is enabled by setting private options on the SMTP transport.
40094 These options take (expandable) strings as arguments.
40095
40096 .option dkim_domain smtp string list&!! unset
40097 The domain(s) you want to sign with.
40098 After expansion, this can be a list.
40099 Each element in turn,
40100 lowercased,
40101 is put into the &%$dkim_domain%& expansion variable
40102 while expanding the remaining signing options.
40103 If it is empty after expansion, DKIM signing is not done,
40104 and no error will result even if &%dkim_strict%& is set.
40105
40106 .option dkim_selector smtp string list&!! unset
40107 This sets the key selector string.
40108 After expansion, which can use &$dkim_domain$&, this can be a list.
40109 Each element in turn is put in the expansion
40110 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40111 option along with &%$dkim_domain%&.
40112 If the option is empty after expansion, DKIM signing is not done for this domain,
40113 and no error will result even if &%dkim_strict%& is set.
40114
40115 .option dkim_private_key smtp string&!! unset
40116 This sets the private key to use.
40117 You can use the &%$dkim_domain%& and
40118 &%$dkim_selector%& expansion variables to determine the private key to use.
40119 The result can either
40120 .ilist
40121 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40122 .next
40123 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40124 be a valid Ed25519 private key (same format as above)
40125 .next
40126 start with a slash, in which case it is treated as a file that contains
40127 the private key
40128 .next
40129 be "0", "false" or the empty string, in which case the message will not
40130 be signed. This case will not result in an error, even if &%dkim_strict%&
40131 is set.
40132 .endlist
40133
40134 To generate keys under OpenSSL:
40135 .code
40136 openssl genrsa -out dkim_rsa.private 2048
40137 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40138 .endd
40139 Take the base-64 lines from the output of the second command, concatenated,
40140 for the DNS TXT record.
40141 See section 3.6 of RFC6376 for the record specification.
40142
40143 Under GnuTLS:
40144 .code
40145 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40146 certtool --load-privkey=dkim_rsa.private --pubkey-info
40147 .endd
40148
40149 Note that RFC 8301 says:
40150 .code
40151 Signers MUST use RSA keys of at least 1024 bits for all keys.
40152 Signers SHOULD use RSA keys of at least 2048 bits.
40153 .endd
40154
40155 EC keys for DKIM are defined by RFC 8463.
40156 They are considerably smaller than RSA keys for equivalent protection.
40157 As they are a recent development, users should consider dual-signing
40158 (by setting a list of selectors, and an expansion for this option)
40159 for some transition period.
40160 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40161 for EC keys.
40162
40163 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40164 .code
40165 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40166 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40167 .endd
40168
40169 To produce the required public key value for a DNS record:
40170 .code
40171 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40172 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40173 .endd
40174
40175 Exim also supports an alternate format
40176 of Ed25519 keys in DNS which was a candidate during development
40177 of the standard, but not adopted.
40178 A future release will probably drop that support.
40179
40180 .option dkim_hash smtp string&!! sha256
40181 Can be set to any one of the supported hash methods, which are:
40182 .ilist
40183 &`sha1`& &-- should not be used, is old and insecure
40184 .next
40185 &`sha256`& &-- the default
40186 .next
40187 &`sha512`& &-- possibly more secure but less well supported
40188 .endlist
40189
40190 Note that RFC 8301 says:
40191 .code
40192 rsa-sha1 MUST NOT be used for signing or verifying.
40193 .endd
40194
40195 .option dkim_identity smtp string&!! unset
40196 If set after expansion, the value is used to set an "i=" tag in
40197 the signing header.  The DKIM standards restrict the permissible
40198 syntax of this optional tag to a mail address, with possibly-empty
40199 local part, an @, and a domain identical to or subdomain of the "d="
40200 tag value.  Note that Exim does not check the value.
40201
40202 .option dkim_canon smtp string&!! unset
40203 This option sets the canonicalization method used when signing a message.
40204 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40205 The option defaults to "relaxed" when unset. Note: the current implementation
40206 only supports signing with the same canonicalization method for both headers and body.
40207
40208 .option dkim_strict smtp string&!! unset
40209 This  option  defines  how  Exim  behaves  when  signing a message that
40210 should be signed fails for some reason.  When the expansion evaluates to
40211 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40212 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40213 variables here.
40214
40215 .option dkim_sign_headers smtp string&!! "see below"
40216 If set, this option must expand to a colon-separated
40217 list of header names.
40218 Headers with these names, or the absence or such a header, will be included
40219 in the message signature.
40220 When unspecified, the header names listed in RFC4871 will be used,
40221 whether or not each header is present in the message.
40222 The default list is available for the expansion in the macro
40223 "_DKIM_SIGN_HEADERS".
40224
40225 If a name is repeated, multiple headers by that name (or the absence thereof)
40226 will be signed.  The textually later headers in the headers part of the
40227 message are signed first, if there are multiples.
40228
40229 A name can be prefixed with either an '=' or a '+' character.
40230 If an '=' prefix is used, all headers that are present with this name
40231 will be signed.
40232 If a '+' prefix if used, all headers that are present with this name
40233 will be signed, and one signature added for a missing header with the
40234 name will be appended.
40235
40236 .option dkim_timestamps smtp integer&!! unset
40237 This option controls the inclusion of timestamp information in the signature.
40238 If not set, no such information will be included.
40239 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40240 for the expiry tag
40241 (eg. 1209600 for two weeks);
40242 both creation (t=) and expiry (x=) tags will be included.
40243
40244 RFC 6376 lists these tags as RECOMMENDED.
40245
40246
40247 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40248 .cindex "DKIM" "verification"
40249
40250 Verification of DKIM signatures in SMTP incoming email is done for all
40251 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40252 .cindex DKIM "selecting signature algorithms"
40253 Individual classes of signature algorithm can be ignored by changing
40254 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40255 The &%dkim_verify_minimal%& option can be set to cease verification
40256 processing for a message once the first passing signature is found.
40257
40258 .cindex authentication "expansion item"
40259 Performing verification sets up information used by the
40260 &%authresults%& expansion item.
40261
40262 For most purposes the default option settings suffice and the remainder
40263 of this section can be ignored.
40264
40265 The results of verification are made available to the
40266 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40267 A missing ACL definition defaults to accept.
40268 By default, the ACL is called once for each
40269 syntactically(!) correct signature in the incoming message.
40270 If any ACL call does not accept, the message is not accepted.
40271 If a cutthrough delivery was in progress for the message, that is
40272 summarily dropped (having wasted the transmission effort).
40273
40274 To evaluate the verification result in the ACL
40275 a large number of expansion variables
40276 containing the signature status and its details are set up during the
40277 runtime of the ACL.
40278
40279 Calling the ACL only for existing signatures is not sufficient to build
40280 more advanced policies. For that reason, the main option
40281 &%dkim_verify_signers%&, and an expansion variable
40282 &%$dkim_signers%& exist.
40283
40284 The main option &%dkim_verify_signers%& can be set to a colon-separated
40285 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40286 called. It is expanded when the message has been received. At this point,
40287 the expansion variable &%$dkim_signers%& already contains a colon-separated
40288 list of signer domains and identities for the message. When
40289 &%dkim_verify_signers%& is not specified in the main configuration,
40290 it defaults as:
40291 .code
40292 dkim_verify_signers = $dkim_signers
40293 .endd
40294 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40295 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40296 call the ACL for known domains or identities. This would be achieved as follows:
40297 .code
40298 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40299 .endd
40300 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40301 and "ebay.com", plus all domains and identities that have signatures in the message.
40302 You can also be more creative in constructing your policy. For example:
40303 .code
40304 dkim_verify_signers = $sender_address_domain:$dkim_signers
40305 .endd
40306
40307 If a domain or identity is listed several times in the (expanded) value of
40308 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40309
40310 Note that if the option is set using untrustworthy data
40311 (such as the From: header)
40312 care should be taken to force lowercase for domains
40313 and for the domain part if identities.
40314 The default setting can be regarded as trustworthy in this respect.
40315
40316 If multiple signatures match a domain (or identity), the ACL is called once
40317 for each matching signature.
40318
40319
40320 Inside the DKIM ACL, the following expansion variables are
40321 available (from most to least important):
40322
40323
40324 .vlist
40325 .vitem &%$dkim_cur_signer%&
40326 The signer that is being evaluated in this ACL run. This can be a domain or
40327 an identity. This is one of the list items from the expanded main option
40328 &%dkim_verify_signers%& (see above).
40329
40330 .vitem &%$dkim_verify_status%&
40331 Within the DKIM ACL,
40332 a string describing the general status of the signature. One of
40333 .ilist
40334 &%none%&: There is no signature in the message for the current domain or
40335 identity (as reflected by &%$dkim_cur_signer%&).
40336 .next
40337 &%invalid%&: The signature could not be verified due to a processing error.
40338 More detail is available in &%$dkim_verify_reason%&.
40339 .next
40340 &%fail%&: Verification of the signature failed.  More detail is
40341 available in &%$dkim_verify_reason%&.
40342 .next
40343 &%pass%&: The signature passed verification. It is valid.
40344 .endlist
40345
40346 This variable can be overwritten using an ACL 'set' modifier.
40347 This might, for instance, be done to enforce a policy restriction on
40348 hash-method or key-size:
40349 .code
40350   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40351        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40352        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40353                                   {< {$dkim_key_length}{1024}}}}
40354        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40355        set dkim_verify_status = fail
40356        set dkim_verify_reason = hash too weak or key too short
40357 .endd
40358
40359 So long as a DKIM ACL is defined (it need do no more than accept),
40360 after all the DKIM ACL runs have completed, the value becomes a
40361 colon-separated list of the values after each run.
40362 This is maintained for the mime, prdr and data ACLs.
40363
40364 .vitem &%$dkim_verify_reason%&
40365 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40366 "fail" or "invalid". One of
40367 .ilist
40368 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40369 key for the domain could not be retrieved. This may be a temporary problem.
40370 .next
40371 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40372 record for the domain is syntactically invalid.
40373 .next
40374 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40375 body hash does not match the one specified in the signature header. This
40376 means that the message body was modified in transit.
40377 .next
40378 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40379 could not be verified. This may mean that headers were modified,
40380 re-written or otherwise changed in a way which is incompatible with
40381 DKIM verification. It may of course also mean that the signature is forged.
40382 .endlist
40383
40384 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40385
40386 .vitem &%$dkim_domain%&
40387 The signing domain. IMPORTANT: This variable is only populated if there is
40388 an actual signature in the message for the current domain or identity (as
40389 reflected by &%$dkim_cur_signer%&).
40390
40391 .vitem &%$dkim_identity%&
40392 The signing identity, if present. IMPORTANT: This variable is only populated
40393 if there is an actual signature in the message for the current domain or
40394 identity (as reflected by &%$dkim_cur_signer%&).
40395
40396 .vitem &%$dkim_selector%&
40397 The key record selector string.
40398
40399 .vitem &%$dkim_algo%&
40400 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40401 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40402 may also be 'ed25519-sha256'.
40403 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40404 for EC keys.
40405
40406 Note that RFC 8301 says:
40407 .code
40408 rsa-sha1 MUST NOT be used for signing or verifying.
40409
40410 DKIM signatures identified as having been signed with historic
40411 algorithms (currently, rsa-sha1) have permanently failed evaluation
40412 .endd
40413
40414 To enforce this you must either have a DKIM ACL which checks this variable
40415 and overwrites the &$dkim_verify_status$& variable as discussed above,
40416 or have set the main option &%dkim_verify_hashes%& to exclude
40417 processing of such signatures.
40418
40419 .vitem &%$dkim_canon_body%&
40420 The body canonicalization method. One of 'relaxed' or 'simple'.
40421
40422 .vitem &%$dkim_canon_headers%&
40423 The header canonicalization method. One of 'relaxed' or 'simple'.
40424
40425 .vitem &%$dkim_copiedheaders%&
40426 A transcript of headers and their values which are included in the signature
40427 (copied from the 'z=' tag of the signature).
40428 Note that RFC6376 requires that verification fail if the From: header is
40429 not included in the signature.  Exim does not enforce this; sites wishing
40430 strict enforcement should code the check explicitly.
40431
40432 .vitem &%$dkim_bodylength%&
40433 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40434 limit was set by the signer, "9999999999999" is returned. This makes sure
40435 that this variable always expands to an integer value.
40436 &*Note:*& The presence of the signature tag specifying a signing body length
40437 is one possible route to spoofing of valid DKIM signatures.
40438 A paranoid implementation might wish to regard signature where this variable
40439 shows less than the "no limit" return as being invalid.
40440
40441 .vitem &%$dkim_created%&
40442 UNIX timestamp reflecting the date and time when the signature was created.
40443 When this was not specified by the signer, "0" is returned.
40444
40445 .vitem &%$dkim_expires%&
40446 UNIX timestamp reflecting the date and time when the signer wants the
40447 signature to be treated as "expired". When this was not specified by the
40448 signer, "9999999999999" is returned. This makes it possible to do useful
40449 integer size comparisons against this value.
40450 Note that Exim does not check this value.
40451
40452 .vitem &%$dkim_headernames%&
40453 A colon-separated list of names of headers included in the signature.
40454
40455 .vitem &%$dkim_key_testing%&
40456 "1" if the key record has the "testing" flag set, "0" if not.
40457
40458 .vitem &%$dkim_key_nosubdomains%&
40459 "1" if the key record forbids subdomaining, "0" otherwise.
40460
40461 .vitem &%$dkim_key_srvtype%&
40462 Service type (tag s=) from the key record. Defaults to "*" if not specified
40463 in the key record.
40464
40465 .vitem &%$dkim_key_granularity%&
40466 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40467 in the key record.
40468
40469 .vitem &%$dkim_key_notes%&
40470 Notes from the key record (tag n=).
40471
40472 .vitem &%$dkim_key_length%&
40473 Number of bits in the key.
40474
40475 Note that RFC 8301 says:
40476 .code
40477 Verifiers MUST NOT consider signatures using RSA keys of
40478 less than 1024 bits as valid signatures.
40479 .endd
40480
40481 To enforce this you must have a DKIM ACL which checks this variable
40482 and overwrites the &$dkim_verify_status$& variable as discussed above.
40483 As EC keys are much smaller, the check should only do this for RSA keys.
40484
40485 .endlist
40486
40487 In addition, two ACL conditions are provided:
40488
40489 .vlist
40490 .vitem &%dkim_signers%&
40491 ACL condition that checks a colon-separated list of domains or identities
40492 for a match against the domain or identity that the ACL is currently verifying
40493 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40494 verb to a group of domains or identities. For example:
40495
40496 .code
40497 # Warn when Mail purportedly from GMail has no gmail signature
40498 warn log_message = GMail sender without gmail.com DKIM signature
40499      sender_domains = gmail.com
40500      dkim_signers = gmail.com
40501      dkim_status = none
40502 .endd
40503
40504 Note that the above does not check for a total lack of DKIM signing;
40505 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40506
40507 .vitem &%dkim_status%&
40508 ACL condition that checks a colon-separated list of possible DKIM verification
40509 results against the actual result of verification. This is typically used
40510 to restrict an ACL verb to a list of verification outcomes, for example:
40511
40512 .code
40513 deny message = Mail from Paypal with invalid/missing signature
40514      sender_domains = paypal.com:paypal.de
40515      dkim_signers = paypal.com:paypal.de
40516      dkim_status = none:invalid:fail
40517 .endd
40518
40519 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40520 see the documentation of the &%$dkim_verify_status%& expansion variable above
40521 for more information of what they mean.
40522 .endlist
40523
40524
40525
40526
40527 .section "SPF (Sender Policy Framework)" SECSPF
40528 .cindex SPF verification
40529
40530 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40531 messages with its domain in the envelope from, documented by RFC 7208.
40532 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40533 the &url(http://openspf.org).
40534 . --- 2019-10-28: still not https, open-spf.org is told to be a
40535 . --- web-archive copy of the now dead openspf.org site
40536 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40537 . --- discussion.
40538
40539 Messages sent by a system not authorised will fail checking of such assertions.
40540 This includes retransmissions done by traditional forwarders.
40541
40542 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40543 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40544 &url(https://www.libspf2.org/).
40545 There is no Exim involvement in the transmission of messages;
40546 publishing certain DNS records is all that is required.
40547
40548 For verification, an ACL condition and an expansion lookup are provided.
40549 .cindex authentication "expansion item"
40550 Performing verification sets up information used by the
40551 &%authresults%& expansion item.
40552
40553
40554 .cindex SPF "ACL condition"
40555 .cindex ACL "spf condition"
40556 The ACL condition "spf" can be used at or after the MAIL ACL.
40557 It takes as an argument a list of strings giving the outcome of the SPF check,
40558 and will succeed for any matching outcome.
40559 Valid strings are:
40560 .vlist
40561 .vitem &%pass%&
40562 The SPF check passed, the sending host is positively verified by SPF.
40563
40564 .vitem &%fail%&
40565 The SPF check failed, the sending host is NOT allowed to send mail for the
40566 domain in the envelope-from address.
40567
40568 .vitem &%softfail%&
40569 The SPF check failed, but the queried domain can't absolutely confirm that this
40570 is a forgery.
40571
40572 .vitem &%none%&
40573 The queried domain does not publish SPF records.
40574
40575 .vitem &%neutral%&
40576 The SPF check returned a "neutral" state.  This means the queried domain has
40577 published a SPF record, but wants to allow outside servers to send mail under
40578 its domain as well.  This should be treated like "none".
40579
40580 .vitem &%permerror%&
40581 This indicates a syntax error in the SPF record of the queried domain.
40582 You may deny messages when this occurs.
40583
40584 .vitem &%temperror%&
40585 This indicates a temporary error during all processing, including Exim's
40586 SPF processing.  You may defer messages when this occurs.
40587 .endlist
40588
40589 You can prefix each string with an exclamation mark to  invert
40590 its meaning,  for example  "!fail" will  match all  results but
40591 "fail".  The  string  list is  evaluated  left-to-right,  in a
40592 short-circuit fashion.
40593
40594 Example:
40595 .code
40596 deny spf = fail
40597      message = $sender_host_address is not allowed to send mail from \
40598                ${if def:sender_address_domain \
40599                     {$sender_address_domain}{$sender_helo_name}}.  \
40600                Please see http://www.open-spf.org/Why?scope=\
40601                ${if def:sender_address_domain {mfrom}{helo}};\
40602                identity=${if def:sender_address_domain \
40603                              {$sender_address}{$sender_helo_name}};\
40604                ip=$sender_host_address
40605 .endd
40606
40607 When the spf condition has run, it sets up several expansion
40608 variables:
40609
40610 .cindex SPF "verification variables"
40611 .vlist
40612 .vitem &$spf_header_comment$&
40613 .vindex &$spf_header_comment$&
40614   This contains a human-readable string describing the outcome
40615   of the SPF check. You can add it to a custom header or use
40616   it for logging purposes.
40617
40618 .vitem &$spf_received$&
40619 .vindex &$spf_received$&
40620   This contains a complete Received-SPF: header that can be
40621   added to the message. Please note that according to the SPF
40622   draft, this header must be added at the top of the header
40623   list. Please see section 10 on how you can do this.
40624
40625   Note: in case of "Best-guess" (see below), the convention is
40626   to put this string in a header called X-SPF-Guess: instead.
40627
40628 .vitem &$spf_result$&
40629 .vindex &$spf_result$&
40630   This contains the outcome of the SPF check in string form,
40631   one of pass, fail, softfail, none, neutral, permerror or
40632   temperror.
40633
40634 .vitem &$spf_result_guessed$&
40635 .vindex &$spf_result_guessed$&
40636   This boolean is true only if a best-guess operation was used
40637   and required in order to obtain a result.
40638
40639 .vitem &$spf_smtp_comment$&
40640 .vindex &$spf_smtp_comment$&
40641   This contains a string that can be used in a SMTP response
40642   to the calling party. Useful for "fail".
40643 .endlist
40644
40645
40646 .cindex SPF "ACL condition"
40647 .cindex ACL "spf_guess condition"
40648 .cindex SPF "best guess"
40649 In addition to SPF, you can also perform checks for so-called
40650 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40651 SPF, but it is supported by the same framework that enables SPF
40652 capability.
40653 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40654 for a description of what it means.
40655 . --- 2019-10-28: still not https:
40656
40657 To access this feature, simply use the spf_guess condition in place
40658 of the spf one.  For example:
40659
40660 .code
40661 deny spf_guess = fail
40662      message = $sender_host_address doesn't look trustworthy to me
40663 .endd
40664
40665 In case you decide to reject messages based on this check, you
40666 should note that although it uses the same framework, "Best-guess"
40667 is not SPF, and therefore you should not mention SPF at all in your
40668 reject message.
40669
40670 When the spf_guess condition has run, it sets up the same expansion
40671 variables as when spf condition is run, described above.
40672
40673 Additionally, since Best-guess is not standardized, you may redefine
40674 what "Best-guess" means to you by redefining the main configuration
40675 &%spf_guess%& option.
40676 For example, the following:
40677
40678 .code
40679 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40680 .endd
40681
40682 would relax host matching rules to a broader network range.
40683
40684
40685 .cindex SPF "lookup expansion"
40686 .cindex lookup spf
40687 A lookup expansion is also available. It takes an email
40688 address as the key and an IP address
40689 (v4 or v6)
40690 as the database:
40691
40692 .code
40693   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40694 .endd
40695
40696 The lookup will return the same result strings as can appear in
40697 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40698
40699
40700
40701
40702
40703 .section DMARC SECDMARC
40704 .cindex DMARC verification
40705
40706 DMARC combines feedback from SPF, DKIM, and header From: in order
40707 to attempt to provide better indicators of the authenticity of an
40708 email.  This document does not explain the fundamentals; you
40709 should read and understand how it works by visiting the website at
40710 &url(http://www.dmarc.org/).
40711
40712 If Exim is built with DMARC support,
40713 the libopendmarc library is used.
40714
40715 For building Exim yourself, obtain the library from
40716 &url(http://sourceforge.net/projects/opendmarc/)
40717 to obtain a copy, or find it in your favorite package
40718 repository.  You will need to attend to the local/Makefile feature
40719 SUPPORT_DMARC and the associated LDFLAGS addition.
40720 This description assumes
40721 that headers will be in /usr/local/include, and that the libraries
40722 are in /usr/local/lib.
40723
40724 . subsection
40725
40726 There are three main-configuration options:
40727 .cindex DMARC "configuration options"
40728
40729 The &%dmarc_tld_file%& option
40730 .oindex &%dmarc_tld_file%&
40731 defines the location of a text file of valid
40732 top level domains the opendmarc library uses
40733 during domain parsing. Maintained by Mozilla,
40734 the most current version can be downloaded
40735 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
40736 See also the util/renew-opendmarc-tlds.sh script.
40737 .new
40738 The default for the option is unset.
40739 If not set, DMARC processing is disabled.
40740 .wen
40741
40742
40743 The &%dmarc_history_file%& option, if set
40744 .oindex &%dmarc_history_file%&
40745 defines the location of a file to log results
40746 of dmarc verification on inbound emails. The
40747 contents are importable by the opendmarc tools
40748 which will manage the data, send out DMARC
40749 reports, and expire the data. Make sure the
40750 directory of this file is writable by the user
40751 exim runs as.
40752 The default is unset.
40753
40754 The &%dmarc_forensic_sender%& option
40755 .oindex &%dmarc_forensic_sender%&
40756 defines an alternate email address to use when sending a
40757 forensic report detailing alignment failures
40758 if a sender domain's dmarc record specifies it
40759 and you have configured Exim to send them.
40760 If set, this is expanded and used for the
40761 From: header line; the address is extracted
40762 from it and used for the envelope from.
40763 If not set (the default), the From: header is expanded from
40764 the dsn_from option, and <> is used for the
40765 envelope from.
40766
40767 . I wish we had subsections...
40768
40769 .cindex DMARC controls
40770 By default, the DMARC processing will run for any remote,
40771 non-authenticated user.  It makes sense to only verify DMARC
40772 status of messages coming from remote, untrusted sources.  You can
40773 use standard conditions such as hosts, senders, etc, to decide that
40774 DMARC verification should *not* be performed for them and disable
40775 DMARC with an ACL control modifier:
40776 .code
40777   control = dmarc_disable_verify
40778 .endd
40779 A DMARC record can also specify a "forensic address", which gives
40780 exim an email address to submit reports about failed alignment.
40781 Exim does not do this by default because in certain conditions it
40782 results in unintended information leakage (what lists a user might
40783 be subscribed to, etc).  You must configure exim to submit forensic
40784 reports to the owner of the domain.  If the DMARC record contains a
40785 forensic address and you specify the control statement below, then
40786 exim will send these forensic emails.  It is also advised that you
40787 configure a &%dmarc_forensic_sender%& because the default sender address
40788 construction might be inadequate.
40789 .code
40790   control = dmarc_enable_forensic
40791 .endd
40792 (AGAIN: You can choose not to send these forensic reports by simply
40793 not putting the dmarc_enable_forensic control line at any point in
40794 your exim config.  If you don't tell exim to send them, it will not
40795 send them.)
40796
40797 There are no options to either control.  Both must appear before
40798 the DATA acl.
40799
40800 . subsection
40801
40802 DMARC checks cam be run on incoming SMTP  messages by using the
40803 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
40804 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
40805 condition.  Putting this condition in the ACLs is required in order
40806 for a DMARC check to actually occur.  All of the variables are set
40807 up before the DATA ACL, but there is no actual DMARC check that
40808 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
40809
40810 The &"dmarc_status"& condition takes a list of strings on its
40811 right-hand side.  These strings describe recommended action based
40812 on the DMARC check.  To understand what the policy recommendations
40813 mean, refer to the DMARC website above.  Valid strings are:
40814 .display
40815 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40816 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40817 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40818 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40819 &'norecord    '& No policy section in the DMARC record for this sender domain.
40820 &'nofrom      '& Unable to determine the domain of the sender.
40821 &'temperror   '& Library error or dns error.
40822 &'off         '& The DMARC check was disabled for this email.
40823 .endd
40824 You can prefix each string with an exclamation mark to invert its
40825 meaning, for example "!accept" will match all results but
40826 "accept".  The string list is evaluated left-to-right in a
40827 short-circuit fashion.  When a string matches the outcome of the
40828 DMARC check, the condition succeeds.  If none of the listed
40829 strings matches the outcome of the DMARC check, the condition
40830 fails.
40831
40832 Of course, you can also use any other lookup method that Exim
40833 supports, including LDAP, Postgres, MySQL, etc, as long as the
40834 result is a list of colon-separated strings.
40835
40836 Performing the check sets up information used by the
40837 &%authresults%& expansion item.
40838
40839 Several expansion variables are set before the DATA ACL is
40840 processed, and you can use them in this ACL.  The following
40841 expansion variables are available:
40842
40843 .vlist
40844 .vitem &$dmarc_status$&
40845 .vindex &$dmarc_status$&
40846 .cindex DMARC result
40847 A one word status indicating what the DMARC library
40848 thinks of the email.  It is a combination of the results of
40849 DMARC record lookup and the SPF/DKIM/DMARC processing results
40850 (if a DMARC record was found).  The actual policy declared
40851 in the DMARC record is in a separate expansion variable.
40852
40853 .vitem &$dmarc_status_text$&
40854 .vindex &$dmarc_status_text$&
40855 Slightly longer, human readable status.
40856
40857 .vitem &$dmarc_used_domain$&
40858 .vindex &$dmarc_used_domain$&
40859 The domain which DMARC used to look up the DMARC policy record.
40860
40861 .vitem &$dmarc_domain_policy$&
40862 .vindex &$dmarc_domain_policy$&
40863 The policy declared in the DMARC record.  Valid values
40864 are "none", "reject" and "quarantine".  It is blank when there
40865 is any error, including no DMARC record.
40866 .endlist
40867
40868 . subsection
40869
40870 By default, Exim's DMARC configuration is intended to be
40871 non-intrusive and conservative.  To facilitate this, Exim will not
40872 create any type of logging files without explicit configuration by
40873 you, the admin.  Nor will Exim send out any emails/reports about
40874 DMARC issues without explicit configuration by you, the admin (other
40875 than typical bounce messages that may come about due to ACL
40876 processing or failure delivery issues).
40877
40878 In order to log statistics suitable to be imported by the opendmarc
40879 tools, you need to:
40880 .ilist
40881 Configure the global option &%dmarc_history_file%&
40882 .next
40883 Configure cron jobs to call the appropriate opendmarc history
40884 import scripts and truncating the dmarc_history_file
40885 .endlist
40886
40887 In order to send forensic reports, you need to:
40888 .ilist
40889 Configure the global option &%dmarc_forensic_sender%&
40890 .next
40891 Configure, somewhere before the DATA ACL, the control option to
40892 enable sending DMARC forensic reports
40893 .endlist
40894
40895 . subsection
40896
40897 Example usage:
40898 .code
40899 (RCPT ACL)
40900   warn    domains        = +local_domains
40901           hosts          = +local_hosts
40902           control        = dmarc_disable_verify
40903
40904   warn    !domains       = +screwed_up_dmarc_records
40905           control        = dmarc_enable_forensic
40906
40907   warn    condition      = (lookup if destined to mailing list)
40908           set acl_m_mailing_list = 1
40909
40910 (DATA ACL)
40911   warn    dmarc_status   = accept : none : off
40912           !authenticated = *
40913           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40914
40915   warn    dmarc_status   = !accept
40916           !authenticated = *
40917           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40918
40919   warn    dmarc_status   = quarantine
40920           !authenticated = *
40921           set $acl_m_quarantine = 1
40922           # Do something in a transport with this flag variable
40923
40924   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40925           condition      = ${if eq{$acl_m_mailing_list}{1}}
40926           message        = Messages from $dmarc_used_domain break mailing lists
40927
40928   deny    dmarc_status   = reject
40929           !authenticated = *
40930           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40931
40932   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40933 .endd
40934
40935
40936
40937
40938
40939 . ////////////////////////////////////////////////////////////////////////////
40940 . ////////////////////////////////////////////////////////////////////////////
40941
40942 .chapter "Proxies" "CHAPproxies" &&&
40943          "Proxy support"
40944 .cindex "proxy support"
40945 .cindex "proxy" "access via"
40946
40947 A proxy is an intermediate system through which communication is passed.
40948 Proxies may provide a security, availability or load-distribution function.
40949
40950
40951 .section "Inbound proxies" SECTproxyInbound
40952 .cindex proxy inbound
40953 .cindex proxy "server side"
40954 .cindex proxy "Proxy protocol"
40955 .cindex "Proxy protocol" proxy
40956
40957 Exim has support for receiving inbound SMTP connections via a proxy
40958 that uses &"Proxy Protocol"& to speak to it.
40959 To include this support, include &"SUPPORT_PROXY=yes"&
40960 in Local/Makefile.
40961
40962 It was built on the HAProxy specification, found at
40963 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40964
40965 The purpose of this facility is so that an application load balancer,
40966 such as HAProxy, can sit in front of several Exim servers
40967 to distribute load.
40968 Exim uses the local protocol communication with the proxy to obtain
40969 the remote SMTP system IP address and port information.
40970 There is no logging if a host passes or
40971 fails Proxy Protocol negotiation, but it can easily be determined and
40972 recorded in an ACL (example is below).
40973
40974 Use of a proxy is enabled by setting the &%hosts_proxy%&
40975 main configuration option to a hostlist; connections from these
40976 hosts will use Proxy Protocol.
40977 Exim supports both version 1 and version 2 of the Proxy Protocol and
40978 automatically determines which version is in use.
40979
40980 The Proxy Protocol header is the first data received on a TCP connection
40981 and is inserted before any TLS-on-connect handshake from the client; Exim
40982 negotiates TLS between Exim-as-server and the remote client, not between
40983 Exim and the proxy server.
40984
40985 The following expansion variables are usable
40986 (&"internal"& and &"external"& here refer to the interfaces
40987 of the proxy):
40988 .display
40989 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40990 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40991 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40992 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40993 &'proxy_session            '& boolean: SMTP connection via proxy
40994 .endd
40995 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40996 there was a protocol error.
40997 The variables &$sender_host_address$& and &$sender_host_port$&
40998 will have values for the actual client system, not the proxy.
40999
41000 Since the real connections are all coming from the proxy, and the
41001 per host connection tracking is done before Proxy Protocol is
41002 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41003 handle all of the parallel volume you expect per inbound proxy.
41004 With the option set so high, you lose the ability
41005 to protect your server from many connections from one IP.
41006 In order to prevent your server from overload, you
41007 need to add a per connection ratelimit to your connect ACL.
41008 A possible solution is:
41009 .display
41010   # Set max number of connections per host
41011   LIMIT   = 5
41012   # Or do some kind of IP lookup in a flat file or database
41013   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41014
41015   defer   message        = Too many connections from this IP right now
41016           ratelimit      = LIMIT / 5s / per_conn / strict
41017 .endd
41018
41019
41020
41021 .section "Outbound proxies" SECTproxySOCKS
41022 .cindex proxy outbound
41023 .cindex proxy "client side"
41024 .cindex proxy SOCKS
41025 .cindex SOCKS proxy
41026 Exim has support for sending outbound SMTP via a proxy
41027 using a protocol called SOCKS5 (defined by RFC1928).
41028 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41029 Local/Makefile.
41030
41031 Use of a proxy is enabled by setting the &%socks_proxy%& option
41032 on an smtp transport.
41033 The option value is expanded and should then be a list
41034 (colon-separated by default) of proxy specifiers.
41035 Each proxy specifier is a list
41036 (space-separated by default) where the initial element
41037 is an IP address and any subsequent elements are options.
41038
41039 Options are a string <name>=<value>.
41040 The list of options is in the following table:
41041 .display
41042 &'auth   '& authentication method
41043 &'name   '& authentication username
41044 &'pass   '& authentication password
41045 &'port   '& tcp port
41046 &'tmo    '& connection timeout
41047 &'pri    '& priority
41048 &'weight '& selection bias
41049 .endd
41050
41051 More details on each of these options follows:
41052
41053 .ilist
41054 .cindex authentication "to proxy"
41055 .cindex proxy authentication
41056 &%auth%&: Either &"none"& (default) or &"name"&.
41057 Using &"name"& selects username/password authentication per RFC 1929
41058 for access to the proxy.
41059 Default is &"none"&.
41060 .next
41061 &%name%&: sets the username for the &"name"& authentication method.
41062 Default is empty.
41063 .next
41064 &%pass%&: sets the password for the &"name"& authentication method.
41065 Default is empty.
41066 .next
41067 &%port%&: the TCP port number to use for the connection to the proxy.
41068 Default is 1080.
41069 .next
41070 &%tmo%&: sets a connection timeout in seconds for this proxy.
41071 Default is 5.
41072 .next
41073 &%pri%&: specifies a priority for the proxy within the list,
41074 higher values being tried first.
41075 The default priority is 1.
41076 .next
41077 &%weight%&: specifies a selection bias.
41078 Within a priority set servers are queried in a random fashion,
41079 weighted by this value.
41080 The default value for selection bias is 1.
41081 .endlist
41082
41083 Proxies from the list are tried according to their priority
41084 and weight settings until one responds.  The timeout for the
41085 overall connection applies to the set of proxied attempts.
41086
41087 .section Logging SECTproxyLog
41088 To log the (local) IP of a proxy in the incoming or delivery logline,
41089 add &"+proxy"& to the &%log_selector%& option.
41090 This will add a component tagged with &"PRX="& to the line.
41091
41092 . ////////////////////////////////////////////////////////////////////////////
41093 . ////////////////////////////////////////////////////////////////////////////
41094
41095 .chapter "Internationalisation" "CHAPi18n" &&&
41096          "Internationalisation""
41097 .cindex internationalisation "email address"
41098 .cindex EAI
41099 .cindex i18n
41100 .cindex utf8 "mail name handling"
41101
41102 Exim has support for Internationalised mail names.
41103 To include this it must be built with SUPPORT_I18N and the libidn library.
41104 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41105
41106 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41107 instead of it) then IDNA2008 is supported; this adds an extra library
41108 requirement, upon libidn2.
41109
41110 .section "MTA operations" SECTi18nMTA
41111 .cindex SMTPUTF8 "ESMTP option"
41112 The main configuration option &%smtputf8_advertise_hosts%& specifies
41113 a host list.  If this matches the sending host and
41114 accept_8bitmime is true (the default) then the ESMTP option
41115 SMTPUTF8 will be advertised.
41116
41117 If the sender specifies the SMTPUTF8 option on a MAIL command
41118 international handling for the message is enabled and
41119 the expansion variable &$message_smtputf8$& will have value TRUE.
41120
41121 The option &%allow_utf8_domains%& is set to true for this
41122 message. All DNS lookups are converted to a-label form
41123 whatever the setting of &%allow_utf8_domains%&
41124 when Exim is built with SUPPORT_I18N.
41125
41126 Both localparts and domain are maintained as the original
41127 UTF-8 form internally; any comparison or regular-expression use will
41128 require appropriate care.  Filenames created, eg. by
41129 the appendfile transport, will have UTF-8 names.
41130
41131 HELO names sent by the smtp transport will have any UTF-8
41132 components expanded to a-label form,
41133 and any certificate name checks will be done using the a-label
41134 form of the name.
41135
41136 .cindex log protocol
41137 .cindex SMTPUTF8 logging
41138 .cindex i18n logging
41139 Log lines and Received-by: header lines will acquire a "utf8"
41140 prefix on the protocol element, eg. utf8esmtp.
41141
41142 The following expansion operators can be used:
41143 .code
41144 ${utf8_domain_to_alabel:str}
41145 ${utf8_domain_from_alabel:str}
41146 ${utf8_localpart_to_alabel:str}
41147 ${utf8_localpart_from_alabel:str}
41148 .endd
41149
41150 .cindex utf8 "address downconversion"
41151 .cindex i18n "utf8 address downconversion"
41152 The RCPT ACL
41153 may use the following modifier:
41154 .display
41155 control = utf8_downconvert
41156 control = utf8_downconvert/<value>
41157 .endd
41158 This sets a flag requiring that addresses are converted to
41159 a-label form before smtp delivery, for use in a
41160 Message Submission Agent context.
41161 If a value is appended it may be:
41162 .display
41163 &`1  `& (default) mandatory downconversion
41164 &`0  `& no downconversion
41165 &`-1 `& if SMTPUTF8 not supported by destination host
41166 .endd
41167
41168 If mua_wrapper is set, the utf8_downconvert control
41169 is initially set to -1.
41170
41171 The smtp transport has an option &%utf8_downconvert%&.
41172 If set it must expand to one of the three values described above,
41173 and it overrides any previously set value.
41174
41175
41176 There is no explicit support for VRFY and EXPN.
41177 Configurations supporting these should inspect
41178 &$smtp_command_argument$& for an SMTPUTF8 argument.
41179
41180 There is no support for LMTP on Unix sockets.
41181 Using the "lmtp" protocol option on an smtp transport,
41182 for LMTP over TCP, should work as expected.
41183
41184 There is no support for DSN unitext handling,
41185 and no provision for converting logging from or to UTF-8.
41186
41187
41188
41189 .section "MDA operations" SECTi18nMDA
41190 To aid in constructing names suitable for IMAP folders
41191 the following expansion operator can be used:
41192 .code
41193 ${imapfolder {<string>} {<sep>} {<specials>}}
41194 .endd
41195
41196 The string is converted from the charset specified by
41197 the "headers charset" command (in a filter file)
41198 or &%headers_charset%& main configuration option (otherwise),
41199 to the
41200 modified UTF-7 encoding specified by RFC 2060,
41201 with the following exception: All occurrences of <sep>
41202 (which has to be a single character)
41203 are replaced with periods ("."), and all periods and slashes that are not
41204 <sep> and are not in the <specials> string are BASE64 encoded.
41205
41206 The third argument can be omitted, defaulting to an empty string.
41207 The second argument can be omitted, defaulting to "/".
41208
41209 This is the encoding used by Courier for Maildir names on disk, and followed
41210 by many other IMAP servers.
41211
41212 Examples:
41213 .display
41214 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41215 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41216 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41217 .endd
41218
41219 Note that the source charset setting is vital, and also that characters
41220 must be representable in UTF-16.
41221
41222
41223 . ////////////////////////////////////////////////////////////////////////////
41224 . ////////////////////////////////////////////////////////////////////////////
41225
41226 .chapter "Events" "CHAPevents" &&&
41227          "Events"
41228 .cindex events
41229
41230 The events mechanism in Exim can be used to intercept processing at a number
41231 of points.  It was originally invented to give a way to do customised logging
41232 actions (for example, to a database) but can also be used to modify some
41233 processing actions.
41234
41235 Most installations will never need to use Events.
41236 The support can be left out of a build by defining DISABLE_EVENT=yes
41237 in &_Local/Makefile_&.
41238
41239 There are two major classes of events: main and transport.
41240 The main configuration option &%event_action%& controls reception events;
41241 a transport option &%event_action%& controls delivery events.
41242
41243 Both options are a string which is expanded when the event fires.
41244 An example might look like:
41245 .cindex logging custom
41246 .code
41247 event_action = ${if eq {msg:delivery}{$event_name} \
41248 {${lookup pgsql {SELECT * FROM record_Delivery( \
41249     '${quote_pgsql:$sender_address_domain}',\
41250     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41251     '${quote_pgsql:$domain}', \
41252     '${quote_pgsql:${lc:$local_part}}', \
41253     '${quote_pgsql:$host_address}', \
41254     '${quote_pgsql:${lc:$host}}', \
41255     '${quote_pgsql:$message_exim_id}')}} \
41256 } {}}
41257 .endd
41258
41259 Events have names which correspond to the point in process at which they fire.
41260 The name is placed in the variable &$event_name$& and the event action
41261 expansion must check this, as it will be called for every possible event type.
41262
41263 .new
41264 The current list of events is:
41265 .wen
41266 .display
41267 &`dane:fail              after    transport  `& per connection
41268 &`msg:complete           after    main       `& per message
41269 &`msg:defer              after    transport  `& per message per delivery try
41270 &`msg:delivery           after    transport  `& per recipient
41271 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41272 &`msg:rcpt:defer         after    transport  `& per recipient
41273 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41274 &`msg:fail:delivery      after    transport  `& per recipient
41275 &`msg:fail:internal      after    main       `& per recipient
41276 &`tcp:connect            before   transport  `& per connection
41277 &`tcp:close              after    transport  `& per connection
41278 &`tls:cert               before   both       `& per certificate in verification chain
41279 &`smtp:connect           after    transport  `& per connection
41280 &`smtp:ehlo              after    transport  `& per connection
41281 .endd
41282 New event types may be added in future.
41283
41284 The event name is a colon-separated list, defining the type of
41285 event in a tree of possibilities.  It may be used as a list
41286 or just matched on as a whole.  There will be no spaces in the name.
41287
41288 The second column in the table above describes whether the event fires
41289 before or after the action is associates with.  Those which fire before
41290 can be used to affect that action (more on this below).
41291
41292 The third column in the table above says what section of the configuration
41293 should define the event action.
41294
41295 An additional variable, &$event_data$&, is filled with information varying
41296 with the event type:
41297 .display
41298 &`dane:fail            `& failure reason
41299 &`msg:defer            `& error string
41300 &`msg:delivery         `& smtp confirmation message
41301 &`msg:fail:internal    `& failure reason
41302 &`msg:fail:delivery    `& smtp error message
41303 &`msg:host:defer       `& error string
41304 &`msg:rcpt:host:defer  `& error string
41305 &`msg:rcpt:defer       `& error string
41306 &`tls:cert             `& verification chain depth
41307 &`smtp:connect         `& smtp banner
41308 &`smtp:ehlo            `& smtp ehlo response
41309 .endd
41310
41311 The :defer events populate one extra variable: &$event_defer_errno$&.
41312
41313 For complex operations an ACL expansion can be used in &%event_action%&
41314 however due to the multiple contexts that Exim operates in during
41315 the course of its processing:
41316 .ilist
41317 variables set in transport events will not be visible outside that
41318 transport call
41319 .next
41320 acl_m variables in a server context are lost on a new connection,
41321 and after smtp helo/ehlo/mail/starttls/rset commands
41322 .endlist
41323 Using an ACL expansion with the logwrite modifier can be
41324 a useful way of writing to the main log.
41325
41326 The expansion of the event_action option should normally
41327 return an empty string.  Should it return anything else the
41328 following will be forced:
41329 .display
41330 &`tcp:connect      `&  do not connect
41331 &`tls:cert         `&  refuse verification
41332 &`smtp:connect     `&  close connection
41333 .endd
41334 All other message types ignore the result string, and
41335 no other use is made of it.
41336
41337 For a tcp:connect event, if the connection is being made to a proxy
41338 then the address and port variables will be that of the proxy and not
41339 the target system.
41340
41341 For tls:cert events, if GnuTLS is in use this will trigger only per
41342 chain element received on the connection.
41343 For OpenSSL it will trigger for every chain element including those
41344 loaded locally.
41345
41346 . ////////////////////////////////////////////////////////////////////////////
41347 . ////////////////////////////////////////////////////////////////////////////
41348
41349 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41350          "Adding drivers or lookups"
41351 .cindex "adding drivers"
41352 .cindex "new drivers, adding"
41353 .cindex "drivers" "adding new"
41354 The following actions have to be taken in order to add a new router, transport,
41355 authenticator, or lookup type to Exim:
41356
41357 .olist
41358 Choose a name for the driver or lookup type that does not conflict with any
41359 existing name; I will use &"newdriver"& in what follows.
41360 .next
41361 Add to &_src/EDITME_& the line:
41362 .display
41363 <&'type'&>&`_NEWDRIVER=yes`&
41364 .endd
41365 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41366 code is not to be included in the binary by default, comment this line out. You
41367 should also add any relevant comments about the driver or lookup type.
41368 .next
41369 Add to &_src/config.h.defaults_& the line:
41370 .code
41371 #define <type>_NEWDRIVER
41372 .endd
41373 .next
41374 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41375 and create a table entry as is done for all the other drivers and lookup types.
41376 .next
41377 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41378 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41379 Add your &`NEWDRIVER`& to that list.
41380 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41381 simple form that most lookups have.
41382 .next
41383 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41384 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41385 driver or lookup type and add it to the definition of OBJ.
41386 .next
41387 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41388 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41389 .next
41390 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41391 &_src_&.
41392 .next
41393 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41394 as for other drivers and lookups.
41395 .endlist
41396
41397 Then all you need to do is write the code! A good way to start is to make a
41398 proforma by copying an existing module of the same type, globally changing all
41399 occurrences of the name, and cutting out most of the code. Note that any
41400 options you create must be listed in alphabetical order, because the tables are
41401 searched using a binary chop procedure.
41402
41403 There is a &_README_& file in each of the sub-directories of &_src_& describing
41404 the interface that is expected.
41405
41406
41407
41408
41409 . ////////////////////////////////////////////////////////////////////////////
41410 . ////////////////////////////////////////////////////////////////////////////
41411
41412 . /////////////////////////////////////////////////////////////////////////////
41413 . These lines are processing instructions for the Simple DocBook Processor that
41414 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41415 . PDFs than using xmlto and fop. They will be ignored by all other XML
41416 . processors.
41417 . /////////////////////////////////////////////////////////////////////////////
41418
41419 .literal xml
41420 <?sdop
41421   format="newpage"
41422   foot_right_recto="&chaptertitle;"
41423   foot_right_verso="&chaptertitle;"
41424 ?>
41425 .literal off
41426
41427 .makeindex "Options index"   "option"
41428 .makeindex "Variables index" "variable"
41429 .makeindex "Concept index"   "concept"
41430
41431
41432 . /////////////////////////////////////////////////////////////////////////////
41433 . /////////////////////////////////////////////////////////////////////////////