Docs: Remove dnssec_request_domains = *
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.92"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018
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 .cindex "documentation"
375 This edition of the Exim specification applies to version &version() of Exim.
376 Substantive changes from the &previousversion; edition are marked in some
377 renditions of this document; this paragraph is so marked if the rendition is
378 capable of showing a change indicator.
379
380 This document is very much a reference manual; it is not a tutorial. The reader
381 is expected to have some familiarity with the SMTP mail transfer protocol and
382 with general Unix system administration. Although there are some discussions
383 and examples in places, the information is mostly organized in a way that makes
384 it easy to look up, rather than in a natural order for sequential reading.
385 Furthermore, this manual aims to cover every aspect of Exim in detail, including
386 a number of rarely-used, special-purpose features that are unlikely to be of
387 very wide interest.
388
389 .cindex "books about Exim"
390 An &"easier"& discussion of Exim which provides more in-depth explanatory,
391 introductory, and tutorial material can be found in a book entitled &'The Exim
392 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
393 (&url(https://www.uit.co.uk/exim-book/)).
394
395 The book also contains a chapter that gives a general introduction to SMTP and
396 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
397 with the latest release of Exim. (Note that the earlier book about Exim,
398 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
399
400 .cindex "Debian" "information sources"
401 If you are using a Debian distribution of Exim, you will find information about
402 Debian-specific features in the file
403 &_/usr/share/doc/exim4-base/README.Debian_&.
404 The command &(man update-exim.conf)& is another source of Debian-specific
405 information.
406
407 .cindex "&_doc/NewStuff_&"
408 .cindex "&_doc/ChangeLog_&"
409 .cindex "change log"
410 As Exim develops, there may be features in newer versions that have not
411 yet made it into this document, which is updated only when the most significant
412 digit of the fractional part of the version number changes. Specifications of
413 new features that are not yet in this manual are placed in the file
414 &_doc/NewStuff_& in the Exim distribution.
415
416 Some features may be classified as &"experimental"&. These may change
417 incompatibly while they are developing, or even be withdrawn. For this reason,
418 they are not documented in this manual. Information about experimental features
419 can be found in the file &_doc/experimental.txt_&.
420
421 All changes to Exim (whether new features, bug fixes, or other kinds of
422 change) are noted briefly in the file called &_doc/ChangeLog_&.
423
424 .cindex "&_doc/spec.txt_&"
425 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
426 that it can easily be searched with a text editor. Other files in the &_doc_&
427 directory are:
428
429 .table2 100pt
430 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
431 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
432 .row &_exim.8_&              "a man page of Exim's command line options"
433 .row &_experimental.txt_&    "documentation of experimental features"
434 .row &_filter.txt_&          "specification of the filter language"
435 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
436 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
437 .row &_openssl.txt_&         "installing a current OpenSSL release"
438 .endtable
439
440 The main specification and the specification of the filtering language are also
441 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
442 &<<SECTavail>>& below tells you how to get hold of these.
443
444
445
446 .section "FTP site and websites" "SECID2"
447 .cindex "website"
448 .cindex "FTP site"
449 The primary site for Exim source distributions is the &%exim.org%& FTP site,
450 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
451 website, are hosted at the University of Cambridge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim website contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(https://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460 The wiki site should always redirect to the correct place, which is currently
461 provided by GitHub, and is open to editing by anyone with a GitHub account.
462
463 .cindex Bugzilla
464 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
465 this to report bugs, and also to add items to the wish list. Please search
466 first to check that you are not duplicating a previous entry.
467 Please do not ask for configuration help in the bug-tracker.
468
469
470 .section "Mailing lists" "SECID3"
471 .cindex "mailing lists" "for Exim users"
472 The following Exim mailing lists exist:
473
474 .table2 140pt
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-users@exim.org'&      "General discussion list"
477 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
478 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
479 .endtable
480
481 You can subscribe to these lists, change your existing subscriptions, and view
482 or search the archives via the mailing lists link on the Exim home page.
483 .cindex "Debian" "mailing list for"
484 If you are using a Debian distribution of Exim, you may wish to subscribe to
485 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
486 via this web page:
487 .display
488 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
489 .endd
490 Please ask Debian-specific questions on that list and not on the general Exim
491 lists.
492
493 .section "Bug reports" "SECID5"
494 .cindex "bug reports"
495 .cindex "reporting bugs"
496 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
497 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
498 whether some behaviour is a bug or not, the best thing to do is to post a
499 message to the &'exim-dev'& mailing list and have it discussed.
500
501
502
503 .section "Where to find the Exim distribution" "SECTavail"
504 .cindex "FTP site"
505 .cindex "HTTPS download site"
506 .cindex "distribution" "FTP site"
507 .cindex "distribution" "https site"
508 The master distribution site for the Exim distribution is
509 .display
510 &url(https://downloads.exim.org/)
511 .endd
512 The service is available over HTTPS, HTTP and FTP.
513 We encourage people to migrate to HTTPS.
514
515 The content served at &url(https://downloads.exim.org/) is identical to the
516 content served at &url(https://ftp.exim.org/pub/exim) and
517 &url(ftp://ftp.exim.org/pub/exim).
518
519 If accessing via a hostname containing &'ftp'&, then the file references that
520 follow are relative to the &_exim_& directories at these sites.
521 If accessing via the hostname &'downloads'& then the subdirectories described
522 here are top-level directories.
523
524 There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the top exim directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.xz_&
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The three
537 files contain identical data; the only difference is the type of compression.
538 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
539 most portable to old systems.
540
541 .cindex "distribution" "signing details"
542 .cindex "distribution" "public key"
543 .cindex "public key for signed distribution"
544 The distributions will be PGP signed by an individual key of the Release
545 Coordinator.  This key will have a uid containing an email address in the
546 &'exim.org'& domain and will have signatures from other people, including
547 other Exim maintainers.  We expect that the key will be in the "strong set" of
548 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
549 PGP keys, a version of which can be found in the release directory in the file
550 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
551 such as &'pool.sks-keyservers.net'&.
552
553 At the time of the last update, releases were being made by Jeremy Harris and signed
554 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
555 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
556 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
557
558 The signatures for the tar bundles are in:
559 .display
560 &_exim-n.nn.tar.xz.asc_&
561 &_exim-n.nn.tar.gz.asc_&
562 &_exim-n.nn.tar.bz2.asc_&
563 .endd
564 For each released version, the log of changes is made available in a
565 separate file in the directory &_ChangeLogs_& so that it is possible to
566 find out what has changed without having to download the entire distribution.
567
568 .cindex "documentation" "available formats"
569 The main distribution contains ASCII versions of this specification and other
570 documentation; other formats of the documents are available in separate files
571 inside the &_exim4_& directory of the FTP site:
572 .display
573 &_exim-html-n.nn.tar.gz_&
574 &_exim-pdf-n.nn.tar.gz_&
575 &_exim-postscript-n.nn.tar.gz_&
576 &_exim-texinfo-n.nn.tar.gz_&
577 .endd
578 These tar files contain only the &_doc_& directory, not the complete
579 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
580
581
582 .section "Limitations" "SECID6"
583 .ilist
584 .cindex "limitations of Exim"
585 .cindex "bang paths" "not handled by Exim"
586 Exim is designed for use as an Internet MTA, and therefore handles addresses in
587 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
588 simple two-component bang paths can be converted by a straightforward rewriting
589 configuration. This restriction does not prevent Exim from being interfaced to
590 UUCP as a transport mechanism, provided that domain addresses are used.
591 .next
592 .cindex "domainless addresses"
593 .cindex "address" "without domain"
594 Exim insists that every address it handles has a domain attached. For incoming
595 local messages, domainless addresses are automatically qualified with a
596 configured domain value. Configuration options specify from which remote
597 systems unqualified addresses are acceptable. These are then qualified on
598 arrival.
599 .next
600 .cindex "transport" "external"
601 .cindex "external transports"
602 The only external transport mechanisms that are currently implemented are SMTP
603 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
604 transport is available, and there are facilities for writing messages to files
605 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
606 to send messages to other transport mechanisms such as UUCP, provided they can
607 handle domain-style addresses. Batched SMTP input is also catered for.
608 .next
609 Exim is not designed for storing mail for dial-in hosts. When the volumes of
610 such mail are large, it is better to get the messages &"delivered"& into files
611 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
612 other means.
613 .next
614 Although Exim does have basic facilities for scanning incoming messages, these
615 are not comprehensive enough to do full virus or spam scanning. Such operations
616 are best carried out using additional specialized software packages. If you
617 compile Exim with the content-scanning extension, straightforward interfaces to
618 a number of common scanners are provided.
619 .endlist
620
621
622 .section "Runtime configuration" "SECID7"
623 Exim's runtime configuration is held in a single text file that is divided
624 into a number of sections. The entries in this file consist of keywords and
625 values, in the style of Smail 3 configuration files. A default configuration
626 file which is suitable for simple online installations is provided in the
627 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
628
629
630 .section "Calling interface" "SECID8"
631 .cindex "Sendmail compatibility" "command line interface"
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for &_/usr/lib/sendmail_& or
634 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
640 documents all Exim's command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642
643 Control of messages in the queue can be done via certain privileged command
644 line options. There is also an optional monitor program called &'eximon'&,
645 which displays current information in an X window, and which contains a menu
646 interface to Exim's command line administration options.
647
648
649
650 .section "Terminology" "SECID9"
651 .cindex "terminology definitions"
652 .cindex "body of message" "definition of"
653 The &'body'& of a message is the actual data that the sender wants to transmit.
654 It is the last part of a message and is separated from the &'header'& (see
655 below) by a blank line.
656
657 .cindex "bounce message" "definition of"
658 When a message cannot be delivered, it is normally returned to the sender in a
659 delivery failure message or a &"non-delivery report"& (NDR). The term
660 &'bounce'& is commonly used for this action, and the error reports are often
661 called &'bounce messages'&. This is a convenient shorthand for &"delivery
662 failure error report"&. Such messages have an empty sender address in the
663 message's &'envelope'& (see below) to ensure that they cannot themselves give
664 rise to further bounce messages.
665
666 The term &'default'& appears frequently in this manual. It is used to qualify a
667 value which is used in the absence of any setting in the configuration. It may
668 also qualify an action which is taken unless a configuration setting specifies
669 otherwise.
670
671 The term &'defer'& is used when the delivery of a message to a specific
672 destination cannot immediately take place for some reason (a remote host may be
673 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
674 until a later time.
675
676 The word &'domain'& is sometimes used to mean all but the first component of a
677 host's name. It is &'not'& used in that sense here, where it normally refers to
678 the part of an email address following the @ sign.
679
680 .cindex "envelope, definition of"
681 .cindex "sender" "definition of"
682 A message in transit has an associated &'envelope'&, as well as a header and a
683 body. The envelope contains a sender address (to which bounce messages should
684 be delivered), and any number of recipient addresses. References to the
685 sender or the recipients of a message usually mean the addresses in the
686 envelope. An MTA uses these addresses for delivery, and for returning bounce
687 messages, not the addresses that appear in the header lines.
688
689 .cindex "message" "header, definition of"
690 .cindex "header section" "definition of"
691 The &'header'& of a message is the first part of a message's text, consisting
692 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
693 &'Subject:'&, etc. Long header lines can be split over several text lines by
694 indenting the continuations. The header is separated from the body by a blank
695 line.
696
697 .cindex "local part" "definition of"
698 .cindex "domain" "definition of"
699 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
700 part of an email address that precedes the @ sign. The part that follows the
701 @ sign is called the &'domain'& or &'mail domain'&.
702
703 .cindex "local delivery" "definition of"
704 .cindex "remote delivery, definition of"
705 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
706 delivery to a file or a pipe on the local host from delivery by SMTP over
707 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
708 host it is running on are &'remote'&.
709
710 .cindex "return path" "definition of"
711 &'Return path'& is another name that is used for the sender address in a
712 message's envelope.
713
714 .cindex "queue" "definition of"
715 The term &'queue'& is used to refer to the set of messages awaiting delivery
716 because this term is in widespread use in the context of MTAs. However, in
717 Exim's case, the reality is more like a pool than a queue, because there is
718 normally no ordering of waiting messages.
719
720 .cindex "queue runner" "definition of"
721 The term &'queue runner'& is used to describe a process that scans the queue
722 and attempts to deliver those messages whose retry times have come. This term
723 is used by other MTAs and also relates to the command &%runq%&, but in Exim
724 the waiting messages are normally processed in an unpredictable order.
725
726 .cindex "spool directory" "definition of"
727 The term &'spool directory'& is used for a directory in which Exim keeps the
728 messages in its queue &-- that is, those that it is in the process of
729 delivering. This should not be confused with the directory in which local
730 mailboxes are stored, which is called a &"spool directory"& by some people. In
731 the Exim documentation, &"spool"& is always used in the first sense.
732
733
734
735
736
737
738 . ////////////////////////////////////////////////////////////////////////////
739 . ////////////////////////////////////////////////////////////////////////////
740
741 .chapter "Incorporated code" "CHID2"
742 .cindex "incorporated code"
743 .cindex "regular expressions" "library"
744 .cindex "PCRE"
745 .cindex "OpenDMARC"
746 A number of pieces of external code are included in the Exim distribution.
747
748 .ilist
749 Regular expressions are supported in the main Exim program and in the
750 Exim monitor using the freely-distributable PCRE library, copyright
751 &copy; University of Cambridge. The source to PCRE is no longer shipped with
752 Exim, so you will need to use the version of PCRE shipped with your system,
753 or obtain and install the full version of the library from
754 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
755 .next
756 .cindex "cdb" "acknowledgment"
757 Support for the cdb (Constant DataBase) lookup method is provided by code
758 contributed by Nigel Metheringham of (at the time he contributed it) Planet
759 Online Ltd. The implementation is completely contained within the code of Exim.
760 It does not link against an external cdb library. The code contains the
761 following statements:
762
763 .blockquote
764 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
765
766 This program is free software; you can redistribute it and/or modify it under
767 the terms of the GNU General Public License as published by the Free Software
768 Foundation; either version 2 of the License, or (at your option) any later
769 version.
770 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
771 the spec and sample code for cdb can be obtained from
772 &url(https://cr.yp.to/cdb.html). This implementation borrows
773 some code from Dan Bernstein's implementation (which has no license
774 restrictions applied to it).
775 .endblockquote
776 .next
777 .cindex "SPA authentication"
778 .cindex "Samba project"
779 .cindex "Microsoft Secure Password Authentication"
780 Client support for Microsoft's &'Secure Password Authentication'& is provided
781 by code contributed by Marc Prud'hommeaux. Server support was contributed by
782 Tom Kistner. This includes code taken from the Samba project, which is released
783 under the Gnu GPL.
784 .next
785 .cindex "Cyrus"
786 .cindex "&'pwcheck'& daemon"
787 .cindex "&'pwauthd'& daemon"
788 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
789 by code taken from the Cyrus-SASL library and adapted by Alexander S.
790 Sabourenkov. The permission notice appears below, in accordance with the
791 conditions expressed therein.
792
793 .blockquote
794 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
795
796 Redistribution and use in source and binary forms, with or without
797 modification, are permitted provided that the following conditions
798 are met:
799
800 .olist
801 Redistributions of source code must retain the above copyright
802 notice, this list of conditions and the following disclaimer.
803 .next
804 Redistributions in binary form must reproduce the above copyright
805 notice, this list of conditions and the following disclaimer in
806 the documentation and/or other materials provided with the
807 distribution.
808 .next
809 The name &"Carnegie Mellon University"& must not be used to
810 endorse or promote products derived from this software without
811 prior written permission. For permission or any other legal
812 details, please contact
813 .display
814               Office of Technology Transfer
815               Carnegie Mellon University
816               5000 Forbes Avenue
817               Pittsburgh, PA  15213-3890
818               (412) 268-4387, fax: (412) 268-7395
819               tech-transfer@andrew.cmu.edu
820 .endd
821 .next
822 Redistributions of any form whatsoever must retain the following
823 acknowledgment:
824
825 &"This product includes software developed by Computing Services
826 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
827
828 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
829 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
830 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
831 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
832 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
833 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
834 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
835 .endlist
836 .endblockquote
837
838 .next
839 .cindex "Exim monitor" "acknowledgment"
840 .cindex "X-windows"
841 .cindex "Athena"
842 The Exim Monitor program, which is an X-Window application, includes
843 modified versions of the Athena StripChart and TextPop widgets.
844 This code is copyright by DEC and MIT, and their permission notice appears
845 below, in accordance with the conditions expressed therein.
846
847 .blockquote
848 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
849 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
850
851 All Rights Reserved
852
853 Permission to use, copy, modify, and distribute this software and its
854 documentation for any purpose and without fee is hereby granted,
855 provided that the above copyright notice appear in all copies and that
856 both that copyright notice and this permission notice appear in
857 supporting documentation, and that the names of Digital or MIT not be
858 used in advertising or publicity pertaining to distribution of the
859 software without specific, written prior permission.
860
861 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
862 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
863 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
864 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
865 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
866 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
867 SOFTWARE.
868 .endblockquote
869
870 .next
871 .cindex "opendmarc" "acknowledgment"
872 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
873 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
874 derived code are indicated in the respective source files. The full OpenDMARC
875 license is provided in the LICENSE.opendmarc file contained in the distributed
876 source code.
877
878 .next
879 Many people have contributed code fragments, some large, some small, that were
880 not covered by any specific license requirements. It is assumed that the
881 contributors are happy to see their code incorporated into Exim under the GPL.
882 .endlist
883
884
885
886
887
888 . ////////////////////////////////////////////////////////////////////////////
889 . ////////////////////////////////////////////////////////////////////////////
890
891 .chapter "How Exim receives and delivers mail" "CHID11" &&&
892          "Receiving and delivering mail"
893
894
895 .section "Overall philosophy" "SECID10"
896 .cindex "design philosophy"
897 Exim is designed to work efficiently on systems that are permanently connected
898 to the Internet and are handling a general mix of mail. In such circumstances,
899 most messages can be delivered immediately. Consequently, Exim does not
900 maintain independent queues of messages for specific domains or hosts, though
901 it does try to send several messages in a single SMTP connection after a host
902 has been down, and it also maintains per-host retry information.
903
904
905 .section "Policy control" "SECID11"
906 .cindex "policy control" "overview"
907 Policy controls are now an important feature of MTAs that are connected to the
908 Internet. Perhaps their most important job is to stop MTAs from being abused as
909 &"open relays"& by misguided individuals who send out vast amounts of
910 unsolicited junk and want to disguise its source. Exim provides flexible
911 facilities for specifying policy controls on incoming mail:
912
913 .ilist
914 .cindex "&ACL;" "introduction"
915 Exim 4 (unlike previous versions of Exim) implements policy controls on
916 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
917 series of statements that may either grant or deny access. ACLs can be used at
918 several places in the SMTP dialogue while receiving a message from a remote
919 host. However, the most common places are after each RCPT command, and at the
920 very end of the message. The sysadmin can specify conditions for accepting or
921 rejecting individual recipients or the entire message, respectively, at these
922 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
923 error code.
924 .next
925 An ACL is also available for locally generated, non-SMTP messages. In this
926 case, the only available actions are to accept or deny the entire message.
927 .next
928 When Exim is compiled with the content-scanning extension, facilities are
929 provided in the ACL mechanism for passing the message to external virus and/or
930 spam scanning software. The result of such a scan is passed back to the ACL,
931 which can then use it to decide what to do with the message.
932 .next
933 When a message has been received, either from a remote host or from the local
934 host, but before the final acknowledgment has been sent, a locally supplied C
935 function called &[local_scan()]& can be run to inspect the message and decide
936 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
937 is accepted, the list of recipients can be modified by the function.
938 .next
939 Using the &[local_scan()]& mechanism is another way of calling external scanner
940 software. The &%SA-Exim%& add-on package works this way. It does not require
941 Exim to be compiled with the content-scanning extension.
942 .next
943 After a message has been accepted, a further checking mechanism is available in
944 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
945 runs at the start of every delivery process.
946 .endlist
947
948
949
950 .section "User filters" "SECID12"
951 .cindex "filter" "introduction"
952 .cindex "Sieve filter"
953 In a conventional Exim configuration, users are able to run private filters by
954 setting up appropriate &_.forward_& files in their home directories. See
955 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
956 configuration needed to support this, and the separate document entitled
957 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
958 of filtering are available:
959
960 .ilist
961 Sieve filters are written in the standard filtering language that is defined
962 by RFC 3028.
963 .next
964 Exim filters are written in a syntax that is unique to Exim, but which is more
965 powerful than Sieve, which it pre-dates.
966 .endlist
967
968 User filters are run as part of the routing process, described below.
969
970
971
972 .section "Message identification" "SECTmessiden"
973 .cindex "message ids" "details of format"
974 .cindex "format" "of message id"
975 .cindex "id of message"
976 .cindex "base62"
977 .cindex "base36"
978 .cindex "Darwin"
979 .cindex "Cygwin"
980 Every message handled by Exim is given a &'message id'& which is sixteen
981 characters long. It is divided into three parts, separated by hyphens, for
982 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
983 normally encoding numbers in base 62. However, in the Darwin operating
984 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
985 (avoiding the use of lower case letters) is used instead, because the message
986 id is used to construct filenames, and the names of files in those systems are
987 not always case-sensitive.
988
989 .cindex "pid (process id)" "re-use of"
990 The detail of the contents of the message id have changed as Exim has evolved.
991 Earlier versions relied on the operating system not re-using a process id (pid)
992 within one second. On modern operating systems, this assumption can no longer
993 be made, so the algorithm had to be changed. To retain backward compatibility,
994 the format of the message id was retained, which is why the following rules are
995 somewhat eccentric:
996
997 .ilist
998 The first six characters of the message id are the time at which the message
999 started to be received, to a granularity of one second. That is, this field
1000 contains the number of seconds since the start of the epoch (the normal Unix
1001 way of representing the date and time of day).
1002 .next
1003 After the first hyphen, the next six characters are the id of the process that
1004 received the message.
1005 .next
1006 There are two different possibilities for the final two characters:
1007 .olist
1008 .oindex "&%localhost_number%&"
1009 If &%localhost_number%& is not set, this value is the fractional part of the
1010 time of reception, normally in units of 1/2000 of a second, but for systems
1011 that must use base 36 instead of base 62 (because of case-insensitive file
1012 systems), the units are 1/1000 of a second.
1013 .next
1014 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1015 the fractional part of the time, which in this case is in units of 1/200
1016 (1/100) of a second.
1017 .endlist
1018 .endlist
1019
1020 After a message has been received, Exim waits for the clock to tick at the
1021 appropriate resolution before proceeding, so that if another message is
1022 received by the same process, or by another process with the same (re-used)
1023 pid, it is guaranteed that the time will be different. In most cases, the clock
1024 will already have ticked while the message was being received.
1025
1026
1027 .section "Receiving mail" "SECID13"
1028 .cindex "receiving mail"
1029 .cindex "message" "reception"
1030 The only way Exim can receive mail from another host is using SMTP over
1031 TCP/IP, in which case the sender and recipient addresses are transferred using
1032 SMTP commands. However, from a locally running process (such as a user's MUA),
1033 there are several possibilities:
1034
1035 .ilist
1036 If the process runs Exim with the &%-bm%& option, the message is read
1037 non-interactively (usually via a pipe), with the recipients taken from the
1038 command line, or from the body of the message if &%-t%& is also used.
1039 .next
1040 If the process runs Exim with the &%-bS%& option, the message is also read
1041 non-interactively, but in this case the recipients are listed at the start of
1042 the message in a series of SMTP RCPT commands, terminated by a DATA
1043 command. This is called &"batch SMTP"& format,
1044 but it isn't really SMTP. The SMTP commands are just another way of passing
1045 envelope addresses in a non-interactive submission.
1046 .next
1047 If the process runs Exim with the &%-bs%& option, the message is read
1048 interactively, using the SMTP protocol. A two-way pipe is normally used for
1049 passing data between the local process and the Exim process.
1050 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1051 example, the ACLs for SMTP commands are used for this form of submission.
1052 .next
1053 A local process may also make a TCP/IP call to the host's loopback address
1054 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1055 does not treat the loopback address specially. It treats all such connections
1056 in the same way as connections from other hosts.
1057 .endlist
1058
1059
1060 .cindex "message sender, constructed by Exim"
1061 .cindex "sender" "constructed by Exim"
1062 In the three cases that do not involve TCP/IP, the sender address is
1063 constructed from the login name of the user that called Exim and a default
1064 qualification domain (which can be set by the &%qualify_domain%& configuration
1065 option). For local or batch SMTP, a sender address that is passed using the
1066 SMTP MAIL command is ignored. However, the system administrator may allow
1067 certain users (&"trusted users"&) to specify a different sender addresses
1068 unconditionally, or all users to specify certain forms of different sender
1069 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1070 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1071 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1072 users to change sender addresses.
1073
1074 Messages received by either of the non-interactive mechanisms are subject to
1075 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1076 (either over TCP/IP or interacting with a local process) can be checked by a
1077 number of ACLs that operate at different times during the SMTP session. Either
1078 individual recipients or the entire message can be rejected if local policy
1079 requirements are not met. The &[local_scan()]& function (see chapter
1080 &<<CHAPlocalscan>>&) is run for all incoming messages.
1081
1082 Exim can be configured not to start a delivery process when a message is
1083 received; this can be unconditional, or depend on the number of incoming SMTP
1084 connections or the system load. In these situations, new messages wait on the
1085 queue until a queue runner process picks them up. However, in standard
1086 configurations under normal conditions, delivery is started as soon as a
1087 message is received.
1088
1089
1090
1091
1092
1093 .section "Handling an incoming message" "SECID14"
1094 .cindex "spool directory" "files that hold a message"
1095 .cindex "file" "how a message is held"
1096 When Exim accepts a message, it writes two files in its spool directory. The
1097 first contains the envelope information, the current status of the message, and
1098 the header lines, and the second contains the body of the message. The names of
1099 the two spool files consist of the message id, followed by &`-H`& for the
1100 file containing the envelope and header, and &`-D`& for the data file.
1101
1102 .cindex "spool directory" "&_input_& sub-directory"
1103 By default, all these message files are held in a single directory called
1104 &_input_& inside the general Exim spool directory. Some operating systems do
1105 not perform very well if the number of files in a directory gets large; to
1106 improve performance in such cases, the &%split_spool_directory%& option can be
1107 used. This causes Exim to split up the input files into 62 sub-directories
1108 whose names are single letters or digits. When this is done, the queue is
1109 processed one sub-directory at a time instead of all at once, which can improve
1110 overall performance even when there are not enough files in each directory to
1111 affect file system performance.
1112
1113 The envelope information consists of the address of the message's sender and
1114 the addresses of the recipients. This information is entirely separate from
1115 any addresses contained in the header lines. The status of the message includes
1116 a list of recipients who have already received the message. The format of the
1117 first spool file is described in chapter &<<CHAPspool>>&.
1118
1119 .cindex "rewriting" "addresses"
1120 Address rewriting that is specified in the rewrite section of the configuration
1121 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1122 both in the header lines and the envelope, at the time the message is accepted.
1123 If during the course of delivery additional addresses are generated (for
1124 example, via aliasing), these new addresses are rewritten as soon as they are
1125 generated. At the time a message is actually delivered (transported) further
1126 rewriting can take place; because this is a transport option, it can be
1127 different for different forms of delivery. It is also possible to specify the
1128 addition or removal of certain header lines at the time the message is
1129 delivered (see chapters &<<CHAProutergeneric>>& and
1130 &<<CHAPtransportgeneric>>&).
1131
1132
1133
1134 .section "Life of a message" "SECID15"
1135 .cindex "message" "life of"
1136 .cindex "message" "frozen"
1137 A message remains in the spool directory until it is completely delivered to
1138 its recipients or to an error address, or until it is deleted by an
1139 administrator or by the user who originally created it. In cases when delivery
1140 cannot proceed &-- for example when a message can neither be delivered to its
1141 recipients nor returned to its sender, the message is marked &"frozen"& on the
1142 spool, and no more deliveries are attempted.
1143
1144 .cindex "frozen messages" "thawing"
1145 .cindex "message" "thawing frozen"
1146 An administrator can &"thaw"& such messages when the problem has been
1147 corrected, and can also freeze individual messages by hand if necessary. In
1148 addition, an administrator can force a delivery error, causing a bounce message
1149 to be sent.
1150
1151 .oindex "&%timeout_frozen_after%&"
1152 .oindex "&%ignore_bounce_errors_after%&"
1153 There are options called &%ignore_bounce_errors_after%& and
1154 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1155 The first applies only to frozen bounces, the second to all frozen messages.
1156
1157 .cindex "message" "log file for"
1158 .cindex "log" "file for each message"
1159 While Exim is working on a message, it writes information about each delivery
1160 attempt to its main log file. This includes successful, unsuccessful, and
1161 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1162 lines are also written to a separate &'message log'& file for each message.
1163 These logs are solely for the benefit of the administrator and are normally
1164 deleted along with the spool files when processing of a message is complete.
1165 The use of individual message logs can be disabled by setting
1166 &%no_message_logs%&; this might give an improvement in performance on very busy
1167 systems.
1168
1169 .cindex "journal file"
1170 .cindex "file" "journal"
1171 All the information Exim itself needs to set up a delivery is kept in the first
1172 spool file, along with the header lines. When a successful delivery occurs, the
1173 address is immediately written at the end of a journal file, whose name is the
1174 message id followed by &`-J`&. At the end of a delivery run, if there are some
1175 addresses left to be tried again later, the first spool file (the &`-H`& file)
1176 is updated to indicate which these are, and the journal file is then deleted.
1177 Updating the spool file is done by writing a new file and renaming it, to
1178 minimize the possibility of data loss.
1179
1180 Should the system or Exim crash after a successful delivery but before
1181 the spool file has been updated, the journal is left lying around. The next
1182 time Exim attempts to deliver the message, it reads the journal file and
1183 updates the spool file before proceeding. This minimizes the chances of double
1184 deliveries caused by crashes.
1185
1186
1187
1188 .section "Processing an address for delivery" "SECTprocaddress"
1189 .cindex "drivers" "definition of"
1190 .cindex "router" "definition of"
1191 .cindex "transport" "definition of"
1192 The main delivery processing elements of Exim are called &'routers'& and
1193 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1194 number of them is provided in the source distribution, and compile-time options
1195 specify which ones are included in the binary. Runtime options specify which
1196 ones are actually used for delivering messages.
1197
1198 .cindex "drivers" "instance definition"
1199 Each driver that is specified in the runtime configuration is an &'instance'&
1200 of that particular driver type. Multiple instances are allowed; for example,
1201 you can set up several different &(smtp)& transports, each with different
1202 option values that might specify different ports or different timeouts. Each
1203 instance has its own identifying name. In what follows we will normally use the
1204 instance name when discussing one particular instance (that is, one specific
1205 configuration of the driver), and the generic driver name when discussing
1206 the driver's features in general.
1207
1208 A &'router'& is a driver that operates on an address, either determining how
1209 its delivery should happen, by assigning it to a specific transport, or
1210 converting the address into one or more new addresses (for example, via an
1211 alias file). A router may also explicitly choose to fail an address, causing it
1212 to be bounced.
1213
1214 A &'transport'& is a driver that transmits a copy of the message from Exim's
1215 spool to some destination. There are two kinds of transport: for a &'local'&
1216 transport, the destination is a file or a pipe on the local host, whereas for a
1217 &'remote'& transport the destination is some other host. A message is passed
1218 to a specific transport as a result of successful routing. If a message has
1219 several recipients, it may be passed to a number of different transports.
1220
1221 .cindex "preconditions" "definition of"
1222 An address is processed by passing it to each configured router instance in
1223 turn, subject to certain preconditions, until a router accepts the address or
1224 specifies that it should be bounced. We will describe this process in more
1225 detail shortly. First, as a simple example, we consider how each recipient
1226 address in a message is processed in a small configuration of three routers.
1227
1228 To make this a more concrete example, it is described in terms of some actual
1229 routers, but remember, this is only an example. You can configure Exim's
1230 routers in many different ways, and there may be any number of routers in a
1231 configuration.
1232
1233 The first router that is specified in a configuration is often one that handles
1234 addresses in domains that are not recognized specifically by the local host.
1235 Typically these are addresses for arbitrary domains on the Internet. A precondition
1236 is set up which looks for the special domains known to the host (for example,
1237 its own domain name), and the router is run for addresses that do &'not'&
1238 match. Typically, this is a router that looks up domains in the DNS in order to
1239 find the hosts to which this address routes. If it succeeds, the address is
1240 assigned to a suitable SMTP transport; if it does not succeed, the router is
1241 configured to fail the address.
1242
1243 The second router is reached only when the domain is recognized as one that
1244 &"belongs"& to the local host. This router does redirection &-- also known as
1245 aliasing and forwarding. When it generates one or more new addresses from the
1246 original, each of them is routed independently from the start. Otherwise, the
1247 router may cause an address to fail, or it may simply decline to handle the
1248 address, in which case the address is passed to the next router.
1249
1250 The final router in many configurations is one that checks to see if the
1251 address belongs to a local mailbox. The precondition may involve a check to
1252 see if the local part is the name of a login account, or it may look up the
1253 local part in a file or a database. If its preconditions are not met, or if
1254 the router declines, we have reached the end of the routers. When this happens,
1255 the address is bounced.
1256
1257
1258
1259 .section "Processing an address for verification" "SECID16"
1260 .cindex "router" "for verification"
1261 .cindex "verifying address" "overview"
1262 As well as being used to decide how to deliver to an address, Exim's routers
1263 are also used for &'address verification'&. Verification can be requested as
1264 one of the checks to be performed in an ACL for incoming messages, on both
1265 sender and recipient addresses, and it can be tested using the &%-bv%& and
1266 &%-bvs%& command line options.
1267
1268 When an address is being verified, the routers are run in &"verify mode"&. This
1269 does not affect the way the routers work, but it is a state that can be
1270 detected. By this means, a router can be skipped or made to behave differently
1271 when verifying. A common example is a configuration in which the first router
1272 sends all messages to a message-scanning program unless they have been
1273 previously scanned. Thus, the first router accepts all addresses without any
1274 checking, making it useless for verifying. Normally, the &%no_verify%& option
1275 would be set for such a router, causing it to be skipped in verify mode.
1276
1277
1278
1279
1280 .section "Running an individual router" "SECTrunindrou"
1281 .cindex "router" "running details"
1282 .cindex "preconditions" "checking"
1283 .cindex "router" "result of running"
1284 As explained in the example above, a number of preconditions are checked before
1285 running a router. If any are not met, the router is skipped, and the address is
1286 passed to the next router. When all the preconditions on a router &'are'& met,
1287 the router is run. What happens next depends on the outcome, which is one of
1288 the following:
1289
1290 .ilist
1291 &'accept'&: The router accepts the address, and either assigns it to a
1292 transport or generates one or more &"child"& addresses. Processing the
1293 original address ceases
1294 .oindex "&%unseen%&"
1295 unless the &%unseen%& option is set on the router. This option
1296 can be used to set up multiple deliveries with different routing (for example,
1297 for keeping archive copies of messages). When &%unseen%& is set, the address is
1298 passed to the next router. Normally, however, an &'accept'& return marks the
1299 end of routing.
1300
1301 Any child addresses generated by the router are processed independently,
1302 starting with the first router by default. It is possible to change this by
1303 setting the &%redirect_router%& option to specify which router to start at for
1304 child addresses. Unlike &%pass_router%& (see below) the router specified by
1305 &%redirect_router%& may be anywhere in the router configuration.
1306 .next
1307 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1308 requests that the address be passed to another router. By default, the address
1309 is passed to the next router, but this can be changed by setting the
1310 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1311 must be below the current router (to avoid loops).
1312 .next
1313 &'decline'&: The router declines to accept the address because it does not
1314 recognize it at all. By default, the address is passed to the next router, but
1315 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1316 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1317 &'decline'& into &'fail'&.
1318 .next
1319 &'fail'&: The router determines that the address should fail, and queues it for
1320 the generation of a bounce message. There is no further processing of the
1321 original address unless &%unseen%& is set on the router.
1322 .next
1323 &'defer'&: The router cannot handle the address at the present time. (A
1324 database may be offline, or a DNS lookup may have timed out.) No further
1325 processing of the address happens in this delivery attempt. It is tried again
1326 next time the message is considered for delivery.
1327 .next
1328 &'error'&: There is some error in the router (for example, a syntax error in
1329 its configuration). The action is as for defer.
1330 .endlist
1331
1332 If an address reaches the end of the routers without having been accepted by
1333 any of them, it is bounced as unrouteable. The default error message in this
1334 situation is &"unrouteable address"&, but you can set your own message by
1335 making use of the &%cannot_route_message%& option. This can be set for any
1336 router; the value from the last router that &"saw"& the address is used.
1337
1338 Sometimes while routing you want to fail a delivery when some conditions are
1339 met but others are not, instead of passing the address on for further routing.
1340 You can do this by having a second router that explicitly fails the delivery
1341 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1342 facility for this purpose.
1343
1344
1345 .section "Duplicate addresses" "SECID17"
1346 .cindex "case of local parts"
1347 .cindex "address duplicate, discarding"
1348 .cindex "duplicate addresses"
1349 Once routing is complete, Exim scans the addresses that are assigned to local
1350 and remote transports and discards any duplicates that it finds. During this
1351 check, local parts are treated case-sensitively. This happens only when
1352 actually delivering a message; when testing routers with &%-bt%&, all the
1353 routed addresses are shown.
1354
1355
1356
1357 .section "Router preconditions" "SECTrouprecon"
1358 .cindex "router" "preconditions, order of processing"
1359 .cindex "preconditions" "order of processing"
1360 The preconditions that are tested for each router are listed below, in the
1361 order in which they are tested. The individual configuration options are
1362 described in more detail in chapter &<<CHAProutergeneric>>&.
1363
1364 .ilist
1365 .cindex affix "router precondition"
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 .cindex affix "router precondition"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router, in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain in your queue forever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left in the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681 .cindex compiler requirements
1682 .cindex compiler version
1683 A C99-capable compiler will be required for the build.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need to
1690 install the PCRE package or the PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(https://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 filename is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1753 Maintenance of some of the earlier releases has ceased. All versions of
1754 Berkeley DB could be obtained from
1755 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1756 page with far newer versions listed.
1757 It is probably wise to plan to move your storage configurations away from
1758 Berkeley DB format, as today there are smaller and simpler alternatives more
1759 suited to Exim's usage model.
1760 .next
1761 .cindex "&'tdb'& DBM library"
1762 Yet another DBM library, called &'tdb'&, is available from
1763 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1764 operates on a single file.
1765 .endlist
1766
1767 .cindex "USE_DB"
1768 .cindex "DBM libraries" "configuration for building"
1769 Exim and its utilities can be compiled to use any of these interfaces. In order
1770 to use any version of the Berkeley DB package in native mode, you must set
1771 USE_DB in an appropriate configuration file (typically
1772 &_Local/Makefile_&). For example:
1773 .code
1774 USE_DB=yes
1775 .endd
1776 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1777 error is diagnosed if you set more than one of these.
1778
1779 At the lowest level, the build-time configuration sets none of these options,
1780 thereby assuming an interface of type (1). However, some operating system
1781 configuration files (for example, those for the BSD operating systems and
1782 Linux) assume type (4) by setting USE_DB as their default, and the
1783 configuration files for Cygwin set USE_GDBM. Anything you set in
1784 &_Local/Makefile_&, however, overrides these system defaults.
1785
1786 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1787 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1788 in one of these lines:
1789 .code
1790 DBMLIB = -ldb
1791 DBMLIB = -ltdb
1792 .endd
1793 Settings like that will work if the DBM library is installed in the standard
1794 place. Sometimes it is not, and the library's header file may also not be in
1795 the default path. You may need to set INCLUDE to specify where the header
1796 file is, and to specify the path to the library more fully in DBMLIB, as in
1797 this example:
1798 .code
1799 INCLUDE=-I/usr/local/include/db-4.1
1800 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1801 .endd
1802 There is further detailed discussion about the various DBM libraries in the
1803 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1804
1805
1806
1807 .section "Pre-building configuration" "SECID25"
1808 .cindex "building Exim" "pre-building configuration"
1809 .cindex "configuration for building Exim"
1810 .cindex "&_Local/Makefile_&"
1811 .cindex "&_src/EDITME_&"
1812 Before building Exim, a local configuration file that specifies options
1813 independent of any operating system has to be created with the name
1814 &_Local/Makefile_&. A template for this file is supplied as the file
1815 &_src/EDITME_&, and it contains full descriptions of all the option settings
1816 therein. These descriptions are therefore not repeated here. If you are
1817 building Exim for the first time, the simplest thing to do is to copy
1818 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1819
1820 There are three settings that you must supply, because Exim will not build
1821 without them. They are the location of the runtime configuration file
1822 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1823 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1824 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1825 a colon-separated list of filenames; Exim uses the first of them that exists.
1826
1827 There are a few other parameters that can be specified either at build time or
1828 at runtime, to enable the same binary to be used on a number of different
1829 machines. However, if the locations of Exim's spool directory and log file
1830 directory (if not within the spool directory) are fixed, it is recommended that
1831 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1832 detected early in Exim's execution (such as a malformed configuration file) can
1833 be logged.
1834
1835 .cindex "content scanning" "specifying at build time"
1836 Exim's interfaces for calling virus and spam scanning software directly from
1837 access control lists are not compiled by default. If you want to include these
1838 facilities, you need to set
1839 .code
1840 WITH_CONTENT_SCAN=yes
1841 .endd
1842 in your &_Local/Makefile_&. For details of the facilities themselves, see
1843 chapter &<<CHAPexiscan>>&.
1844
1845
1846 .cindex "&_Local/eximon.conf_&"
1847 .cindex "&_exim_monitor/EDITME_&"
1848 If you are going to build the Exim monitor, a similar configuration process is
1849 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1850 your installation and saved under the name &_Local/eximon.conf_&. If you are
1851 happy with the default settings described in &_exim_monitor/EDITME_&,
1852 &_Local/eximon.conf_& can be empty, but it must exist.
1853
1854 This is all the configuration that is needed in straightforward cases for known
1855 operating systems. However, the building process is set up so that it is easy
1856 to override options that are set by default or by operating-system-specific
1857 configuration files, for example, to change the C compiler, which
1858 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1859 do this.
1860
1861
1862
1863 .section "Support for iconv()" "SECID26"
1864 .cindex "&[iconv()]& support"
1865 .cindex "RFC 2047"
1866 The contents of header lines in messages may be encoded according to the rules
1867 described RFC 2047. This makes it possible to transmit characters that are not
1868 in the ASCII character set, and to label them as being in a particular
1869 character set. When Exim is inspecting header lines by means of the &%$h_%&
1870 mechanism, it decodes them, and translates them into a specified character set
1871 (default is set at build time). The translation is possible only if the operating system
1872 supports the &[iconv()]& function.
1873
1874 However, some of the operating systems that supply &[iconv()]& do not support
1875 very many conversions. The GNU &%libiconv%& library (available from
1876 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1877 systems to remedy this deficiency, as well as on systems that do not supply
1878 &[iconv()]& at all. After installing &%libiconv%&, you should add
1879 .code
1880 HAVE_ICONV=yes
1881 .endd
1882 to your &_Local/Makefile_& and rebuild Exim.
1883
1884
1885
1886 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1887 .cindex "TLS" "including support for TLS"
1888 .cindex "encryption" "including support for"
1889 .cindex "OpenSSL" "building Exim with"
1890 .cindex "GnuTLS" "building Exim with"
1891 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1892 command as per RFC 2487. It can also support clients that expect to
1893 start a TLS session immediately on connection to a non-standard port (see the
1894 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1895 line option).
1896
1897 If you want to build Exim with TLS support, you must first install either the
1898 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1899 implementing SSL.
1900
1901 .new
1902 If you do not want TLS support you should set
1903 .code
1904 DISABLE_TLS=yes
1905 .endd
1906 in &_Local/Makefile_&.
1907 .wen
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_OPENSL=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_OPENSL=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 &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3967 .oindex "&%-Mmad%&"
3968 .cindex "delivery" "cancelling all"
3969 This option requests Exim to mark all the recipient addresses in the messages
3970 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3971 message is active (in the middle of a delivery attempt), its status is not
3972 altered. This option can be used only by an admin user.
3973
3974 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3975 .oindex "&%-Mmd%&"
3976 .cindex "delivery" "cancelling by address"
3977 .cindex "recipient" "removing"
3978 .cindex "removing recipients"
3979 This option requests Exim to mark the given addresses as already delivered
3980 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3981 the remaining ones must be email addresses. These are matched to recipient
3982 addresses in the message in a case-sensitive manner. If the message is active
3983 (in the middle of a delivery attempt), its status is not altered. This option
3984 can be used only by an admin user.
3985
3986 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3987 .oindex "&%-Mrm%&"
3988 .cindex "removing messages"
3989 .cindex "abandoning mail"
3990 .cindex "message" "manually discarding"
3991 This option requests Exim to remove the given messages from the queue. No
3992 bounce messages are sent; each message is simply forgotten. However, if any of
3993 the messages are active, their status is not altered. This option can be used
3994 only by an admin user or by the user who originally caused the message to be
3995 placed in the queue.
3996
3997 . .new
3998 . .vitem &%-MS%&
3999 . .oindex "&%-MS%&"
4000 . .cindex REQUIRETLS
4001 . This option is used to request REQUIRETLS processing on the message.
4002 . It is used internally by Exim in conjunction with -E when generating
4003 . a bounce message.
4004 . .wen
4005
4006 .vitem &%-Mset%&&~<&'message&~id'&>
4007 .oindex "&%-Mset%&"
4008 .cindex "testing" "string expansion"
4009 .cindex "expansion" "testing"
4010 This option is useful only in conjunction with &%-be%& (that is, when testing
4011 string expansions). Exim loads the given message from its spool before doing
4012 the test expansions, thus setting message-specific variables such as
4013 &$message_size$& and the header variables. The &$recipients$& variable is made
4014 available. This feature is provided to make it easier to test expansions that
4015 make use of these variables. However, this option can be used only by an admin
4016 user. See also &%-bem%&.
4017
4018 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4019 .oindex "&%-Mt%&"
4020 .cindex "thawing messages"
4021 .cindex "unfreezing messages"
4022 .cindex "frozen messages" "thawing"
4023 .cindex "message" "thawing frozen"
4024 This option requests Exim to &"thaw"& any of the listed messages that are
4025 &"frozen"&, so that delivery attempts can resume. However, if any of the
4026 messages are active, their status is not altered. This option can be used only
4027 by an admin user.
4028
4029 .vitem &%-Mvb%&&~<&'message&~id'&>
4030 .oindex "&%-Mvb%&"
4031 .cindex "listing" "message body"
4032 .cindex "message" "listing body of"
4033 This option causes the contents of the message body (-D) spool file to be
4034 written to the standard output. This option can be used only by an admin user.
4035
4036 .vitem &%-Mvc%&&~<&'message&~id'&>
4037 .oindex "&%-Mvc%&"
4038 .cindex "message" "listing in RFC 2822 format"
4039 .cindex "listing" "message in RFC 2822 format"
4040 This option causes a copy of the complete message (header lines plus body) to
4041 be written to the standard output in RFC 2822 format. This option can be used
4042 only by an admin user.
4043
4044 .vitem &%-Mvh%&&~<&'message&~id'&>
4045 .oindex "&%-Mvh%&"
4046 .cindex "listing" "message headers"
4047 .cindex "header lines" "listing"
4048 .cindex "message" "listing header lines"
4049 This option causes the contents of the message headers (-H) spool file to be
4050 written to the standard output. This option can be used only by an admin user.
4051
4052 .vitem &%-Mvl%&&~<&'message&~id'&>
4053 .oindex "&%-Mvl%&"
4054 .cindex "listing" "message log"
4055 .cindex "message" "listing message log"
4056 This option causes the contents of the message log spool file to be written to
4057 the standard output. This option can be used only by an admin user.
4058
4059 .vitem &%-m%&
4060 .oindex "&%-m%&"
4061 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4062 treats it that way too.
4063
4064 .vitem &%-N%&
4065 .oindex "&%-N%&"
4066 .cindex "debugging" "&%-N%& option"
4067 .cindex "debugging" "suppressing delivery"
4068 This is a debugging option that inhibits delivery of a message at the transport
4069 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4070 it just doesn't actually transport the message, but instead behaves as if it
4071 had successfully done so. However, it does not make any updates to the retry
4072 database, and the log entries for deliveries are flagged with &"*>"& rather
4073 than &"=>"&.
4074
4075 Because &%-N%& discards any message to which it applies, only root or the Exim
4076 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4077 words, an ordinary user can use it only when supplying an incoming message to
4078 which it will apply. Although transportation never fails when &%-N%& is set, an
4079 address may be deferred because of a configuration problem on a transport, or a
4080 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4081 the message, and applies to any subsequent delivery attempts that may happen
4082 for that message.
4083
4084 .vitem &%-n%&
4085 .oindex "&%-n%&"
4086 This option is interpreted by Sendmail to mean &"no aliasing"&.
4087 For normal modes of operation, it is ignored by Exim.
4088 When combined with &%-bP%& it makes the output more terse (suppresses
4089 option names, environment values and config pretty printing).
4090
4091 .vitem &%-O%&&~<&'data'&>
4092 .oindex "&%-O%&"
4093 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4094 Exim.
4095
4096 .vitem &%-oA%&&~<&'file&~name'&>
4097 .oindex "&%-oA%&"
4098 .cindex "Sendmail compatibility" "&%-oA%& option"
4099 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4100 alternative alias filename. Exim handles &%-bi%& differently; see the
4101 description above.
4102
4103 .vitem &%-oB%&&~<&'n'&>
4104 .oindex "&%-oB%&"
4105 .cindex "SMTP" "passed connection"
4106 .cindex "SMTP" "multiple deliveries"
4107 .cindex "multiple SMTP deliveries"
4108 This is a debugging option which limits the maximum number of messages that can
4109 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4110 transport. If <&'n'&> is omitted, the limit is set to 1.
4111
4112 .vitem &%-odb%&
4113 .oindex "&%-odb%&"
4114 .cindex "background delivery"
4115 .cindex "delivery" "in the background"
4116 This option applies to all modes in which Exim accepts incoming messages,
4117 including the listening daemon. It requests &"background"& delivery of such
4118 messages, which means that the accepting process automatically starts a
4119 delivery process for each message received, but does not wait for the delivery
4120 processes to finish.
4121
4122 When all the messages have been received, the reception process exits,
4123 leaving the delivery processes to finish in their own time. The standard output
4124 and error streams are closed at the start of each delivery process.
4125 This is the default action if none of the &%-od%& options are present.
4126
4127 If one of the queueing options in the configuration file
4128 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4129 overrides it if &%queue_only_override%& is set true, which is the default
4130 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4131
4132 .vitem &%-odf%&
4133 .oindex "&%-odf%&"
4134 .cindex "foreground delivery"
4135 .cindex "delivery" "in the foreground"
4136 This option requests &"foreground"& (synchronous) delivery when Exim has
4137 accepted a locally-generated message. (For the daemon it is exactly the same as
4138 &%-odb%&.) A delivery process is automatically started to deliver the message,
4139 and Exim waits for it to complete before proceeding.
4140
4141 The original Exim reception process does not finish until the delivery
4142 process for the final message has ended. The standard error stream is left open
4143 during deliveries.
4144
4145 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4146 false and one of the queueing options in the configuration file is in effect.
4147
4148 If there is a temporary delivery error during foreground delivery, the
4149 message is left in the queue for later delivery, and the original reception
4150 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4151 restricted configuration that never queues messages.
4152
4153
4154 .vitem &%-odi%&
4155 .oindex "&%-odi%&"
4156 This option is synonymous with &%-odf%&. It is provided for compatibility with
4157 Sendmail.
4158
4159 .vitem &%-odq%&
4160 .oindex "&%-odq%&"
4161 .cindex "non-immediate delivery"
4162 .cindex "delivery" "suppressing immediate"
4163 .cindex "queueing incoming messages"
4164 This option applies to all modes in which Exim accepts incoming messages,
4165 including the listening daemon. It specifies that the accepting process should
4166 not automatically start a delivery process for each message received. Messages
4167 are placed in the queue, and remain there until a subsequent queue runner
4168 process encounters them. There are several configuration options (such as
4169 &%queue_only%&) that can be used to queue incoming messages under certain
4170 conditions. This option overrides all of them and also &%-odqs%&. It always
4171 forces queueing.
4172
4173 .vitem &%-odqs%&
4174 .oindex "&%-odqs%&"
4175 .cindex "SMTP" "delaying delivery"
4176 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4177 However, like &%-odb%& and &%-odi%&, this option has no effect if
4178 &%queue_only_override%& is false and one of the queueing options in the
4179 configuration file is in effect.
4180
4181 When &%-odqs%& does operate, a delivery process is started for each incoming
4182 message, in the background by default, but in the foreground if &%-odi%& is
4183 also present. The recipient addresses are routed, and local deliveries are done
4184 in the normal way. However, if any SMTP deliveries are required, they are not
4185 done at this time, so the message remains in the queue until a subsequent queue
4186 runner process encounters it. Because routing was done, Exim knows which
4187 messages are waiting for which hosts, and so a number of messages for the same
4188 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4189 configuration option has the same effect for specific domains. See also the
4190 &%-qq%& option.
4191
4192 .vitem &%-oee%&
4193 .oindex "&%-oee%&"
4194 .cindex "error" "reporting"
4195 If an error is detected while a non-SMTP message is being received (for
4196 example, a malformed address), the error is reported to the sender in a mail
4197 message.
4198
4199 .cindex "return code" "for &%-oee%&"
4200 Provided
4201 this error message is successfully sent, the Exim receiving process
4202 exits with a return code of zero. If not, the return code is 2 if the problem
4203 is that the original message has no recipients, or 1 for any other error.
4204 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4205
4206 .vitem &%-oem%&
4207 .oindex "&%-oem%&"
4208 .cindex "error" "reporting"
4209 .cindex "return code" "for &%-oem%&"
4210 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4211 return code, whether or not the error message was successfully sent.
4212 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4213
4214 .vitem &%-oep%&
4215 .oindex "&%-oep%&"
4216 .cindex "error" "reporting"
4217 If an error is detected while a non-SMTP message is being received, the
4218 error is reported by writing a message to the standard error file (stderr).
4219 .cindex "return code" "for &%-oep%&"
4220 The return code is 1 for all errors.
4221
4222 .vitem &%-oeq%&
4223 .oindex "&%-oeq%&"
4224 .cindex "error" "reporting"
4225 This option is supported for compatibility with Sendmail, but has the same
4226 effect as &%-oep%&.
4227
4228 .vitem &%-oew%&
4229 .oindex "&%-oew%&"
4230 .cindex "error" "reporting"
4231 This option is supported for compatibility with Sendmail, but has the same
4232 effect as &%-oem%&.
4233
4234 .vitem &%-oi%&
4235 .oindex "&%-oi%&"
4236 .cindex "dot" "in incoming non-SMTP message"
4237 This option, which has the same effect as &%-i%&, specifies that a dot on a
4238 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4239 single dot does terminate, though Exim does no special processing for other
4240 lines that start with a dot. This option is set by default if Exim is called as
4241 &'rmail'&. See also &%-ti%&.
4242
4243 .vitem &%-oitrue%&
4244 .oindex "&%-oitrue%&"
4245 This option is treated as synonymous with &%-oi%&.
4246
4247 .vitem &%-oMa%&&~<&'host&~address'&>
4248 .oindex "&%-oMa%&"
4249 .cindex "sender" "host address, specifying for local message"
4250 A number of options starting with &%-oM%& can be used to set values associated
4251 with remote hosts on locally-submitted messages (that is, messages not received
4252 over TCP/IP). These options can be used by any caller in conjunction with the
4253 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4254 other circumstances, they are ignored unless the caller is trusted.
4255
4256 The &%-oMa%& option sets the sender host address. This may include a port
4257 number at the end, after a full stop (period). For example:
4258 .code
4259 exim -bs -oMa 10.9.8.7.1234
4260 .endd
4261 An alternative syntax is to enclose the IP address in square brackets,
4262 followed by a colon and the port number:
4263 .code
4264 exim -bs -oMa [10.9.8.7]:1234
4265 .endd
4266 The IP address is placed in the &$sender_host_address$& variable, and the
4267 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4268 are present on the command line, the sender host IP address is taken from
4269 whichever one is last.
4270
4271 .vitem &%-oMaa%&&~<&'name'&>
4272 .oindex "&%-oMaa%&"
4273 .cindex "authentication" "name, specifying for local message"
4274 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4275 option sets the value of &$sender_host_authenticated$& (the authenticator
4276 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4277 This option can be used with &%-bh%& and &%-bs%& to set up an
4278 authenticated SMTP session without actually using the SMTP AUTH command.
4279
4280 .vitem &%-oMai%&&~<&'string'&>
4281 .oindex "&%-oMai%&"
4282 .cindex "authentication" "id, specifying for local message"
4283 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4284 option sets the value of &$authenticated_id$& (the id that was authenticated).
4285 This overrides the default value (the caller's login id, except with &%-bh%&,
4286 where there is no default) for messages from local sources. See chapter
4287 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4288
4289 .vitem &%-oMas%&&~<&'address'&>
4290 .oindex "&%-oMas%&"
4291 .cindex "authentication" "sender, specifying for local message"
4292 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4293 option sets the authenticated sender value in &$authenticated_sender$&. It
4294 overrides the sender address that is created from the caller's login id for
4295 messages from local sources, except when &%-bh%& is used, when there is no
4296 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4297 specified on a MAIL command overrides this value. See chapter
4298 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4299
4300 .vitem &%-oMi%&&~<&'interface&~address'&>
4301 .oindex "&%-oMi%&"
4302 .cindex "interface" "address, specifying for local message"
4303 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4304 option sets the IP interface address value. A port number may be included,
4305 using the same syntax as for &%-oMa%&. The interface address is placed in
4306 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4307
4308 .vitem &%-oMm%&&~<&'message&~reference'&>
4309 .oindex "&%-oMm%&"
4310 .cindex "message reference" "message reference, specifying for local message"
4311 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4312 option sets the message reference, e.g. message-id, and is logged during
4313 delivery. This is useful when some kind of audit trail is required to tie
4314 messages together. The format of the message reference is checked and will
4315 abort if the format is invalid. The option will only be accepted if exim is
4316 running in trusted mode, not as any regular user.
4317
4318 The best example of a message reference is when Exim sends a bounce message.
4319 The message reference is the message-id of the original message for which Exim
4320 is sending the bounce.
4321
4322 .vitem &%-oMr%&&~<&'protocol&~name'&>
4323 .oindex "&%-oMr%&"
4324 .cindex "protocol, specifying for local message"
4325 .vindex "&$received_protocol$&"
4326 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4327 option sets the received protocol value that is stored in
4328 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4329 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4330 SMTP protocol names (see the description of &$received_protocol$& in section
4331 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4332 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4333 be set by &%-oMr%&. Repeated use of this option is not supported.
4334
4335 .vitem &%-oMs%&&~<&'host&~name'&>
4336 .oindex "&%-oMs%&"
4337 .cindex "sender" "host name, specifying for local message"
4338 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4339 option sets the sender host name in &$sender_host_name$&. When this option is
4340 present, Exim does not attempt to look up a host name from an IP address; it
4341 uses the name it is given.
4342
4343 .vitem &%-oMt%&&~<&'ident&~string'&>
4344 .oindex "&%-oMt%&"
4345 .cindex "sender" "ident string, specifying for local message"
4346 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4347 option sets the sender ident value in &$sender_ident$&. The default setting for
4348 local callers is the login id of the calling process, except when &%-bh%& is
4349 used, when there is no default.
4350
4351 .vitem &%-om%&
4352 .oindex "&%-om%&"
4353 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4354 In Sendmail, this option means &"me too"&, indicating that the sender of a
4355 message should receive a copy of the message if the sender appears in an alias
4356 expansion. Exim always does this, so the option does nothing.
4357
4358 .vitem &%-oo%&
4359 .oindex "&%-oo%&"
4360 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4361 This option is ignored. In Sendmail it specifies &"old style headers"&,
4362 whatever that means.
4363
4364 .vitem &%-oP%&&~<&'path'&>
4365 .oindex "&%-oP%&"
4366 .cindex "pid (process id)" "of daemon"
4367 .cindex "daemon" "process id (pid)"
4368 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4369 value. The option specifies the file to which the process id of the daemon is
4370 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4371 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4372 because in those cases, the normal pid file is not used.
4373
4374 .vitem &%-or%&&~<&'time'&>
4375 .oindex "&%-or%&"
4376 .cindex "timeout" "for non-SMTP input"
4377 This option sets a timeout value for incoming non-SMTP messages. If it is not
4378 set, Exim will wait forever for the standard input. The value can also be set
4379 by the &%receive_timeout%& option. The format used for specifying times is
4380 described in section &<<SECTtimeformat>>&.
4381
4382 .vitem &%-os%&&~<&'time'&>
4383 .oindex "&%-os%&"
4384 .cindex "timeout" "for SMTP input"
4385 .cindex "SMTP" "input timeout"
4386 This option sets a timeout value for incoming SMTP messages. The timeout
4387 applies to each SMTP command and block of data. The value can also be set by
4388 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4389 for specifying times is described in section &<<SECTtimeformat>>&.
4390
4391 .vitem &%-ov%&
4392 .oindex "&%-ov%&"
4393 This option has exactly the same effect as &%-v%&.
4394
4395 .vitem &%-oX%&&~<&'number&~or&~string'&>
4396 .oindex "&%-oX%&"
4397 .cindex "TCP/IP" "setting listening ports"
4398 .cindex "TCP/IP" "setting listening interfaces"
4399 .cindex "port" "receiving TCP/IP"
4400 This option is relevant only when the &%-bd%& (start listening daemon) option
4401 is also given. It controls which ports and interfaces the daemon uses. Details
4402 of the syntax, and how it interacts with configuration file options, are given
4403 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4404 file is written unless &%-oP%& is also present to specify a pid filename.
4405
4406 .vitem &%-pd%&
4407 .oindex "&%-pd%&"
4408 .cindex "Perl" "starting the interpreter"
4409 This option applies when an embedded Perl interpreter is linked with Exim (see
4410 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4411 option, forcing the starting of the interpreter to be delayed until it is
4412 needed.
4413
4414 .vitem &%-ps%&
4415 .oindex "&%-ps%&"
4416 .cindex "Perl" "starting the interpreter"
4417 This option applies when an embedded Perl interpreter is linked with Exim (see
4418 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4419 option, forcing the starting of the interpreter to occur as soon as Exim is
4420 started.
4421
4422 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4423 .oindex "&%-p%&"
4424 For compatibility with Sendmail, this option is equivalent to
4425 .display
4426 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4427 .endd
4428 It sets the incoming protocol and host name (for trusted callers). The
4429 host name and its colon can be omitted when only the protocol is to be set.
4430 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4431 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4432 or &`s`& using this option (but that does not seem a real limitation).
4433 Repeated use of this option is not supported.
4434
4435 .vitem &%-q%&
4436 .oindex "&%-q%&"
4437 .cindex "queue runner" "starting manually"
4438 This option is normally restricted to admin users. However, there is a
4439 configuration option called &%prod_requires_admin%& which can be set false to
4440 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4441 and &%-S%& options).
4442
4443 .cindex "queue runner" "description of operation"
4444 If other commandline options do not specify an action,
4445 the &%-q%& option starts one queue runner process. This scans the queue of
4446 waiting messages, and runs a delivery process for each one in turn. It waits
4447 for each delivery process to finish before starting the next one. A delivery
4448 process may not actually do any deliveries if the retry times for the addresses
4449 have not been reached. Use &%-qf%& (see below) if you want to override this.
4450
4451 If
4452 .cindex "SMTP" "passed connection"
4453 .cindex "SMTP" "multiple deliveries"
4454 .cindex "multiple SMTP deliveries"
4455 the delivery process spawns other processes to deliver other messages down
4456 passed SMTP connections, the queue runner waits for these to finish before
4457 proceeding.
4458
4459 When all the queued messages have been considered, the original queue runner
4460 process terminates. In other words, a single pass is made over the waiting
4461 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4462 this to be repeated periodically.
4463
4464 Exim processes the waiting messages in an unpredictable order. It isn't very
4465 random, but it is likely to be different each time, which is all that matters.
4466 If one particular message screws up a remote MTA, other messages to the same
4467 MTA have a chance of getting through if they get tried first.
4468
4469 It is possible to cause the messages to be processed in lexical message id
4470 order, which is essentially the order in which they arrived, by setting the
4471 &%queue_run_in_order%& option, but this is not recommended for normal use.
4472
4473 .vitem &%-q%&<&'qflags'&>
4474 The &%-q%& option may be followed by one or more flag letters that change its
4475 behaviour. They are all optional, but if more than one is present, they must
4476 appear in the correct order. Each flag is described in a separate item below.
4477
4478 .vitem &%-qq...%&
4479 .oindex "&%-qq%&"
4480 .cindex "queue" "double scanning"
4481 .cindex "queue" "routing"
4482 .cindex "routing" "whole queue before delivery"
4483 An option starting with &%-qq%& requests a two-stage queue run. In the first
4484 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4485 every domain. Addresses are routed, local deliveries happen, but no remote
4486 transports are run.
4487
4488 .cindex "hints database" "remembering routing"
4489 The hints database that remembers which messages are waiting for specific hosts
4490 is updated, as if delivery to those hosts had been deferred. After this is
4491 complete, a second, normal queue scan happens, with routing and delivery taking
4492 place as normal. Messages that are routed to the same host should mostly be
4493 delivered down a single SMTP
4494 .cindex "SMTP" "passed connection"
4495 .cindex "SMTP" "multiple deliveries"
4496 .cindex "multiple SMTP deliveries"
4497 connection because of the hints that were set up during the first queue scan.
4498 This option may be useful for hosts that are connected to the Internet
4499 intermittently.
4500
4501 .vitem &%-q[q]i...%&
4502 .oindex "&%-qi%&"
4503 .cindex "queue" "initial delivery"
4504 If the &'i'& flag is present, the queue runner runs delivery processes only for
4505 those messages that haven't previously been tried. (&'i'& stands for &"initial
4506 delivery"&.) This can be helpful if you are putting messages in the queue using
4507 &%-odq%& and want a queue runner just to process the new messages.
4508
4509 .vitem &%-q[q][i]f...%&
4510 .oindex "&%-qf%&"
4511 .cindex "queue" "forcing delivery"
4512 .cindex "delivery" "forcing in queue run"
4513 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4514 message, whereas without &'f'& only those non-frozen addresses that have passed
4515 their retry times are tried.
4516
4517 .vitem &%-q[q][i]ff...%&
4518 .oindex "&%-qff%&"
4519 .cindex "frozen messages" "forcing delivery"
4520 If &'ff'& is present, a delivery attempt is forced for every message, whether
4521 frozen or not.
4522
4523 .vitem &%-q[q][i][f[f]]l%&
4524 .oindex "&%-ql%&"
4525 .cindex "queue" "local deliveries only"
4526 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4527 be done. If a message requires any remote deliveries, it remains in the queue
4528 for later delivery.
4529
4530 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4531 .oindex "&%-qG%&"
4532 .cindex queue named
4533 .cindex "named queues"
4534 .cindex "queue" "delivering specific messages"
4535 If the &'G'& flag and a name is present, the queue runner operates on the
4536 queue with the given name rather than the default queue.
4537 The name should not contain a &'/'& character.
4538 For a periodic queue run (see below)
4539 append to the name a slash and a time value.
4540
4541 If other commandline options specify an action, a &'-qG<name>'& option
4542 will specify a queue to operate on.
4543 For example:
4544 .code
4545 exim -bp -qGquarantine
4546 mailq -qGquarantine
4547 exim -qGoffpeak -Rf @special.domain.example
4548 .endd
4549
4550 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4551 When scanning the queue, Exim can be made to skip over messages whose ids are
4552 lexically less than a given value by following the &%-q%& option with a
4553 starting message id. For example:
4554 .code
4555 exim -q 0t5C6f-0000c8-00
4556 .endd
4557 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4558 second message id is given, messages whose ids are lexically greater than it
4559 are also skipped. If the same id is given twice, for example,
4560 .code
4561 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4562 .endd
4563 just one delivery process is started, for that message. This differs from
4564 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4565 that it counts as a delivery from a queue run. Note that the selection
4566 mechanism does not affect the order in which the messages are scanned. There
4567 are also other ways of selecting specific sets of messages for delivery in a
4568 queue run &-- see &%-R%& and &%-S%&.
4569
4570 .vitem &%-q%&<&'qflags'&><&'time'&>
4571 .cindex "queue runner" "starting periodically"
4572 .cindex "periodic queue running"
4573 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4574 starting a queue runner process at intervals specified by the given time value
4575 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4576 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4577 single daemon process handles both functions. A common way of starting up a
4578 combined daemon at system boot time is to use a command such as
4579 .code
4580 /usr/exim/bin/exim -bd -q30m
4581 .endd
4582 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4583 process every 30 minutes.
4584
4585 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4586 pid file is written unless one is explicitly requested by the &%-oP%& option.
4587
4588 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4589 .oindex "&%-qR%&"
4590 This option is synonymous with &%-R%&. It is provided for Sendmail
4591 compatibility.
4592
4593 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4594 .oindex "&%-qS%&"
4595 This option is synonymous with &%-S%&.
4596
4597 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4598 .oindex "&%-R%&"
4599 .cindex "queue runner" "for specific recipients"
4600 .cindex "delivery" "to given domain"
4601 .cindex "domain" "delivery to"
4602 The <&'rsflags'&> may be empty, in which case the white space before the string
4603 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4604 which are the possible values for <&'rsflags'&>. White space is required if
4605 <&'rsflags'&> is not empty.
4606
4607 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4608 perform a single queue run, except that, when scanning the messages on the
4609 queue, Exim processes only those that have at least one undelivered recipient
4610 address containing the given string, which is checked in a case-independent
4611 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4612 regular expression; otherwise it is a literal string.
4613
4614 If you want to do periodic queue runs for messages with specific recipients,
4615 you can combine &%-R%& with &%-q%& and a time value. For example:
4616 .code
4617 exim -q25m -R @special.domain.example
4618 .endd
4619 This example does a queue run for messages with recipients in the given domain
4620 every 25 minutes. Any additional flags that are specified with &%-q%& are
4621 applied to each queue run.
4622
4623 Once a message is selected for delivery by this mechanism, all its addresses
4624 are processed. For the first selected message, Exim overrides any retry
4625 information and forces a delivery attempt for each undelivered address. This
4626 means that if delivery of any address in the first message is successful, any
4627 existing retry information is deleted, and so delivery attempts for that
4628 address in subsequently selected messages (which are processed without forcing)
4629 will run. However, if delivery of any address does not succeed, the retry
4630 information is updated, and in subsequently selected messages, the failing
4631 address will be skipped.
4632
4633 .cindex "frozen messages" "forcing delivery"
4634 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4635 all selected messages, not just the first; frozen messages are included when
4636 &'ff'& is present.
4637
4638 The &%-R%& option makes it straightforward to initiate delivery of all messages
4639 to a given domain after a host has been down for some time. When the SMTP
4640 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4641 effect is to run Exim with the &%-R%& option, but it can be configured to run
4642 an arbitrary command instead.
4643
4644 .vitem &%-r%&
4645 .oindex "&%-r%&"
4646 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4647
4648 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4649 .oindex "&%-S%&"
4650 .cindex "delivery" "from given sender"
4651 .cindex "queue runner" "for specific senders"
4652 This option acts like &%-R%& except that it checks the string against each
4653 message's sender instead of against the recipients. If &%-R%& is also set, both
4654 conditions must be met for a message to be selected. If either of the options
4655 has &'f'& or &'ff'& in its flags, the associated action is taken.
4656
4657 .vitem &%-Tqt%&&~<&'times'&>
4658 .oindex "&%-Tqt%&"
4659 This is an option that is exclusively for use by the Exim testing suite. It is not
4660 recognized when Exim is run normally. It allows for the setting up of explicit
4661 &"queue times"& so that various warning/retry features can be tested.
4662
4663 .vitem &%-t%&
4664 .oindex "&%-t%&"
4665 .cindex "recipient" "extracting from header lines"
4666 .cindex "&'Bcc:'& header line"
4667 .cindex "&'Cc:'& header line"
4668 .cindex "&'To:'& header line"
4669 When Exim is receiving a locally-generated, non-SMTP message on its standard
4670 input, the &%-t%& option causes the recipients of the message to be obtained
4671 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4672 from the command arguments. The addresses are extracted before any rewriting
4673 takes place and the &'Bcc:'& header line, if present, is then removed.
4674
4675 .cindex "Sendmail compatibility" "&%-t%& option"
4676 If the command has any arguments, they specify addresses to which the message
4677 is &'not'& to be delivered. That is, the argument addresses are removed from
4678 the recipients list obtained from the headers. This is compatible with Smail 3
4679 and in accordance with the documented behaviour of several versions of
4680 Sendmail, as described in man pages on a number of operating systems (e.g.
4681 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4682 argument addresses to those obtained from the headers, and the O'Reilly
4683 Sendmail book documents it that way. Exim can be made to add argument addresses
4684 instead of subtracting them by setting the option
4685 &%extract_addresses_remove_arguments%& false.
4686
4687 .cindex "&%Resent-%& header lines" "with &%-t%&"
4688 If there are any &%Resent-%& header lines in the message, Exim extracts
4689 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4690 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4691 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4692 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4693
4694 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4695 message is resent several times). The RFC also specifies that they should be
4696 added at the front of the message, and separated by &'Received:'& lines. It is
4697 not at all clear how &%-t%& should operate in the present of multiple sets,
4698 nor indeed exactly what constitutes a &"set"&.
4699 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4700 are often added at the end of the header, and if a message is resent more than
4701 once, it is common for the original set of &%Resent-%& headers to be renamed as
4702 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4703
4704 .vitem &%-ti%&
4705 .oindex "&%-ti%&"
4706 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4707 compatibility with Sendmail.
4708
4709 .vitem &%-tls-on-connect%&
4710 .oindex "&%-tls-on-connect%&"
4711 .cindex "TLS" "use without STARTTLS"
4712 .cindex "TLS" "automatic start"
4713 This option is available when Exim is compiled with TLS support. It forces all
4714 incoming SMTP connections to behave as if the incoming port is listed in the
4715 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4716 &<<CHAPTLS>>& for further details.
4717
4718
4719 .vitem &%-U%&
4720 .oindex "&%-U%&"
4721 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4722 Sendmail uses this option for &"initial message submission"&, and its
4723 documentation states that in future releases, it may complain about
4724 syntactically invalid messages rather than fixing them when this flag is not
4725 set. Exim ignores this option.
4726
4727 .vitem &%-v%&
4728 .oindex "&%-v%&"
4729 This option causes Exim to write information to the standard error stream,
4730 describing what it is doing. In particular, it shows the log lines for
4731 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4732 dialogue is shown. Some of the log lines shown may not actually be written to
4733 the log if the setting of &%log_selector%& discards them. Any relevant
4734 selectors are shown with each log line. If none are shown, the logging is
4735 unconditional.
4736
4737 .vitem &%-x%&
4738 .oindex "&%-x%&"
4739 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4740 National Language Support extended characters in the body of the mail item"&).
4741 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4742 this option.
4743
4744 .vitem &%-X%&&~<&'logfile'&>
4745 .oindex "&%-X%&"
4746 This option is interpreted by Sendmail to cause debug information to be sent
4747 to the named file.  It is ignored by Exim.
4748
4749 .vitem &%-z%&&~<&'log-line'&>
4750 .oindex "&%-z%&"
4751 This option writes its argument to Exim's logfile.
4752 Use is restricted to administrators; the intent is for operational notes.
4753 Quotes should be used to maintain a multi-word item as a single argument,
4754 under most shells.
4755 .endlist
4756
4757 .ecindex IIDclo1
4758 .ecindex IIDclo2
4759
4760
4761 . ////////////////////////////////////////////////////////////////////////////
4762 . Insert a stylized DocBook comment here, to identify the end of the command
4763 . line options. This is for the benefit of the Perl script that automatically
4764 . creates a man page for the options.
4765 . ////////////////////////////////////////////////////////////////////////////
4766
4767 .literal xml
4768 <!-- === End of command line options === -->
4769 .literal off
4770
4771
4772
4773
4774
4775 . ////////////////////////////////////////////////////////////////////////////
4776 . ////////////////////////////////////////////////////////////////////////////
4777
4778
4779 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4780          "The runtime configuration file"
4781
4782 .cindex "runtime configuration"
4783 .cindex "configuration file" "general description"
4784 .cindex "CONFIGURE_FILE"
4785 .cindex "configuration file" "errors in"
4786 .cindex "error" "in configuration file"
4787 .cindex "return code" "for bad configuration"
4788 Exim uses a single runtime configuration file that is read whenever an Exim
4789 binary is executed. Note that in normal operation, this happens frequently,
4790 because Exim is designed to operate in a distributed manner, without central
4791 control.
4792
4793 If a syntax error is detected while reading the configuration file, Exim
4794 writes a message on the standard error, and exits with a non-zero return code.
4795 The message is also written to the panic log. &*Note*&: Only simple syntax
4796 errors can be detected at this time. The values of any expanded options are
4797 not checked until the expansion happens, even when the expansion does not
4798 actually alter the string.
4799
4800 The name of the configuration file is compiled into the binary for security
4801 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4802 most configurations, this specifies a single file. However, it is permitted to
4803 give a colon-separated list of filenames, in which case Exim uses the first
4804 existing file in the list.
4805
4806 .cindex "EXIM_USER"
4807 .cindex "EXIM_GROUP"
4808 .cindex "CONFIGURE_OWNER"
4809 .cindex "CONFIGURE_GROUP"
4810 .cindex "configuration file" "ownership"
4811 .cindex "ownership" "configuration file"
4812 The runtime configuration file must be owned by root or by the user that is
4813 specified at compile time by the CONFIGURE_OWNER option (if set). The
4814 configuration file must not be world-writeable, or group-writeable unless its
4815 group is the root group or the one specified at compile time by the
4816 CONFIGURE_GROUP option.
4817
4818 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4819 to root, anybody who is able to edit the runtime configuration file has an
4820 easy way to run commands as root. If you specify a user or group in the
4821 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4822 who are members of that group will trivially be able to obtain root privileges.
4823
4824 Up to Exim version 4.72, the runtime configuration file was also permitted to
4825 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4826 since it offered a simple privilege escalation for any attacker who managed to
4827 compromise the Exim user account.
4828
4829 A default configuration file, which will work correctly in simple situations,
4830 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4831 defines just one filename, the installation process copies the default
4832 configuration to a new file of that name if it did not previously exist. If
4833 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4834 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4835 configuration.
4836
4837
4838
4839 .section "Using a different configuration file" "SECID40"
4840 .cindex "configuration file" "alternate"
4841 A one-off alternate configuration can be specified by the &%-C%& command line
4842 option, which may specify a single file or a list of files. However, when
4843 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4844 unless the argument for &%-C%& is identical to the built-in value from
4845 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4846 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4847 is useful mainly for checking the syntax of configuration files before
4848 installing them. No owner or group checks are done on a configuration file
4849 specified by &%-C%&, if root privilege has been dropped.
4850
4851 Even the Exim user is not trusted to specify an arbitrary configuration file
4852 with the &%-C%& option to be used with root privileges, unless that file is
4853 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4854 testing a configuration using &%-C%& right through message reception and
4855 delivery, even if the caller is root. The reception works, but by that time,
4856 Exim is running as the Exim user, so when it re-execs to regain privilege for
4857 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4858 can test reception and delivery using two separate commands (one to put a
4859 message in the queue, using &%-odq%&, and another to do the delivery, using
4860 &%-M%&).
4861
4862 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4863 prefix string with which any file named in a &%-C%& command line option must
4864 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4865 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4866 filename can be used with &%-C%&.
4867
4868 One-off changes to a configuration can be specified by the &%-D%& command line
4869 option, which defines and overrides values for macros used inside the
4870 configuration file. However, like &%-C%&, the use of this option by a
4871 non-privileged user causes Exim to discard its root privilege.
4872 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4873 completely disabled, and its use causes an immediate error exit.
4874
4875 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4876 to declare certain macro names trusted, such that root privilege will not
4877 necessarily be discarded.
4878 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4879 considered safe and, if &%-D%& only supplies macros from this list, and the
4880 values are acceptable, then Exim will not give up root privilege if the caller
4881 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4882 transition mechanism and is expected to be removed in the future.  Acceptable
4883 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4884
4885 Some sites may wish to use the same Exim binary on different machines that
4886 share a file system, but to use different configuration files on each machine.
4887 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4888 looks for a file whose name is the configuration filename followed by a dot
4889 and the machine's node name, as obtained from the &[uname()]& function. If this
4890 file does not exist, the standard name is tried. This processing occurs for
4891 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4892
4893 In some esoteric situations different versions of Exim may be run under
4894 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4895 help with this. See the comments in &_src/EDITME_& for details.
4896
4897
4898
4899 .section "Configuration file format" "SECTconffilfor"
4900 .cindex "configuration file" "format of"
4901 .cindex "format" "configuration file"
4902 Exim's configuration file is divided into a number of different parts. General
4903 option settings must always appear at the start of the file. The other parts
4904 are all optional, and may appear in any order. Each part other than the first
4905 is introduced by the word &"begin"& followed by at least one literal
4906 space, and the name of the part. The optional parts are:
4907
4908 .ilist
4909 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4910 &<<CHAPACL>>&).
4911 .next
4912 .cindex "AUTH" "configuration"
4913 &'authenticators'&: Configuration settings for the authenticator drivers. These
4914 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4915 .next
4916 &'routers'&: Configuration settings for the router drivers. Routers process
4917 addresses and determine how the message is to be delivered (see chapters
4918 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4919 .next
4920 &'transports'&: Configuration settings for the transport drivers. Transports
4921 define mechanisms for copying messages to destinations (see chapters
4922 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4923 .next
4924 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4925 If there is no retry section, or if it is empty (that is, no retry rules are
4926 defined), Exim will not retry deliveries. In this situation, temporary errors
4927 are treated the same as permanent errors. Retry rules are discussed in chapter
4928 &<<CHAPretry>>&.
4929 .next
4930 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4931 when new addresses are generated during delivery. Rewriting is discussed in
4932 chapter &<<CHAPrewrite>>&.
4933 .next
4934 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4935 want to use this feature, you must set
4936 .code
4937 LOCAL_SCAN_HAS_OPTIONS=yes
4938 .endd
4939 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4940 facility are given in chapter &<<CHAPlocalscan>>&.
4941 .endlist
4942
4943 .cindex "configuration file" "leading white space in"
4944 .cindex "configuration file" "trailing white space in"
4945 .cindex "white space" "in configuration file"
4946 Leading and trailing white space in configuration lines is always ignored.
4947
4948 Blank lines in the file, and lines starting with a # character (ignoring
4949 leading white space) are treated as comments and are ignored. &*Note*&: A
4950 # character other than at the beginning of a line is not treated specially,
4951 and does not introduce a comment.
4952
4953 Any non-comment line can be continued by ending it with a backslash. Note that
4954 the general rule for white space means that trailing white space after the
4955 backslash and leading white space at the start of continuation
4956 lines is ignored. Comment lines beginning with # (but not empty lines) may
4957 appear in the middle of a sequence of continuation lines.
4958
4959 A convenient way to create a configuration file is to start from the
4960 default, which is supplied in &_src/configure.default_&, and add, delete, or
4961 change settings as required.
4962
4963 The ACLs, retry rules, and rewriting rules have their own syntax which is
4964 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4965 respectively. The other parts of the configuration file have some syntactic
4966 items in common, and these are described below, from section &<<SECTcos>>&
4967 onwards. Before that, the inclusion, macro, and conditional facilities are
4968 described.
4969
4970
4971
4972 .section "File inclusions in the configuration file" "SECID41"
4973 .cindex "inclusions in configuration file"
4974 .cindex "configuration file" "including other files"
4975 .cindex "&`.include`& in configuration file"
4976 .cindex "&`.include_if_exists`& in configuration file"
4977 You can include other files inside Exim's runtime configuration file by
4978 using this syntax:
4979 .display
4980 &`.include`& <&'filename'&>
4981 &`.include_if_exists`& <&'filename'&>
4982 .endd
4983 on a line by itself. Double quotes round the filename are optional. If you use
4984 the first form, a configuration error occurs if the file does not exist; the
4985 second form does nothing for non-existent files.
4986 The first form allows a relative name. It is resolved relative to
4987 the directory of the including file. For the second form an absolute filename
4988 is required.
4989
4990 Includes may be nested to any depth, but remember that Exim reads its
4991 configuration file often, so it is a good idea to keep them to a minimum.
4992 If you change the contents of an included file, you must HUP the daemon,
4993 because an included file is read only when the configuration itself is read.
4994
4995 The processing of inclusions happens early, at a physical line level, so, like
4996 comment lines, an inclusion can be used in the middle of an option setting,
4997 for example:
4998 .code
4999 hosts_lookup = a.b.c \
5000                .include /some/file
5001 .endd
5002 Include processing happens after macro processing (see below). Its effect is to
5003 process the lines of the included file as if they occurred inline where the
5004 inclusion appears.
5005
5006
5007
5008 .section "Macros in the configuration file" "SECTmacrodefs"
5009 .cindex "macro" "description of"
5010 .cindex "configuration file" "macros"
5011 If a line in the main part of the configuration (that is, before the first
5012 &"begin"& line) begins with an upper case letter, it is taken as a macro
5013 definition, and must be of the form
5014 .display
5015 <&'name'&> = <&'rest of line'&>
5016 .endd
5017 The name must consist of letters, digits, and underscores, and need not all be
5018 in upper case, though that is recommended. The rest of the line, including any
5019 continuations, is the replacement text, and has leading and trailing white
5020 space removed. Quotes are not removed. The replacement text can never end with
5021 a backslash character, but this doesn't seem to be a serious limitation.
5022
5023 Macros may also be defined between router, transport, authenticator, or ACL
5024 definitions. They may not, however, be defined within an individual driver or
5025 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5026
5027 .section "Macro substitution" "SECID42"
5028 Once a macro is defined, all subsequent lines in the file (and any included
5029 files) are scanned for the macro name; if there are several macros, the line is
5030 scanned for each, in turn, in the order in which the macros are defined. The
5031 replacement text is not re-scanned for the current macro, though it is scanned
5032 for subsequently defined macros. For this reason, a macro name may not contain
5033 the name of a previously defined macro as a substring. You could, for example,
5034 define
5035 .display
5036 &`ABCD_XYZ = `&<&'something'&>
5037 &`ABCD = `&<&'something else'&>
5038 .endd
5039 but putting the definitions in the opposite order would provoke a configuration
5040 error. Macro expansion is applied to individual physical lines from the file,
5041 before checking for line continuation or file inclusion (see above). If a line
5042 consists solely of a macro name, and the expansion of the macro is empty, the
5043 line is ignored. A macro at the start of a line may turn the line into a
5044 comment line or a &`.include`& line.
5045
5046
5047 .section "Redefining macros" "SECID43"
5048 Once defined, the value of a macro can be redefined later in the configuration
5049 (or in an included file). Redefinition is specified by using &'=='& instead of
5050 &'='&. For example:
5051 .code
5052 MAC =  initial value
5053 ...
5054 MAC == updated value
5055 .endd
5056 Redefinition does not alter the order in which the macros are applied to the
5057 subsequent lines of the configuration file. It is still the same order in which
5058 the macros were originally defined. All that changes is the macro's value.
5059 Redefinition makes it possible to accumulate values. For example:
5060 .code
5061 MAC =  initial value
5062 ...
5063 MAC == MAC and something added
5064 .endd
5065 This can be helpful in situations where the configuration file is built
5066 from a number of other files.
5067
5068 .section "Overriding macro values" "SECID44"
5069 The values set for macros in the configuration file can be overridden by the
5070 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5071 used, unless called by root or the Exim user. A definition on the command line
5072 using the &%-D%& option causes all definitions and redefinitions within the
5073 file to be ignored.
5074
5075
5076
5077 .section "Example of macro usage" "SECID45"
5078 As an example of macro usage, consider a configuration where aliases are looked
5079 up in a MySQL database. It helps to keep the file less cluttered if long
5080 strings such as SQL statements are defined separately as macros, for example:
5081 .code
5082 ALIAS_QUERY = select mailbox from user where \
5083               login='${quote_mysql:$local_part}';
5084 .endd
5085 This can then be used in a &(redirect)& router setting like this:
5086 .code
5087 data = ${lookup mysql{ALIAS_QUERY}}
5088 .endd
5089 In earlier versions of Exim macros were sometimes used for domain, host, or
5090 address lists. In Exim 4 these are handled better by named lists &-- see
5091 section &<<SECTnamedlists>>&.
5092
5093
5094 .section "Builtin macros" "SECTbuiltinmacros"
5095 Exim defines some macros depending on facilities available, which may
5096 differ due to build-time definitions and from one release to another.
5097 All of these macros start with an underscore.
5098 They can be used to conditionally include parts of a configuration
5099 (see below).
5100
5101 The following classes of macros are defined:
5102 .display
5103 &` _HAVE_*                    `&  build-time defines
5104 &` _DRIVER_ROUTER_*           `&  router drivers
5105 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5106 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5107 &` _LOG_*                     `&  log_selector values
5108 &` _OPT_MAIN_*                `&  main config options
5109 &` _OPT_ROUTERS_*             `&  generic router options
5110 &` _OPT_TRANSPORTS_*          `&  generic transport options
5111 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5112 &` _OPT_ROUTER_*_*            `&  private router options
5113 &` _OPT_TRANSPORT_*_*         `&  private transport options
5114 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5115 .endd
5116
5117 Use an &"exim -bP macros"& command to get the list of macros.
5118
5119
5120 .section "Conditional skips in the configuration file" "SECID46"
5121 .cindex "configuration file" "conditional skips"
5122 .cindex "&`.ifdef`&"
5123 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5124 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5125 portions of the configuration file. The processing happens whenever the file is
5126 read (that is, when an Exim binary starts to run).
5127
5128 The implementation is very simple. Instances of the first four directives must
5129 be followed by text that includes the names of one or macros. The condition
5130 that is tested is whether or not any macro substitution has taken place in the
5131 line. Thus:
5132 .code
5133 .ifdef AAA
5134 message_size_limit = 50M
5135 .else
5136 message_size_limit = 100M
5137 .endif
5138 .endd
5139 sets a message size limit of 50M if the macro &`AAA`& is defined
5140 (or &`A`& or &`AA`&), and 100M
5141 otherwise. If there is more than one macro named on the line, the condition
5142 is true if any of them are defined. That is, it is an &"or"& condition. To
5143 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5144
5145 Although you can use a macro expansion to generate one of these directives,
5146 it is not very useful, because the condition &"there was a macro substitution
5147 in this line"& will always be true.
5148
5149 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5150 to clarify complicated nestings.
5151
5152
5153
5154 .section "Common option syntax" "SECTcos"
5155 .cindex "common option syntax"
5156 .cindex "syntax of common options"
5157 .cindex "configuration file" "common option syntax"
5158 For the main set of options, driver options, and &[local_scan()]& options,
5159 each setting is on a line by itself, and starts with a name consisting of
5160 lower-case letters and underscores. Many options require a data value, and in
5161 these cases the name must be followed by an equals sign (with optional white
5162 space) and then the value. For example:
5163 .code
5164 qualify_domain = mydomain.example.com
5165 .endd
5166 .cindex "hiding configuration option values"
5167 .cindex "configuration options" "hiding value of"
5168 .cindex "options" "hiding value of"
5169 Some option settings may contain sensitive data, for example, passwords for
5170 accessing databases. To stop non-admin users from using the &%-bP%& command
5171 line option to read these values, you can precede the option settings with the
5172 word &"hide"&. For example:
5173 .code
5174 hide mysql_servers = localhost/users/admin/secret-password
5175 .endd
5176 For non-admin users, such options are displayed like this:
5177 .code
5178 mysql_servers = <value not displayable>
5179 .endd
5180 If &"hide"& is used on a driver option, it hides the value of that option on
5181 all instances of the same driver.
5182
5183 The following sections describe the syntax used for the different data types
5184 that are found in option settings.
5185
5186
5187 .section "Boolean options" "SECID47"
5188 .cindex "format" "boolean"
5189 .cindex "boolean configuration values"
5190 .oindex "&%no_%&&'xxx'&"
5191 .oindex "&%not_%&&'xxx'&"
5192 Options whose type is given as boolean are on/off switches. There are two
5193 different ways of specifying such options: with and without a data value. If
5194 the option name is specified on its own without data, the switch is turned on;
5195 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5196 boolean options may be followed by an equals sign and one of the words
5197 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5198 the following two settings have exactly the same effect:
5199 .code
5200 queue_only
5201 queue_only = true
5202 .endd
5203 The following two lines also have the same (opposite) effect:
5204 .code
5205 no_queue_only
5206 queue_only = false
5207 .endd
5208 You can use whichever syntax you prefer.
5209
5210
5211
5212
5213 .section "Integer values" "SECID48"
5214 .cindex "integer configuration values"
5215 .cindex "format" "integer"
5216 If an option's type is given as &"integer"&, the value can be given in decimal,
5217 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5218 number is assumed. Otherwise, it is treated as an octal number unless it starts
5219 with the characters &"0x"&, in which case the remainder is interpreted as a
5220 hexadecimal number.
5221
5222 If an integer value is followed by the letter K, it is multiplied by 1024; if
5223 it is followed by the letter M, it is multiplied by 1024x1024;
5224 if by the letter G, 1024x1024x1024.
5225 When the values
5226 of integer option settings are output, values which are an exact multiple of
5227 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5228 and M. The printing style is independent of the actual input format that was
5229 used.
5230
5231
5232 .section "Octal integer values" "SECID49"
5233 .cindex "integer format"
5234 .cindex "format" "octal integer"
5235 If an option's type is given as &"octal integer"&, its value is always
5236 interpreted as an octal number, whether or not it starts with the digit zero.
5237 Such options are always output in octal.
5238
5239
5240 .section "Fixed point numbers" "SECID50"
5241 .cindex "fixed point configuration values"
5242 .cindex "format" "fixed point"
5243 If an option's type is given as &"fixed-point"&, its value must be a decimal
5244 integer, optionally followed by a decimal point and up to three further digits.
5245
5246
5247
5248 .section "Time intervals" "SECTtimeformat"
5249 .cindex "time interval" "specifying in configuration"
5250 .cindex "format" "time interval"
5251 A time interval is specified as a sequence of numbers, each followed by one of
5252 the following letters, with no intervening white space:
5253
5254 .table2 30pt
5255 .irow &%s%& seconds
5256 .irow &%m%& minutes
5257 .irow &%h%& hours
5258 .irow &%d%& days
5259 .irow &%w%& weeks
5260 .endtable
5261
5262 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5263 intervals are output in the same format. Exim does not restrict the values; it
5264 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5265
5266
5267
5268 .section "String values" "SECTstrings"
5269 .cindex "string" "format of configuration values"
5270 .cindex "format" "string"
5271 If an option's type is specified as &"string"&, the value can be specified with
5272 or without double-quotes. If it does not start with a double-quote, the value
5273 consists of the remainder of the line plus any continuation lines, starting at
5274 the first character after any leading white space, with trailing white space
5275 removed, and with no interpretation of the characters in the string. Because
5276 Exim removes comment lines (those beginning with #) at an early stage, they can
5277 appear in the middle of a multi-line string. The following two settings are
5278 therefore equivalent:
5279 .code
5280 trusted_users = uucp:mail
5281 trusted_users = uucp:\
5282                 # This comment line is ignored
5283                 mail
5284 .endd
5285 .cindex "string" "quoted"
5286 .cindex "escape characters in quoted strings"
5287 If a string does start with a double-quote, it must end with a closing
5288 double-quote, and any backslash characters other than those used for line
5289 continuation are interpreted as escape characters, as follows:
5290
5291 .table2 100pt
5292 .irow &`\\`&                     "single backslash"
5293 .irow &`\n`&                     "newline"
5294 .irow &`\r`&                     "carriage return"
5295 .irow &`\t`&                     "tab"
5296 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5297 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5298                                    character"
5299 .endtable
5300
5301 If a backslash is followed by some other character, including a double-quote
5302 character, that character replaces the pair.
5303
5304 Quoting is necessary only if you want to make use of the backslash escapes to
5305 insert special characters, or if you need to specify a value with leading or
5306 trailing spaces. These cases are rare, so quoting is almost never needed in
5307 current versions of Exim. In versions of Exim before 3.14, quoting was required
5308 in order to continue lines, so you may come across older configuration files
5309 and examples that apparently quote unnecessarily.
5310
5311
5312 .section "Expanded strings" "SECID51"
5313 .cindex "expansion" "definition of"
5314 Some strings in the configuration file are subjected to &'string expansion'&,
5315 by which means various parts of the string may be changed according to the
5316 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5317 is as just described; in particular, the handling of backslashes in quoted
5318 strings is done as part of the input process, before expansion takes place.
5319 However, backslash is also an escape character for the expander, so any
5320 backslashes that are required for that reason must be doubled if they are
5321 within a quoted configuration string.
5322
5323
5324 .section "User and group names" "SECID52"
5325 .cindex "user name" "format of"
5326 .cindex "format" "user name"
5327 .cindex "groups" "name format"
5328 .cindex "format" "group name"
5329 User and group names are specified as strings, using the syntax described
5330 above, but the strings are interpreted specially. A user or group name must
5331 either consist entirely of digits, or be a name that can be looked up using the
5332 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5333
5334
5335 .section "List construction" "SECTlistconstruct"
5336 .cindex "list" "syntax of in configuration"
5337 .cindex "format" "list item in configuration"
5338 .cindex "string" "list, definition of"
5339 The data for some configuration options is a list of items, with colon as the
5340 default separator. Many of these options are shown with type &"string list"& in
5341 the descriptions later in this document. Others are listed as &"domain list"&,
5342 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5343 are all the same; however, those other than &"string list"& are subject to
5344 particular kinds of interpretation, as described in chapter
5345 &<<CHAPdomhosaddlists>>&.
5346
5347 In all these cases, the entire list is treated as a single string as far as the
5348 input syntax is concerned. The &%trusted_users%& setting in section
5349 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5350 in a list, it must be entered as two colons. Leading and trailing white space
5351 on each item in a list is ignored. This makes it possible to include items that
5352 start with a colon, and in particular, certain forms of IPv6 address. For
5353 example, the list
5354 .code
5355 local_interfaces = 127.0.0.1 : ::::1
5356 .endd
5357 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5358
5359 &*Note*&: Although leading and trailing white space is ignored in individual
5360 list items, it is not ignored when parsing the list. The space after the first
5361 colon in the example above is necessary. If it were not there, the list would
5362 be interpreted as the two items 127.0.0.1:: and 1.
5363
5364 .section "Changing list separators" "SECTlistsepchange"
5365 .cindex "list separator" "changing"
5366 .cindex "IPv6" "addresses in lists"
5367 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5368 introduced to allow the separator character to be changed. If a list begins
5369 with a left angle bracket, followed by any punctuation character, that
5370 character is used instead of colon as the list separator. For example, the list
5371 above can be rewritten to use a semicolon separator like this:
5372 .code
5373 local_interfaces = <; 127.0.0.1 ; ::1
5374 .endd
5375 This facility applies to all lists, with the exception of the list in
5376 &%log_file_path%&. It is recommended that the use of non-colon separators be
5377 confined to circumstances where they really are needed.
5378
5379 .cindex "list separator" "newline as"
5380 .cindex "newline" "as list separator"
5381 It is also possible to use newline and other control characters (those with
5382 code values less than 32, plus DEL) as separators in lists. Such separators
5383 must be provided literally at the time the list is processed. For options that
5384 are string-expanded, you can write the separator using a normal escape
5385 sequence. This will be processed by the expander before the string is
5386 interpreted as a list. For example, if a newline-separated list of domains is
5387 generated by a lookup, you can process it directly by a line such as this:
5388 .code
5389 domains = <\n ${lookup mysql{.....}}
5390 .endd
5391 This avoids having to change the list separator in such data. You are unlikely
5392 to want to use a control character as a separator in an option that is not
5393 expanded, because the value is literal text. However, it can be done by giving
5394 the value in quotes. For example:
5395 .code
5396 local_interfaces = "<\n 127.0.0.1 \n ::1"
5397 .endd
5398 Unlike printing character separators, which can be included in list items by
5399 doubling, it is not possible to include a control character as data when it is
5400 set as the separator. Two such characters in succession are interpreted as
5401 enclosing an empty list item.
5402
5403
5404
5405 .section "Empty items in lists" "SECTempitelis"
5406 .cindex "list" "empty item in"
5407 An empty item at the end of a list is always ignored. In other words, trailing
5408 separator characters are ignored. Thus, the list in
5409 .code
5410 senders = user@domain :
5411 .endd
5412 contains only a single item. If you want to include an empty string as one item
5413 in a list, it must not be the last item. For example, this list contains three
5414 items, the second of which is empty:
5415 .code
5416 senders = user1@domain : : user2@domain
5417 .endd
5418 &*Note*&: There must be white space between the two colons, as otherwise they
5419 are interpreted as representing a single colon data character (and the list
5420 would then contain just one item). If you want to specify a list that contains
5421 just one, empty item, you can do it as in this example:
5422 .code
5423 senders = :
5424 .endd
5425 In this case, the first item is empty, and the second is discarded because it
5426 is at the end of the list.
5427
5428
5429
5430
5431 .section "Format of driver configurations" "SECTfordricon"
5432 .cindex "drivers" "configuration format"
5433 There are separate parts in the configuration for defining routers, transports,
5434 and authenticators. In each part, you are defining a number of driver
5435 instances, each with its own set of options. Each driver instance is defined by
5436 a sequence of lines like this:
5437 .display
5438 <&'instance name'&>:
5439   <&'option'&>
5440   ...
5441   <&'option'&>
5442 .endd
5443 In the following example, the instance name is &(localuser)&, and it is
5444 followed by three options settings:
5445 .code
5446 localuser:
5447   driver = accept
5448   check_local_user
5449   transport = local_delivery
5450 .endd
5451 For each driver instance, you specify which Exim code module it uses &-- by the
5452 setting of the &%driver%& option &-- and (optionally) some configuration
5453 settings. For example, in the case of transports, if you want a transport to
5454 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5455 a local file you would use the &(appendfile)& driver. Each of the drivers is
5456 described in detail in its own separate chapter later in this manual.
5457
5458 You can have several routers, transports, or authenticators that are based on
5459 the same underlying driver (each must have a different instance name).
5460
5461 The order in which routers are defined is important, because addresses are
5462 passed to individual routers one by one, in order. The order in which
5463 transports are defined does not matter at all. The order in which
5464 authenticators are defined is used only when Exim, as a client, is searching
5465 them to find one that matches an authentication mechanism offered by the
5466 server.
5467
5468 .cindex "generic options"
5469 .cindex "options" "generic &-- definition of"
5470 Within a driver instance definition, there are two kinds of option: &'generic'&
5471 and &'private'&. The generic options are those that apply to all drivers of the
5472 same type (that is, all routers, all transports or all authenticators). The
5473 &%driver%& option is a generic option that must appear in every definition.
5474 .cindex "private options"
5475 The private options are special for each driver, and none need appear, because
5476 they all have default values.
5477
5478 The options may appear in any order, except that the &%driver%& option must
5479 precede any private options, since these depend on the particular driver. For
5480 this reason, it is recommended that &%driver%& always be the first option.
5481
5482 Driver instance names, which are used for reference in log entries and
5483 elsewhere, can be any sequence of letters, digits, and underscores (starting
5484 with a letter) and must be unique among drivers of the same type. A router and
5485 a transport (for example) can each have the same name, but no two router
5486 instances can have the same name. The name of a driver instance should not be
5487 confused with the name of the underlying driver module. For example, the
5488 configuration lines:
5489 .code
5490 remote_smtp:
5491   driver = smtp
5492 .endd
5493 create an instance of the &(smtp)& transport driver whose name is
5494 &(remote_smtp)&. The same driver code can be used more than once, with
5495 different instance names and different option settings each time. A second
5496 instance of the &(smtp)& transport, with different options, might be defined
5497 thus:
5498 .code
5499 special_smtp:
5500   driver = smtp
5501   port = 1234
5502   command_timeout = 10s
5503 .endd
5504 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5505 these transport instances from routers, and these names would appear in log
5506 lines.
5507
5508 Comment lines may be present in the middle of driver specifications. The full
5509 list of option settings for any particular driver instance, including all the
5510 defaulted values, can be extracted by making use of the &%-bP%& command line
5511 option.
5512
5513
5514
5515
5516
5517
5518 . ////////////////////////////////////////////////////////////////////////////
5519 . ////////////////////////////////////////////////////////////////////////////
5520
5521 .chapter "The default configuration file" "CHAPdefconfil"
5522 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5523 .cindex "default" "configuration file &""walk through""&"
5524 The default configuration file supplied with Exim as &_src/configure.default_&
5525 is sufficient for a host with simple mail requirements. As an introduction to
5526 the way Exim is configured, this chapter &"walks through"& the default
5527 configuration, giving brief explanations of the settings. Detailed descriptions
5528 of the options are given in subsequent chapters. The default configuration file
5529 itself contains extensive comments about ways you might want to modify the
5530 initial settings. However, note that there are many options that are not
5531 mentioned at all in the default configuration.
5532
5533
5534
5535 .section "Macros" "SECTdefconfmacros"
5536 All macros should be defined before any options.
5537
5538 One macro is specified, but commented out, in the default configuration:
5539 .code
5540 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5541 .endd
5542 If all off-site mail is expected to be delivered to a "smarthost", then set the
5543 hostname here and uncomment the macro.  This will affect which router is used
5544 later on.  If this is left commented out, then Exim will perform direct-to-MX
5545 deliveries using a &(dnslookup)& router.
5546
5547 In addition to macros defined here, Exim includes a number of built-in macros
5548 to enable configuration to be guarded by a binary built with support for a
5549 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5550
5551
5552 .section "Main configuration settings" "SECTdefconfmain"
5553 The main (global) configuration option settings section must always come first
5554 in the file, after the macros.
5555 The first thing you'll see in the file, after some initial comments, is the line
5556 .code
5557 # primary_hostname =
5558 .endd
5559 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5560 to know the official, fully qualified name of your host, and this is where you
5561 can specify it. However, in most cases you do not need to set this option. When
5562 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5563
5564 The first three non-comment configuration lines are as follows:
5565 .code
5566 domainlist local_domains    = @
5567 domainlist relay_to_domains =
5568 hostlist   relay_from_hosts = 127.0.0.1
5569 .endd
5570 These are not, in fact, option settings. They are definitions of two named
5571 domain lists and one named host list. Exim allows you to give names to lists of
5572 domains, hosts, and email addresses, in order to make it easier to manage the
5573 configuration file (see section &<<SECTnamedlists>>&).
5574
5575 The first line defines a domain list called &'local_domains'&; this is used
5576 later in the configuration to identify domains that are to be delivered
5577 on the local host.
5578
5579 .cindex "@ in a domain list"
5580 There is just one item in this list, the string &"@"&. This is a special form
5581 of entry which means &"the name of the local host"&. Thus, if the local host is
5582 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5583 be delivered locally. Because the local host's name is referenced indirectly,
5584 the same configuration file can be used on different hosts.
5585
5586 The second line defines a domain list called &'relay_to_domains'&, but the
5587 list itself is empty. Later in the configuration we will come to the part that
5588 controls mail relaying through the local host; it allows relaying to any
5589 domains in this list. By default, therefore, no relaying on the basis of a mail
5590 domain is permitted.
5591
5592 The third line defines a host list called &'relay_from_hosts'&. This list is
5593 used later in the configuration to permit relaying from any host or IP address
5594 that matches the list. The default contains just the IP address of the IPv4
5595 loopback interface, which means that processes on the local host are able to
5596 submit mail for relaying by sending it over TCP/IP to that interface. No other
5597 hosts are permitted to submit messages for relaying.
5598
5599 Just to be sure there's no misunderstanding: at this point in the configuration
5600 we aren't actually setting up any controls. We are just defining some domains
5601 and hosts that will be used in the controls that are specified later.
5602
5603 The next two configuration lines are genuine option settings:
5604 .code
5605 acl_smtp_rcpt = acl_check_rcpt
5606 acl_smtp_data = acl_check_data
5607 .endd
5608 These options specify &'Access Control Lists'& (ACLs) that are to be used
5609 during an incoming SMTP session for every recipient of a message (every RCPT
5610 command), and after the contents of the message have been received,
5611 respectively. The names of the lists are &'acl_check_rcpt'& and
5612 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5613 section of the configuration. The RCPT ACL controls which recipients are
5614 accepted for an incoming message &-- if a configuration does not provide an ACL
5615 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5616 contents of a message to be checked.
5617
5618 Two commented-out option settings are next:
5619 .code
5620 # av_scanner = clamd:/tmp/clamd
5621 # spamd_address = 127.0.0.1 783
5622 .endd
5623 These are example settings that can be used when Exim is compiled with the
5624 content-scanning extension. The first specifies the interface to the virus
5625 scanner, and the second specifies the interface to SpamAssassin. Further
5626 details are given in chapter &<<CHAPexiscan>>&.
5627
5628 Three more commented-out option settings follow:
5629 .code
5630 # tls_advertise_hosts = *
5631 # tls_certificate = /etc/ssl/exim.crt
5632 # tls_privatekey = /etc/ssl/exim.pem
5633 .endd
5634 These are example settings that can be used when Exim is compiled with
5635 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5636 first one specifies the list of clients that are allowed to use TLS when
5637 connecting to this server; in this case, the wildcard means all clients. The
5638 other options specify where Exim should find its TLS certificate and private
5639 key, which together prove the server's identity to any clients that connect.
5640 More details are given in chapter &<<CHAPTLS>>&.
5641
5642 Another two commented-out option settings follow:
5643 .code
5644 # daemon_smtp_ports = 25 : 465 : 587
5645 # tls_on_connect_ports = 465
5646 .endd
5647 .cindex "port" "465 and 587"
5648 .cindex "port" "for message submission"
5649 .cindex "message" "submission, ports for"
5650 .cindex "submissions protocol"
5651 .cindex "smtps protocol"
5652 .cindex "ssmtp protocol"
5653 .cindex "SMTP" "submissions protocol"
5654 .cindex "SMTP" "ssmtp protocol"
5655 .cindex "SMTP" "smtps protocol"
5656 These options provide better support for roaming users who wish to use this
5657 server for message submission. They are not much use unless you have turned on
5658 TLS (as described in the previous paragraph) and authentication (about which
5659 more in section &<<SECTdefconfauth>>&).
5660 Mail submission from mail clients (MUAs) should be separate from inbound mail
5661 to your domain (MX delivery) for various good reasons (eg, ability to impose
5662 much saner TLS protocol and ciphersuite requirements without unintended
5663 consequences).
5664 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5665 which uses STARTTLS, so this is the &"submission"& port.
5666 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5667 which should be used in preference to 587.
5668 You should also consider deploying SRV records to help clients find
5669 these ports.
5670 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5671
5672 Two more commented-out options settings follow:
5673 .code
5674 # qualify_domain =
5675 # qualify_recipient =
5676 .endd
5677 The first of these specifies a domain that Exim uses when it constructs a
5678 complete email address from a local login name. This is often needed when Exim
5679 receives a message from a local process. If you do not set &%qualify_domain%&,
5680 the value of &%primary_hostname%& is used. If you set both of these options,
5681 you can have different qualification domains for sender and recipient
5682 addresses. If you set only the first one, its value is used in both cases.
5683
5684 .cindex "domain literal" "recognizing format"
5685 The following line must be uncommented if you want Exim to recognize
5686 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5687 (an IP address within square brackets) instead of a named domain.
5688 .code
5689 # allow_domain_literals
5690 .endd
5691 The RFCs still require this form, but many people think that in the modern
5692 Internet it makes little sense to permit mail to be sent to specific hosts by
5693 quoting their IP addresses. This ancient format has been used by people who
5694 try to abuse hosts by using them for unwanted relaying. However, some
5695 people believe there are circumstances (for example, messages addressed to
5696 &'postmaster'&) where domain literals are still useful.
5697
5698 The next configuration line is a kind of trigger guard:
5699 .code
5700 never_users = root
5701 .endd
5702 It specifies that no delivery must ever be run as the root user. The normal
5703 convention is to set up &'root'& as an alias for the system administrator. This
5704 setting is a guard against slips in the configuration.
5705 The list of users specified by &%never_users%& is not, however, the complete
5706 list; the build-time configuration in &_Local/Makefile_& has an option called
5707 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5708 contents of &%never_users%& are added to this list. By default
5709 FIXED_NEVER_USERS also specifies root.
5710
5711 When a remote host connects to Exim in order to send mail, the only information
5712 Exim has about the host's identity is its IP address. The next configuration
5713 line,
5714 .code
5715 host_lookup = *
5716 .endd
5717 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5718 in order to get a host name. This improves the quality of the logging
5719 information, but if you feel it is too expensive, you can remove it entirely,
5720 or restrict the lookup to hosts on &"nearby"& networks.
5721 Note that it is not always possible to find a host name from an IP address,
5722 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5723 unreachable.
5724
5725 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5726 1413 (hence their names):
5727 .code
5728 rfc1413_hosts = *
5729 rfc1413_query_timeout = 0s
5730 .endd
5731 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5732 Few hosts offer RFC1413 service these days; calls have to be
5733 terminated by a timeout and this needlessly delays the startup
5734 of an incoming SMTP connection.
5735 If you have hosts for which you trust RFC1413 and need this
5736 information, you can change this.
5737
5738 This line enables an efficiency SMTP option.  It is negotiated by clients
5739 and not expected to cause problems but can be disabled if needed.
5740 .code
5741 prdr_enable = true
5742 .endd
5743
5744 When Exim receives messages over SMTP connections, it expects all addresses to
5745 be fully qualified with a domain, as required by the SMTP definition. However,
5746 if you are running a server to which simple clients submit messages, you may
5747 find that they send unqualified addresses. The two commented-out options:
5748 .code
5749 # sender_unqualified_hosts =
5750 # recipient_unqualified_hosts =
5751 .endd
5752 show how you can specify hosts that are permitted to send unqualified sender
5753 and recipient addresses, respectively.
5754
5755 The &%log_selector%& option is used to increase the detail of logging
5756 over the default:
5757 .code
5758 log_selector = +smtp_protocol_error +smtp_syntax_error \
5759                +tls_certificate_verified
5760 .endd
5761
5762 The &%percent_hack_domains%& option is also commented out:
5763 .code
5764 # percent_hack_domains =
5765 .endd
5766 It provides a list of domains for which the &"percent hack"& is to operate.
5767 This is an almost obsolete form of explicit email routing. If you do not know
5768 anything about it, you can safely ignore this topic.
5769
5770 The next two settings in the main part of the default configuration are
5771 concerned with messages that have been &"frozen"& on Exim's queue. When a
5772 message is frozen, Exim no longer continues to try to deliver it. Freezing
5773 occurs when a bounce message encounters a permanent failure because the sender
5774 address of the original message that caused the bounce is invalid, so the
5775 bounce cannot be delivered. This is probably the most common case, but there
5776 are also other conditions that cause freezing, and frozen messages are not
5777 always bounce messages.
5778 .code
5779 ignore_bounce_errors_after = 2d
5780 timeout_frozen_after = 7d
5781 .endd
5782 The first of these options specifies that failing bounce messages are to be
5783 discarded after 2 days in the queue. The second specifies that any frozen
5784 message (whether a bounce message or not) is to be timed out (and discarded)
5785 after a week. In this configuration, the first setting ensures that no failing
5786 bounce message ever lasts a week.
5787
5788 Exim queues it's messages in a spool directory. If you expect to have
5789 large queues, you may consider using this option. It splits the spool
5790 directory into subdirectories to avoid file system degradation from
5791 many files in a single directory, resulting in better performance.
5792 Manual manipulation of queued messages becomes more complex (though fortunately
5793 not often needed).
5794 .code
5795 # split_spool_directory = true
5796 .endd
5797
5798 In an ideal world everybody follows the standards. For non-ASCII
5799 messages RFC 2047 is a standard, allowing a maximum line length of 76
5800 characters. Exim adheres that standard and won't process messages which
5801 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5802 In particular, the Exim maintainers have had multiple reports of
5803 problems from Russian administrators of issues until they disable this
5804 check, because of some popular, yet buggy, mail composition software.
5805 .code
5806 # check_rfc2047_length = false
5807 .endd
5808
5809 If you need to be strictly RFC compliant you may wish to disable the
5810 8BITMIME advertisement. Use this, if you exchange mails with systems
5811 that are not 8-bit clean.
5812 .code
5813 # accept_8bitmime = false
5814 .endd
5815
5816 Libraries you use may depend on specific environment settings.  This
5817 imposes a security risk (e.g. PATH). There are two lists:
5818 &%keep_environment%& for the variables to import as they are, and
5819 &%add_environment%& for variables we want to set to a fixed value.
5820 Note that TZ is handled separately, by the $%timezone%$ runtime
5821 option and by the TIMEZONE_DEFAULT buildtime option.
5822 .code
5823 # keep_environment = ^LDAP
5824 # add_environment = PATH=/usr/bin::/bin
5825 .endd
5826
5827
5828 .section "ACL configuration" "SECID54"
5829 .cindex "default" "ACLs"
5830 .cindex "&ACL;" "default configuration"
5831 In the default configuration, the ACL section follows the main configuration.
5832 It starts with the line
5833 .code
5834 begin acl
5835 .endd
5836 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5837 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5838 and &%acl_smtp_data%& above.
5839
5840 .cindex "RCPT" "ACL for"
5841 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5842 RCPT command specifies one of the message's recipients. The ACL statements
5843 are considered in order, until the recipient address is either accepted or
5844 rejected. The RCPT command is then accepted or rejected, according to the
5845 result of the ACL processing.
5846 .code
5847 acl_check_rcpt:
5848 .endd
5849 This line, consisting of a name terminated by a colon, marks the start of the
5850 ACL, and names it.
5851 .code
5852 accept  hosts = :
5853 .endd
5854 This ACL statement accepts the recipient if the sending host matches the list.
5855 But what does that strange list mean? It doesn't actually contain any host
5856 names or IP addresses. The presence of the colon puts an empty item in the
5857 list; Exim matches this only if the incoming message did not come from a remote
5858 host, because in that case, the remote hostname is empty. The colon is
5859 important. Without it, the list itself is empty, and can never match anything.
5860
5861 What this statement is doing is to accept unconditionally all recipients in
5862 messages that are submitted by SMTP from local processes using the standard
5863 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5864 manner.
5865 .code
5866 deny    message       = Restricted characters in address
5867         domains       = +local_domains
5868         local_parts   = ^[.] : ^.*[@%!/|]
5869
5870 deny    message       = Restricted characters in address
5871         domains       = !+local_domains
5872         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5873 .endd
5874 These statements are concerned with local parts that contain any of the
5875 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5876 Although these characters are entirely legal in local parts (in the case of
5877 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5878 in Internet mail addresses.
5879
5880 The first three have in the past been associated with explicitly routed
5881 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5882 option). Addresses containing these characters are regularly tried by spammers
5883 in an attempt to bypass relaying restrictions, and also by open relay testing
5884 programs. Unless you really need them it is safest to reject these characters
5885 at this early stage. This configuration is heavy-handed in rejecting these
5886 characters for all messages it accepts from remote hosts. This is a deliberate
5887 policy of being as safe as possible.
5888
5889 The first rule above is stricter, and is applied to messages that are addressed
5890 to one of the local domains handled by this host. This is implemented by the
5891 first condition, which restricts it to domains that are listed in the
5892 &'local_domains'& domain list. The &"+"& character is used to indicate a
5893 reference to a named list. In this configuration, there is just one domain in
5894 &'local_domains'&, but in general there may be many.
5895
5896 The second condition on the first statement uses two regular expressions to
5897 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5898 or &"|"&. If you have local accounts that include these characters, you will
5899 have to modify this rule.
5900
5901 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5902 allows them because they have been encountered in practice. (Consider the
5903 common convention of local parts constructed as
5904 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5905 the author of Exim, who has no second initial.) However, a local part starting
5906 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5907 filename (for example, for a mailing list). This is also true for local parts
5908 that contain slashes. A pipe symbol can also be troublesome if the local part
5909 is incorporated unthinkingly into a shell command line.
5910
5911 The second rule above applies to all other domains, and is less strict. This
5912 allows your own users to send outgoing messages to sites that use slashes
5913 and vertical bars in their local parts. It blocks local parts that begin
5914 with a dot, slash, or vertical bar, but allows these characters within the
5915 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5916 and &"!"& is blocked, as before. The motivation here is to prevent your users
5917 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5918 .code
5919 accept  local_parts   = postmaster
5920         domains       = +local_domains
5921 .endd
5922 This statement, which has two conditions, accepts an incoming address if the
5923 local part is &'postmaster'& and the domain is one of those listed in the
5924 &'local_domains'& domain list. The &"+"& character is used to indicate a
5925 reference to a named list. In this configuration, there is just one domain in
5926 &'local_domains'&, but in general there may be many.
5927
5928 The presence of this statement means that mail to postmaster is never blocked
5929 by any of the subsequent tests. This can be helpful while sorting out problems
5930 in cases where the subsequent tests are incorrectly denying access.
5931 .code
5932 require verify        = sender
5933 .endd
5934 This statement requires the sender address to be verified before any subsequent
5935 ACL statement can be used. If verification fails, the incoming recipient
5936 address is refused. Verification consists of trying to route the address, to
5937 see if a bounce message could be delivered to it. In the case of remote
5938 addresses, basic verification checks only the domain, but &'callouts'& can be
5939 used for more verification if required. Section &<<SECTaddressverification>>&
5940 discusses the details of address verification.
5941 .code
5942 accept  hosts         = +relay_from_hosts
5943         control       = submission
5944 .endd
5945 This statement accepts the address if the message is coming from one of the
5946 hosts that are defined as being allowed to relay through this host. Recipient
5947 verification is omitted here, because in many cases the clients are dumb MUAs
5948 that do not cope well with SMTP error responses. For the same reason, the
5949 second line specifies &"submission mode"& for messages that are accepted. This
5950 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5951 messages that are deficient in some way, for example, because they lack a
5952 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5953 probably add recipient verification here, and disable submission mode.
5954 .code
5955 accept  authenticated = *
5956         control       = submission
5957 .endd
5958 This statement accepts the address if the client host has authenticated itself.
5959 Submission mode is again specified, on the grounds that such messages are most
5960 likely to come from MUAs. The default configuration does not define any
5961 authenticators, though it does include some nearly complete commented-out
5962 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5963 fact authenticate until you complete the authenticator definitions.
5964 .code
5965 require message = relay not permitted
5966         domains = +local_domains : +relay_to_domains
5967 .endd
5968 This statement rejects the address if its domain is neither a local domain nor
5969 one of the domains for which this host is a relay.
5970 .code
5971 require verify = recipient
5972 .endd
5973 This statement requires the recipient address to be verified; if verification
5974 fails, the address is rejected.
5975 .code
5976 # deny    message     = rejected because $sender_host_address \
5977 #                       is in a black list at $dnslist_domain\n\
5978 #                       $dnslist_text
5979 #         dnslists    = black.list.example
5980 #
5981 # warn    dnslists    = black.list.example
5982 #         add_header  = X-Warning: $sender_host_address is in \
5983 #                       a black list at $dnslist_domain
5984 #         log_message = found in $dnslist_domain
5985 .endd
5986 These commented-out lines are examples of how you could configure Exim to check
5987 sending hosts against a DNS black list. The first statement rejects messages
5988 from blacklisted hosts, whereas the second just inserts a warning header
5989 line.
5990 .code
5991 # require verify = csa
5992 .endd
5993 This commented-out line is an example of how you could turn on client SMTP
5994 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5995 records.
5996 .code
5997 accept
5998 .endd
5999 The final statement in the first ACL unconditionally accepts any recipient
6000 address that has successfully passed all the previous tests.
6001 .code
6002 acl_check_data:
6003 .endd
6004 This line marks the start of the second ACL, and names it. Most of the contents
6005 of this ACL are commented out:
6006 .code
6007 # deny    malware   = *
6008 #         message   = This message contains a virus \
6009 #                     ($malware_name).
6010 .endd
6011 These lines are examples of how to arrange for messages to be scanned for
6012 viruses when Exim has been compiled with the content-scanning extension, and a
6013 suitable virus scanner is installed. If the message is found to contain a
6014 virus, it is rejected with the given custom error message.
6015 .code
6016 # warn    spam      = nobody
6017 #         message   = X-Spam_score: $spam_score\n\
6018 #                     X-Spam_score_int: $spam_score_int\n\
6019 #                     X-Spam_bar: $spam_bar\n\
6020 #                     X-Spam_report: $spam_report
6021 .endd
6022 These lines are an example of how to arrange for messages to be scanned by
6023 SpamAssassin when Exim has been compiled with the content-scanning extension,
6024 and SpamAssassin has been installed. The SpamAssassin check is run with
6025 &`nobody`& as its user parameter, and the results are added to the message as a
6026 series of extra header line. In this case, the message is not rejected,
6027 whatever the spam score.
6028 .code
6029 accept
6030 .endd
6031 This final line in the DATA ACL accepts the message unconditionally.
6032
6033
6034 .section "Router configuration" "SECID55"
6035 .cindex "default" "routers"
6036 .cindex "routers" "default"
6037 The router configuration comes next in the default configuration, introduced
6038 by the line
6039 .code
6040 begin routers
6041 .endd
6042 Routers are the modules in Exim that make decisions about where to send
6043 messages. An address is passed to each router, in turn, until it is either
6044 accepted, or failed. This means that the order in which you define the routers
6045 matters. Each router is fully described in its own chapter later in this
6046 manual. Here we give only brief overviews.
6047 .code
6048 # domain_literal:
6049 #   driver = ipliteral
6050 #   domains = !+local_domains
6051 #   transport = remote_smtp
6052 .endd
6053 .cindex "domain literal" "default router"
6054 This router is commented out because the majority of sites do not want to
6055 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6056 you uncomment this router, you also need to uncomment the setting of
6057 &%allow_domain_literals%& in the main part of the configuration.
6058
6059 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6060 macro has been defined, per
6061 .code
6062 .ifdef ROUTER_SMARTHOST
6063 smarthost:
6064 #...
6065 .else
6066 dnslookup:
6067 #...
6068 .endif
6069 .endd
6070
6071 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6072 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6073 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6074 skip these routers because of the &%domains%& option.
6075
6076 .code
6077 smarthost:
6078   driver = manualroute
6079   domains = ! +local_domains
6080   transport = smarthost_smtp
6081   route_data = ROUTER_SMARTHOST
6082   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6083   no_more
6084 .endd
6085 This router only handles mail which is not to any local domains; this is
6086 specified by the line
6087 .code
6088 domains = ! +local_domains
6089 .endd
6090 The &%domains%& option lists the domains to which this router applies, but the
6091 exclamation mark is a negation sign, so the router is used only for domains
6092 that are not in the domain list called &'local_domains'& (which was defined at
6093 the start of the configuration). The plus sign before &'local_domains'&
6094 indicates that it is referring to a named list. Addresses in other domains are
6095 passed on to the following routers.
6096
6097 The name of the router driver is &(manualroute)& because we are manually
6098 specifying how mail should be routed onwards, instead of using DNS MX.
6099 While the name of this router instance is arbitrary, the &%driver%& option must
6100 be one of the driver modules that is in the Exim binary.
6101
6102 With no pre-conditions other than &%domains%&, all mail for non-local domains
6103 will be handled by this router, and the &%no_more%& setting will ensure that no
6104 other routers will be used for messages matching the pre-conditions.  See
6105 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6106 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6107 and the macro supplies the value; the address is then queued for the
6108 &(smarthost_smtp)& transport.
6109
6110 .code
6111 dnslookup:
6112   driver = dnslookup
6113   domains = ! +local_domains
6114   transport = remote_smtp
6115   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6116   no_more
6117 .endd
6118 The &%domains%& option behaves as per smarthost, above.
6119
6120 The name of the router driver is &(dnslookup)&,
6121 and is specified by the &%driver%& option. Do not be confused by the fact that
6122 the name of this router instance is the same as the name of the driver. The
6123 instance name is arbitrary, but the name set in the &%driver%& option must be
6124 one of the driver modules that is in the Exim binary.
6125
6126 The &(dnslookup)& router routes addresses by looking up their domains in the
6127 DNS in order to obtain a list of hosts to which the address is routed. If the
6128 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6129 specified by the &%transport%& option. If the router does not find the domain
6130 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6131 the address fails and is bounced.
6132
6133 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6134 be entirely ignored. This option is present because a number of cases have been
6135 encountered where MX records in the DNS point to host names
6136 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6137 Completely ignoring these IP addresses causes Exim to fail to route the
6138 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6139 continue to try to deliver the message periodically until the address timed
6140 out.
6141 .code
6142 system_aliases:
6143   driver = redirect
6144   allow_fail
6145   allow_defer
6146   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6147 # user = exim
6148   file_transport = address_file
6149   pipe_transport = address_pipe
6150 .endd
6151 Control reaches this and subsequent routers only for addresses in the local
6152 domains. This router checks to see whether the local part is defined as an
6153 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6154 data that it looks up from that file. If no data is found for the local part,
6155 the value of the &%data%& option is empty, causing the address to be passed to
6156 the next router.
6157
6158 &_/etc/aliases_& is a conventional name for the system aliases file that is
6159 often used. That is why it is referenced by from the default configuration
6160 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6161 &_Local/Makefile_& before building Exim.
6162 .code
6163 userforward:
6164   driver = redirect
6165   check_local_user
6166 # local_part_suffix = +* : -*
6167 # local_part_suffix_optional
6168   file = $home/.forward
6169 # allow_filter
6170   no_verify
6171   no_expn
6172   check_ancestor
6173   file_transport = address_file
6174   pipe_transport = address_pipe
6175   reply_transport = address_reply
6176 .endd
6177 This is the most complicated router in the default configuration. It is another
6178 redirection router, but this time it is looking for forwarding data set up by
6179 individual users. The &%check_local_user%& setting specifies a check that the
6180 local part of the address is the login name of a local user. If it is not, the
6181 router is skipped. The two commented options that follow &%check_local_user%&,
6182 namely:
6183 .code
6184 # local_part_suffix = +* : -*
6185 # local_part_suffix_optional
6186 .endd
6187 .vindex "&$local_part_suffix$&"
6188 show how you can specify the recognition of local part suffixes. If the first
6189 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6190 by any sequence of characters, is removed from the local part and placed in the
6191 variable &$local_part_suffix$&. The second suffix option specifies that the
6192 presence of a suffix in the local part is optional. When a suffix is present,
6193 the check for a local login uses the local part with the suffix removed.
6194
6195 When a local user account is found, the file called &_.forward_& in the user's
6196 home directory is consulted. If it does not exist, or is empty, the router
6197 declines. Otherwise, the contents of &_.forward_& are interpreted as
6198 redirection data (see chapter &<<CHAPredirect>>& for more details).
6199
6200 .cindex "Sieve filter" "enabling in default router"
6201 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6202 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6203 is commented out by default), the contents of the file are interpreted as a set
6204 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6205 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6206 separate document entitled &'Exim's interfaces to mail filtering'&.
6207
6208 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6209 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6210 There are two reasons for doing this:
6211
6212 .olist
6213 Whether or not a local user has a &_.forward_& file is not really relevant when
6214 checking an address for validity; it makes sense not to waste resources doing
6215 unnecessary work.
6216 .next
6217 More importantly, when Exim is verifying addresses or handling an EXPN
6218 command during an SMTP session, it is running as the Exim user, not as root.
6219 The group is the Exim group, and no additional groups are set up.
6220 It may therefore not be possible for Exim to read users' &_.forward_& files at
6221 this time.
6222 .endlist
6223
6224 The setting of &%check_ancestor%& prevents the router from generating a new
6225 address that is the same as any previous address that was redirected. (This
6226 works round a problem concerning a bad interaction between aliasing and
6227 forwarding &-- see section &<<SECTredlocmai>>&).
6228
6229 The final three option settings specify the transports that are to be used when
6230 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6231 auto-reply, respectively. For example, if a &_.forward_& file contains
6232 .code
6233 a.nother@elsewhere.example, /home/spqr/archive
6234 .endd
6235 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6236 transport.
6237 .code
6238 localuser:
6239   driver = accept
6240   check_local_user
6241 # local_part_suffix = +* : -*
6242 # local_part_suffix_optional
6243   transport = local_delivery
6244 .endd
6245 The final router sets up delivery into local mailboxes, provided that the local
6246 part is the name of a local login, by accepting the address and assigning it to
6247 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6248 routers, so the address is bounced. The commented suffix settings fulfil the
6249 same purpose as they do for the &(userforward)& router.
6250
6251
6252 .section "Transport configuration" "SECID56"
6253 .cindex "default" "transports"
6254 .cindex "transports" "default"
6255 Transports define mechanisms for actually delivering messages. They operate
6256 only when referenced from routers, so the order in which they are defined does
6257 not matter. The transports section of the configuration starts with
6258 .code
6259 begin transports
6260 .endd
6261 Two remote transports and four local transports are defined.
6262 .code
6263 remote_smtp:
6264   driver = smtp
6265   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6266 .ifdef _HAVE_PRDR
6267   hosts_try_prdr = *
6268 .endif
6269 .endd
6270 This transport is used for delivering messages over SMTP connections.
6271 The list of remote hosts comes from the router.
6272 The &%message_size_limit%& usage is a hack to avoid sending on messages
6273 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6274 to use DANE for delivery;
6275 see section &<<SECDANE>>& for more details.
6276
6277 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6278 negotiated between client and server and not expected to cause problems
6279 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6280 use of the &%hosts_try_prdr%& configuration option.
6281
6282 The other remote transport is used when delivering to a specific smarthost
6283 with whom there must be some kind of existing relationship, instead of the
6284 usual federated system.
6285
6286 .code
6287 smarthost_smtp:
6288   driver = smtp
6289   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6290   multi_domain
6291   #
6292 .ifdef _HAVE_TLS
6293   # Comment out any of these which you have to, then file a Support
6294   # request with your smarthost provider to get things fixed:
6295   hosts_require_tls = *
6296   tls_verify_hosts = *
6297   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6298   # have to comment it out then this will at least log whether you succeed
6299   # or not:
6300   tls_try_verify_hosts = *
6301   #
6302   # The SNI name should match the name which we'll expect to verify;
6303   # many mail systems don't use SNI and this doesn't matter, but if it does,
6304   # we need to send a name which the remote site will recognize.
6305   # This _should_ be the name which the smarthost operators specified as
6306   # the hostname for sending your mail to.
6307   tls_sni = ROUTER_SMARTHOST
6308   #
6309 .ifdef _HAVE_OPENSSL
6310   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6311 .endif
6312 .ifdef _HAVE_GNUTLS
6313   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6314 .endif
6315 .endif
6316 .ifdef _HAVE_PRDR
6317   hosts_try_prdr = *
6318 .endif
6319 .endd
6320 After the same &%message_size_limit%& hack, we then specify that this Transport
6321 can handle messages to multiple domains in one run.  The assumption here is
6322 that you're routing all non-local mail to the same place and that place is
6323 happy to take all messages from you as quickly as possible.
6324 All other options depend upon built-in macros; if Exim was built without TLS support
6325 then no other options are defined.
6326 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6327 and versions using the &%tls_require_ciphers%& option, where the value to be
6328 used depends upon the library providing TLS.
6329 Beyond that, the options adopt the stance that you should have TLS support available
6330 from your smarthost on today's Internet, so we turn on requiring TLS for the
6331 mail to be delivered, and requiring that the certificate be valid, and match
6332 the expected hostname.  The &%tls_sni%& option can be used by service providers
6333 to select an appropriate certificate to present to you and here we re-use the
6334 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6335 You want to specify the hostname which you'll expect to validate for, and that
6336 should not be subject to insecure tampering via DNS results.
6337
6338 For the &%hosts_try_prdr%& option see the previous transport.
6339
6340 All other options are defaulted.
6341 .code
6342 local_delivery:
6343   driver = appendfile
6344   file = /var/mail/$local_part
6345   delivery_date_add
6346   envelope_to_add
6347   return_path_add
6348 # group = mail
6349 # mode = 0660
6350 .endd
6351 This &(appendfile)& transport is used for local delivery to user mailboxes in
6352 traditional BSD mailbox format. By default it runs under the uid and gid of the
6353 local user, which requires the sticky bit to be set on the &_/var/mail_&
6354 directory. Some systems use the alternative approach of running mail deliveries
6355 under a particular group instead of using the sticky bit. The commented options
6356 show how this can be done.
6357
6358 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6359 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6360 similarly-named options above.
6361 .code
6362 address_pipe:
6363   driver = pipe
6364   return_output
6365 .endd
6366 This transport is used for handling deliveries to pipes that are generated by
6367 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6368 option specifies that any output on stdout or stderr generated by the pipe is to
6369 be returned to the sender.
6370 .code
6371 address_file:
6372   driver = appendfile
6373   delivery_date_add
6374   envelope_to_add
6375   return_path_add
6376 .endd
6377 This transport is used for handling deliveries to files that are generated by
6378 redirection. The name of the file is not specified in this instance of
6379 &(appendfile)&, because it comes from the &(redirect)& router.
6380 .code
6381 address_reply:
6382   driver = autoreply
6383 .endd
6384 This transport is used for handling automatic replies generated by users'
6385 filter files.
6386
6387
6388
6389 .section "Default retry rule" "SECID57"
6390 .cindex "retry" "default rule"
6391 .cindex "default" "retry rule"
6392 The retry section of the configuration file contains rules which affect the way
6393 Exim retries deliveries that cannot be completed at the first attempt. It is
6394 introduced by the line
6395 .code
6396 begin retry
6397 .endd
6398 In the default configuration, there is just one rule, which applies to all
6399 errors:
6400 .code
6401 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6402 .endd
6403 This causes any temporarily failing address to be retried every 15 minutes for
6404 2 hours, then at intervals starting at one hour and increasing by a factor of
6405 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6406 is not delivered after 4 days of temporary failure, it is bounced. The time is
6407 measured from first failure, not from the time the message was received.
6408
6409 If the retry section is removed from the configuration, or is empty (that is,
6410 if no retry rules are defined), Exim will not retry deliveries. This turns
6411 temporary errors into permanent errors.
6412
6413
6414 .section "Rewriting configuration" "SECID58"
6415 The rewriting section of the configuration, introduced by
6416 .code
6417 begin rewrite
6418 .endd
6419 contains rules for rewriting addresses in messages as they arrive. There are no
6420 rewriting rules in the default configuration file.
6421
6422
6423
6424 .section "Authenticators configuration" "SECTdefconfauth"
6425 .cindex "AUTH" "configuration"
6426 The authenticators section of the configuration, introduced by
6427 .code
6428 begin authenticators
6429 .endd
6430 defines mechanisms for the use of the SMTP AUTH command. The default
6431 configuration file contains two commented-out example authenticators
6432 which support plaintext username/password authentication using the
6433 standard PLAIN mechanism and the traditional but non-standard LOGIN
6434 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6435 to support most MUA software.
6436
6437 The example PLAIN authenticator looks like this:
6438 .code
6439 #PLAIN:
6440 #  driver                  = plaintext
6441 #  server_set_id           = $auth2
6442 #  server_prompts          = :
6443 #  server_condition        = Authentication is not yet configured
6444 #  server_advertise_condition = ${if def:tls_in_cipher }
6445 .endd
6446 And the example LOGIN authenticator looks like this:
6447 .code
6448 #LOGIN:
6449 #  driver                  = plaintext
6450 #  server_set_id           = $auth1
6451 #  server_prompts          = <| Username: | Password:
6452 #  server_condition        = Authentication is not yet configured
6453 #  server_advertise_condition = ${if def:tls_in_cipher }
6454 .endd
6455
6456 The &%server_set_id%& option makes Exim remember the authenticated username
6457 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6458 &%server_prompts%& option configures the &(plaintext)& authenticator so
6459 that it implements the details of the specific authentication mechanism,
6460 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6461 when Exim offers authentication to clients; in the examples, this is only
6462 when TLS or SSL has been started, so to enable the authenticators you also
6463 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6464
6465 The &%server_condition%& setting defines how to verify that the username and
6466 password are correct. In the examples it just produces an error message.
6467 To make the authenticators work, you can use a string expansion
6468 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6469
6470 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6471 usercode and password are in different positions.
6472 Chapter &<<CHAPplaintext>>& covers both.
6473
6474 .ecindex IIDconfiwal
6475
6476
6477
6478 . ////////////////////////////////////////////////////////////////////////////
6479 . ////////////////////////////////////////////////////////////////////////////
6480
6481 .chapter "Regular expressions" "CHAPregexp"
6482
6483 .cindex "regular expressions" "library"
6484 .cindex "PCRE"
6485 Exim supports the use of regular expressions in many of its options. It
6486 uses the PCRE regular expression library; this provides regular expression
6487 matching that is compatible with Perl 5. The syntax and semantics of
6488 regular expressions is discussed in
6489 online Perl manpages, in
6490 many Perl reference books, and also in
6491 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6492 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6493 . --- the http: URL here redirects to another page with the ISBN in the URL
6494 . --- where trying to use https: just redirects back to http:, so sticking
6495 . --- to the old URL for now.  2018-09-07.
6496
6497 The documentation for the syntax and semantics of the regular expressions that
6498 are supported by PCRE is included in the PCRE distribution, and no further
6499 description is included here. The PCRE functions are called from Exim using
6500 the default option settings (that is, with no PCRE options set), except that
6501 the PCRE_CASELESS option is set when the matching is required to be
6502 case-insensitive.
6503
6504 In most cases, when a regular expression is required in an Exim configuration,
6505 it has to start with a circumflex, in order to distinguish it from plain text
6506 or an &"ends with"& wildcard. In this example of a configuration setting, the
6507 second item in the colon-separated list is a regular expression.
6508 .code
6509 domains = a.b.c : ^\\d{3} : *.y.z : ...
6510 .endd
6511 The doubling of the backslash is required because of string expansion that
6512 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6513 of this issue, and a way of avoiding the need for doubling backslashes. The
6514 regular expression that is eventually used in this example contains just one
6515 backslash. The circumflex is included in the regular expression, and has the
6516 normal effect of &"anchoring"& it to the start of the string that is being
6517 matched.
6518
6519 There are, however, two cases where a circumflex is not required for the
6520 recognition of a regular expression: these are the &%match%& condition in a
6521 string expansion, and the &%matches%& condition in an Exim filter file. In
6522 these cases, the relevant string is always treated as a regular expression; if
6523 it does not start with a circumflex, the expression is not anchored, and can
6524 match anywhere in the subject string.
6525
6526 In all cases, if you want a regular expression to match at the end of a string,
6527 you must code the $ metacharacter to indicate this. For example:
6528 .code
6529 domains = ^\\d{3}\\.example
6530 .endd
6531 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6532 You need to use:
6533 .code
6534 domains = ^\\d{3}\\.example\$
6535 .endd
6536 if you want &'example'& to be the top-level domain. The backslash before the
6537 $ is needed because string expansion also interprets dollar characters.
6538
6539
6540
6541 . ////////////////////////////////////////////////////////////////////////////
6542 . ////////////////////////////////////////////////////////////////////////////
6543
6544 .chapter "File and database lookups" "CHAPfdlookup"
6545 .scindex IIDfidalo1 "file" "lookups"
6546 .scindex IIDfidalo2 "database" "lookups"
6547 .cindex "lookup" "description of"
6548 Exim can be configured to look up data in files or databases as it processes
6549 messages. Two different kinds of syntax are used:
6550
6551 .olist
6552 A string that is to be expanded may contain explicit lookup requests. These
6553 cause parts of the string to be replaced by data that is obtained from the
6554 lookup. Lookups of this type are conditional expansion items. Different results
6555 can be defined for the cases of lookup success and failure. See chapter
6556 &<<CHAPexpand>>&, where string expansions are described in detail.
6557 The key for the lookup is specified as part of the string expansion.
6558 .next
6559 Lists of domains, hosts, and email addresses can contain lookup requests as a
6560 way of avoiding excessively long linear lists. In this case, the data that is
6561 returned by the lookup is often (but not always) discarded; whether the lookup
6562 succeeds or fails is what really counts. These kinds of list are described in
6563 chapter &<<CHAPdomhosaddlists>>&.
6564 The key for the lookup is given by the context in which the list is expanded.
6565 .endlist
6566
6567 String expansions, lists, and lookups interact with each other in such a way
6568 that there is no order in which to describe any one of them that does not
6569 involve references to the others. Each of these three chapters makes more sense
6570 if you have read the other two first. If you are reading this for the first
6571 time, be aware that some of it will make a lot more sense after you have read
6572 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6573
6574 .section "Examples of different lookup syntax" "SECID60"
6575 It is easy to confuse the two different kinds of lookup, especially as the
6576 lists that may contain the second kind are always expanded before being
6577 processed as lists. Therefore, they may also contain lookups of the first kind.
6578 Be careful to distinguish between the following two examples:
6579 .code
6580 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6581 domains = lsearch;/some/file
6582 .endd
6583 The first uses a string expansion, the result of which must be a domain list.
6584 No strings have been specified for a successful or a failing lookup; the
6585 defaults in this case are the looked-up data and an empty string, respectively.
6586 The expansion takes place before the string is processed as a list, and the
6587 file that is searched could contain lines like this:
6588 .code
6589 192.168.3.4: domain1:domain2:...
6590 192.168.1.9: domain3:domain4:...
6591 .endd
6592 When the lookup succeeds, the result of the expansion is a list of domains (and
6593 possibly other types of item that are allowed in domain lists).
6594
6595 In the second example, the lookup is a single item in a domain list. It causes
6596 Exim to use a lookup to see if the domain that is being processed can be found
6597 in the file. The file could contains lines like this:
6598 .code
6599 domain1:
6600 domain2:
6601 .endd
6602 Any data that follows the keys is not relevant when checking that the domain
6603 matches the list item.
6604
6605 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6606 Consider a file containing lines like this:
6607 .code
6608 192.168.5.6: lsearch;/another/file
6609 .endd
6610 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6611 first &%domains%& setting above generates the second setting, which therefore
6612 causes a second lookup to occur.
6613
6614 The rest of this chapter describes the different lookup types that are
6615 available. Any of them can be used in any part of the configuration where a
6616 lookup is permitted.
6617
6618
6619 .section "Lookup types" "SECID61"
6620 .cindex "lookup" "types of"
6621 .cindex "single-key lookup" "definition of"
6622 Two different types of data lookup are implemented:
6623
6624 .ilist
6625 The &'single-key'& type requires the specification of a file in which to look,
6626 and a single key to search for. The key must be a non-empty string for the
6627 lookup to succeed. The lookup type determines how the file is searched.
6628 .next
6629 .cindex "query-style lookup" "definition of"
6630 The &'query-style'& type accepts a generalized database query. No particular
6631 key value is assumed by Exim for query-style lookups. You can use whichever
6632 Exim variables you need to construct the database query.
6633 .endlist
6634
6635 The code for each lookup type is in a separate source file that is included in
6636 the binary of Exim only if the corresponding compile-time option is set. The
6637 default settings in &_src/EDITME_& are:
6638 .code
6639 LOOKUP_DBM=yes
6640 LOOKUP_LSEARCH=yes
6641 .endd
6642 which means that only linear searching and DBM lookups are included by default.
6643 For some types of lookup (e.g. SQL databases), you need to install appropriate
6644 libraries and header files before building Exim.
6645
6646
6647
6648
6649 .section "Single-key lookup types" "SECTsinglekeylookups"
6650 .cindex "lookup" "single-key types"
6651 .cindex "single-key lookup" "list of types"
6652 The following single-key lookup types are implemented:
6653
6654 .ilist
6655 .cindex "cdb" "description of"
6656 .cindex "lookup" "cdb"
6657 .cindex "binary zero" "in lookup key"
6658 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6659 string without a terminating binary zero. The cdb format is designed for
6660 indexed files that are read frequently and never updated, except by total
6661 re-creation. As such, it is particularly suitable for large files containing
6662 aliases or other indexed data referenced by an MTA. Information about cdb and
6663 tools for building the files can be found in several places:
6664 .display
6665 &url(https://cr.yp.to/cdb.html)
6666 &url(http://www.corpit.ru/mjt/tinycdb.html)
6667 &url(https://packages.debian.org/stable/utils/freecdb)
6668 &url(https://github.com/philpennock/cdbtools) (in Go)
6669 .endd
6670 . --- 2018-09-07: corpit.ru http:-only
6671 A cdb distribution is not needed in order to build Exim with cdb support,
6672 because the code for reading cdb files is included directly in Exim itself.
6673 However, no means of building or testing cdb files is provided with Exim, so
6674 you need to obtain a cdb distribution in order to do this.
6675 .next
6676 .cindex "DBM" "lookup type"
6677 .cindex "lookup" "dbm"
6678 .cindex "binary zero" "in lookup key"
6679 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6680 DBM file by looking up the record with the given key. A terminating binary
6681 zero is included in the key that is passed to the DBM library. See section
6682 &<<SECTdb>>& for a discussion of DBM libraries.
6683
6684 .cindex "Berkeley DB library" "file format"
6685 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6686 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6687 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6688 the DB_UNKNOWN option. This enables it to handle any of the types of database
6689 that the library supports, and can be useful for accessing DBM files created by
6690 other applications. (For earlier DB versions, DB_HASH is always used.)
6691 .next
6692 .cindex "lookup" "dbmjz"
6693 .cindex "lookup" "dbm &-- embedded NULs"
6694 .cindex "sasldb2"
6695 .cindex "dbmjz lookup type"
6696 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6697 interpreted as an Exim list; the elements of the list are joined together with
6698 ASCII NUL characters to form the lookup key.  An example usage would be to
6699 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6700 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6701 &(cram_md5)& authenticator.
6702 .next
6703 .cindex "lookup" "dbmnz"
6704 .cindex "lookup" "dbm &-- terminating zero"
6705 .cindex "binary zero" "in lookup key"
6706 .cindex "Courier"
6707 .cindex "&_/etc/userdbshadow.dat_&"
6708 .cindex "dbmnz lookup type"
6709 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6710 is not included in the key that is passed to the DBM library. You may need this
6711 if you want to look up data in files that are created by or shared with some
6712 other application that does not use terminating zeros. For example, you need to
6713 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6714 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6715 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6716 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6717 .next
6718 .cindex "lookup" "dsearch"
6719 .cindex "dsearch lookup type"
6720 &(dsearch)&: The given file must be a directory; this is searched for an entry
6721 whose name is the key by calling the &[lstat()]& function. The key may not
6722 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6723 the lookup is the name of the entry, which may be a file, directory,
6724 symbolic link, or any other kind of directory entry. An example of how this
6725 lookup can be used to support virtual domains is given in section
6726 &<<SECTvirtualdomains>>&.
6727 .next
6728 .cindex "lookup" "iplsearch"
6729 .cindex "iplsearch lookup type"
6730 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6731 terminated by a colon or white space or the end of the line. The keys in the
6732 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6733 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6734 being interpreted as a key terminator. For example:
6735 .code
6736 1.2.3.4:           data for 1.2.3.4
6737 192.168.0.0/16:    data for 192.168.0.0/16
6738 "abcd::cdab":      data for abcd::cdab
6739 "abcd:abcd::/32"   data for abcd:abcd::/32
6740 .endd
6741 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6742 file is searched linearly, using the CIDR masks where present, until a matching
6743 key is found. The first key that matches is used; there is no attempt to find a
6744 &"best"& match. Apart from the way the keys are matched, the processing for
6745 &(iplsearch)& is the same as for &(lsearch)&.
6746
6747 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6748 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6749 lookup types support only literal keys.
6750
6751 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6752 the implicit key is the host's IP address rather than its name (see section
6753 &<<SECThoslispatsikey>>&).
6754
6755 .new
6756 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6757 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6758 notation before executing the lookup.)
6759 .wen
6760 .next
6761 .new
6762 .cindex lookup json
6763 .cindex json "lookup type"
6764 .cindex JSON expansions
6765 &(json)&: The given file is a text file with a JSON structure.
6766 An element of the structure is extracted, defined by the search key.
6767 The key is a list of subelement selectors
6768 (colon-separated by default but changeable in the usual way)
6769 which are applied in turn to select smaller and smaller portions
6770 of the JSON structure.
6771 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6772 nunbered array element is selected.
6773 Otherwise it must apply to a JSON object; the named element is selected.
6774 The final resulting element can be a simple JSON type or a JSON object
6775 or array; for the latter two a string-representation os the JSON
6776 is returned.
6777 For elements of type string, the returned value is de-quoted.
6778 .wen
6779 .next
6780 .cindex "linear search"
6781 .cindex "lookup" "lsearch"
6782 .cindex "lsearch lookup type"
6783 .cindex "case sensitivity" "in lsearch lookup"
6784 &(lsearch)&: The given file is a text file that is searched linearly for a
6785 line beginning with the search key, terminated by a colon or white space or the
6786 end of the line. The search is case-insensitive; that is, upper and lower case
6787 letters are treated as the same. The first occurrence of the key that is found
6788 in the file is used.
6789
6790 White space between the key and the colon is permitted. The remainder of the
6791 line, with leading and trailing white space removed, is the data. This can be
6792 continued onto subsequent lines by starting them with any amount of white
6793 space, but only a single space character is included in the data at such a
6794 junction. If the data begins with a colon, the key must be terminated by a
6795 colon, for example:
6796 .code
6797 baduser:  :fail:
6798 .endd
6799 Empty lines and lines beginning with # are ignored, even if they occur in the
6800 middle of an item. This is the traditional textual format of alias files. Note
6801 that the keys in an &(lsearch)& file are literal strings. There is no
6802 wildcarding of any kind.
6803
6804 .cindex "lookup" "lsearch &-- colons in keys"
6805 .cindex "white space" "in lsearch key"
6806 In most &(lsearch)& files, keys are not required to contain colons or #
6807 characters, or white space. However, if you need this feature, it is available.
6808 If a key begins with a doublequote character, it is terminated only by a
6809 matching quote (or end of line), and the normal escaping rules apply to its
6810 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6811 quoted keys (exactly as for unquoted keys). There is no special handling of
6812 quotes for the data part of an &(lsearch)& line.
6813
6814 .next
6815 .cindex "NIS lookup type"
6816 .cindex "lookup" "NIS"
6817 .cindex "binary zero" "in lookup key"
6818 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6819 the given key, without a terminating binary zero. There is a variant called
6820 &(nis0)& which does include the terminating binary zero in the key. This is
6821 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6822 aliases; the full map names must be used.
6823
6824 .next
6825 .cindex "wildlsearch lookup type"
6826 .cindex "lookup" "wildlsearch"
6827 .cindex "nwildlsearch lookup type"
6828 .cindex "lookup" "nwildlsearch"
6829 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6830 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6831 the file may be wildcarded. The difference between these two lookup types is
6832 that for &(wildlsearch)&, each key in the file is string-expanded before being
6833 used, whereas for &(nwildlsearch)&, no expansion takes place.
6834
6835 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6836 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6837 file that are regular expressions can be made case-sensitive by the use of
6838 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6839
6840 . ==== As this is a nested list, any displays it contains must be indented
6841 . ==== as otherwise they are too far to the left.
6842
6843 .olist
6844 The string may begin with an asterisk to mean &"ends with"&. For example:
6845 .code
6846     *.a.b.c       data for anything.a.b.c
6847     *fish         data for anythingfish
6848 .endd
6849 .next
6850 The string may begin with a circumflex to indicate a regular expression. For
6851 example, for &(wildlsearch)&:
6852 .code
6853     ^\N\d+\.a\.b\N    data for <digits>.a.b
6854 .endd
6855 Note the use of &`\N`& to disable expansion of the contents of the regular
6856 expression. If you are using &(nwildlsearch)&, where the keys are not
6857 string-expanded, the equivalent entry is:
6858 .code
6859     ^\d+\.a\.b        data for <digits>.a.b
6860 .endd
6861 The case-insensitive flag is set at the start of compiling the regular
6862 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6863 For example, to make the entire pattern case-sensitive:
6864 .code
6865     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6866 .endd
6867
6868 If the regular expression contains white space or colon characters, you must
6869 either quote it (see &(lsearch)& above), or represent these characters in other
6870 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6871 colon. This may be easier than quoting, because if you quote, you have to
6872 escape all the backslashes inside the quotes.
6873
6874 &*Note*&: It is not possible to capture substrings in a regular expression
6875 match for later use, because the results of all lookups are cached. If a lookup
6876 is repeated, the result is taken from the cache, and no actual pattern matching
6877 takes place. The values of all the numeric variables are unset after a
6878 &((n)wildlsearch)& match.
6879
6880 .next
6881 Although I cannot see it being of much use, the general matching function that
6882 is used to implement &((n)wildlsearch)& means that the string may begin with a
6883 lookup name terminated by a semicolon, and followed by lookup data. For
6884 example:
6885 .code
6886     cdb;/some/file  data for keys that match the file
6887 .endd
6888 The data that is obtained from the nested lookup is discarded.
6889 .endlist olist
6890
6891 Keys that do not match any of these patterns are interpreted literally. The
6892 continuation rules for the data are the same as for &(lsearch)&, and keys may
6893 be followed by optional colons.
6894
6895 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6896 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6897 lookup types support only literal keys.
6898
6899 .next
6900 .cindex "lookup" "spf"
6901 If Exim is built with SPF support, manual lookups can be done
6902 (as opposed to the standard ACL condition method.
6903 For details see section &<<SECSPF>>&.
6904 .endlist ilist
6905
6906
6907 .section "Query-style lookup types" "SECTquerystylelookups"
6908 .cindex "lookup" "query-style types"
6909 .cindex "query-style lookup" "list of types"
6910 The supported query-style lookup types are listed below. Further details about
6911 many of them are given in later sections.
6912
6913 .ilist
6914 .cindex "DNS" "as a lookup type"
6915 .cindex "lookup" "DNS"
6916 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6917 are given in the supplied query. The resulting data is the contents of the
6918 records. See section &<<SECTdnsdb>>&.
6919 .next
6920 .cindex "InterBase lookup type"
6921 .cindex "lookup" "InterBase"
6922 &(ibase)&: This does a lookup in an InterBase database.
6923 .next
6924 .cindex "LDAP" "lookup type"
6925 .cindex "lookup" "LDAP"
6926 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6927 returns attributes from a single entry. There is a variant called &(ldapm)&
6928 that permits values from multiple entries to be returned. A third variant
6929 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6930 any attribute values. See section &<<SECTldap>>&.
6931 .next
6932 .cindex "MySQL" "lookup type"
6933 .cindex "lookup" "MySQL"
6934 &(mysql)&: The format of the query is an SQL statement that is passed to a
6935 MySQL database. See section &<<SECTsql>>&.
6936 .next
6937 .cindex "NIS+ lookup type"
6938 .cindex "lookup" "NIS+"
6939 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6940 the field to be returned. See section &<<SECTnisplus>>&.
6941 .next
6942 .cindex "Oracle" "lookup type"
6943 .cindex "lookup" "Oracle"
6944 &(oracle)&: The format of the query is an SQL statement that is passed to an
6945 Oracle database. See section &<<SECTsql>>&.
6946 .next
6947 .cindex "lookup" "passwd"
6948 .cindex "passwd lookup type"
6949 .cindex "&_/etc/passwd_&"
6950 &(passwd)& is a query-style lookup with queries that are just user names. The
6951 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6952 success, the result string is the same as you would get from an &(lsearch)&
6953 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6954 password value. For example:
6955 .code
6956 *:42:42:King Rat:/home/kr:/bin/bash
6957 .endd
6958 .next
6959 .cindex "PostgreSQL lookup type"
6960 .cindex "lookup" "PostgreSQL"
6961 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6962 PostgreSQL database. See section &<<SECTsql>>&.
6963
6964 .next
6965 .cindex "Redis lookup type"
6966 .cindex lookup Redis
6967 &(redis)&: The format of the query is either a simple get or simple set,
6968 passed to a Redis database. See section &<<SECTsql>>&.
6969
6970 .next
6971 .cindex "sqlite lookup type"
6972 .cindex "lookup" "sqlite"
6973 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6974 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6975
6976 .next
6977 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6978 not likely to be useful in normal operation.
6979 .next
6980 .cindex "whoson lookup type"
6981 .cindex "lookup" "whoson"
6982 . --- still http:-only, 2018-09-07
6983 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6984 allows a server to check whether a particular (dynamically allocated) IP
6985 address is currently allocated to a known (trusted) user and, optionally, to
6986 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6987 at one time for &"POP before SMTP"& authentication, but that approach has been
6988 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6989 &"POP before SMTP"& checking using ACL statements such as
6990 .code
6991 require condition = \
6992   ${lookup whoson {$sender_host_address}{yes}{no}}
6993 .endd
6994 The query consists of a single IP address. The value returned is the name of
6995 the authenticated user, which is stored in the variable &$value$&. However, in
6996 this example, the data in &$value$& is not used; the result of the lookup is
6997 one of the fixed strings &"yes"& or &"no"&.
6998 .endlist
6999
7000
7001
7002 .section "Temporary errors in lookups" "SECID63"
7003 .cindex "lookup" "temporary error in"
7004 Lookup functions can return temporary error codes if the lookup cannot be
7005 completed. For example, an SQL or LDAP database might be unavailable. For this
7006 reason, it is not advisable to use a lookup that might do this for critical
7007 options such as a list of local domains.
7008
7009 When a lookup cannot be completed in a router or transport, delivery
7010 of the message (to the relevant address) is deferred, as for any other
7011 temporary error. In other circumstances Exim may assume the lookup has failed,
7012 or may give up altogether.
7013
7014
7015
7016 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7017 .cindex "wildcard lookups"
7018 .cindex "lookup" "default values"
7019 .cindex "lookup" "wildcard"
7020 .cindex "lookup" "* added to type"
7021 .cindex "default" "in single-key lookups"
7022 In this context, a &"default value"& is a value specified by the administrator
7023 that is to be used if a lookup fails.
7024
7025 &*Note:*& This section applies only to single-key lookups. For query-style
7026 lookups, the facilities of the query language must be used. An attempt to
7027 specify a default for a query-style lookup provokes an error.
7028
7029 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7030 and the initial lookup fails, the key &"*"& is looked up in the file to
7031 provide a default value. See also the section on partial matching below.
7032
7033 .cindex "*@ with single-key lookup"
7034 .cindex "lookup" "*@ added to type"
7035 .cindex "alias file" "per-domain default"
7036 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7037 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7038 character, a second lookup is done with everything before the last @ replaced
7039 by *. This makes it possible to provide per-domain defaults in alias files
7040 that include the domains in the keys. If the second lookup fails (or doesn't
7041 take place because there is no @ in the key), &"*"& is looked up.
7042 For example, a &(redirect)& router might contain:
7043 .code
7044 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7045 .endd
7046 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7047 looks up these keys, in this order:
7048 .code
7049 jane@eyre.example
7050 *@eyre.example
7051 *
7052 .endd
7053 The data is taken from whichever key it finds first. &*Note*&: In an
7054 &(lsearch)& file, this does not mean the first of these keys in the file. A
7055 complete scan is done for each key, and only if it is not found at all does
7056 Exim move on to try the next key.
7057
7058
7059
7060 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7061 .cindex "partial matching"
7062 .cindex "wildcard lookups"
7063 .cindex "lookup" "partial matching"
7064 .cindex "lookup" "wildcard"
7065 .cindex "asterisk" "in search type"
7066 The normal operation of a single-key lookup is to search the file for an exact
7067 match with the given key. However, in a number of situations where domains are
7068 being looked up, it is useful to be able to do partial matching. In this case,
7069 information in the file that has a key starting with &"*."& is matched by any
7070 domain that ends with the components that follow the full stop. For example, if
7071 a key in a DBM file is
7072 .code
7073 *.dates.fict.example
7074 .endd
7075 then when partial matching is enabled this is matched by (amongst others)
7076 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7077 by &'dates.fict.example'&, if that does not appear as a separate key in the
7078 file.
7079
7080 &*Note*&: Partial matching is not available for query-style lookups. It is
7081 also not available for any lookup items in address lists (see section
7082 &<<SECTaddresslist>>&).
7083
7084 Partial matching is implemented by doing a series of separate lookups using
7085 keys constructed by modifying the original subject key. This means that it can
7086 be used with any of the single-key lookup types, provided that
7087 partial matching keys
7088 beginning with a special prefix (default &"*."&) are included in the data file.
7089 Keys in the file that do not begin with the prefix are matched only by
7090 unmodified subject keys when partial matching is in use.
7091
7092 Partial matching is requested by adding the string &"partial-"& to the front of
7093 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7094 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7095 is added at the start of the subject key, and it is looked up again. If that
7096 fails, further lookups are tried with dot-separated components removed from the
7097 start of the subject key, one-by-one, and &"*."& added on the front of what
7098 remains.
7099
7100 A minimum number of two non-* components are required. This can be adjusted
7101 by including a number before the hyphen in the search type. For example,
7102 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7103 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7104 subject key is &'2250.dates.fict.example'& then the following keys are looked
7105 up when the minimum number of non-* components is two:
7106 .code
7107 2250.dates.fict.example
7108 *.2250.dates.fict.example
7109 *.dates.fict.example
7110 *.fict.example
7111 .endd
7112 As soon as one key in the sequence is successfully looked up, the lookup
7113 finishes.
7114
7115 .cindex "lookup" "partial matching &-- changing prefix"
7116 .cindex "prefix" "for partial matching"
7117 The use of &"*."& as the partial matching prefix is a default that can be
7118 changed. The motivation for this feature is to allow Exim to operate with file
7119 formats that are used by other MTAs. A different prefix can be supplied in
7120 parentheses instead of the hyphen after &"partial"&. For example:
7121 .code
7122 domains = partial(.)lsearch;/some/file
7123 .endd
7124 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7125 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7126 components is unchanged). The prefix may consist of any punctuation characters
7127 other than a closing parenthesis. It may be empty, for example:
7128 .code
7129 domains = partial1()cdb;/some/file
7130 .endd
7131 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7132 &`a.b.c`&, &`b.c`&, and &`c`&.
7133
7134 If &"partial0"& is specified, what happens at the end (when the lookup with
7135 just one non-wild component has failed, and the original key is shortened right
7136 down to the null string) depends on the prefix:
7137
7138 .ilist
7139 If the prefix has zero length, the whole lookup fails.
7140 .next
7141 If the prefix has length 1, a lookup for just the prefix is done. For
7142 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7143 .next
7144 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7145 remainder is looked up. With the default prefix, therefore, the final lookup is
7146 for &"*"& on its own.
7147 .next
7148 Otherwise, the whole prefix is looked up.
7149 .endlist
7150
7151
7152 If the search type ends in &"*"& or &"*@"& (see section
7153 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7154 this implies happens after all partial lookups have failed. If &"partial0"& is
7155 specified, adding &"*"& to the search type has no effect with the default
7156 prefix, because the &"*"& key is already included in the sequence of partial
7157 lookups. However, there might be a use for lookup types such as
7158 &"partial0(.)lsearch*"&.
7159
7160 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7161 in domain lists and the like. Partial matching works only in terms of
7162 dot-separated components; a key such as &`*fict.example`&
7163 in a database file is useless, because the asterisk in a partial matching
7164 subject key is always followed by a dot.
7165
7166
7167
7168
7169 .section "Lookup caching" "SECID64"
7170 .cindex "lookup" "caching"
7171 .cindex "caching" "lookup data"
7172 Exim caches all lookup results in order to avoid needless repetition of
7173 lookups. However, because (apart from the daemon) Exim operates as a collection
7174 of independent, short-lived processes, this caching applies only within a
7175 single Exim process. There is no inter-process lookup caching facility.
7176
7177 For single-key lookups, Exim keeps the relevant files open in case there is
7178 another lookup that needs them. In some types of configuration this can lead to
7179 many files being kept open for messages with many recipients. To avoid hitting
7180 the operating system limit on the number of simultaneously open files, Exim
7181 closes the least recently used file when it needs to open more files than its
7182 own internal limit, which can be changed via the &%lookup_open_max%& option.
7183
7184 The single-key lookup files are closed and the lookup caches are flushed at
7185 strategic points during delivery &-- for example, after all routing is
7186 complete.
7187
7188
7189
7190
7191 .section "Quoting lookup data" "SECID65"
7192 .cindex "lookup" "quoting"
7193 .cindex "quoting" "in lookups"
7194 When data from an incoming message is included in a query-style lookup, there
7195 is the possibility of special characters in the data messing up the syntax of
7196 the query. For example, a NIS+ query that contains
7197 .code
7198 [name=$local_part]
7199 .endd
7200 will be broken if the local part happens to contain a closing square bracket.
7201 For NIS+, data can be enclosed in double quotes like this:
7202 .code
7203 [name="$local_part"]
7204 .endd
7205 but this still leaves the problem of a double quote in the data. The rule for
7206 NIS+ is that double quotes must be doubled. Other lookup types have different
7207 rules, and to cope with the differing requirements, an expansion operator
7208 of the following form is provided:
7209 .code
7210 ${quote_<lookup-type>:<string>}
7211 .endd
7212 For example, the safest way to write the NIS+ query is
7213 .code
7214 [name="${quote_nisplus:$local_part}"]
7215 .endd
7216 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7217 operator can be used for all lookup types, but has no effect for single-key
7218 lookups, since no quoting is ever needed in their key strings.
7219
7220
7221
7222
7223 .section "More about dnsdb" "SECTdnsdb"
7224 .cindex "dnsdb lookup"
7225 .cindex "lookup" "dnsdb"
7226 .cindex "DNS" "as a lookup type"
7227 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7228 of a record type and a domain name, separated by an equals sign. For example,
7229 an expansion string could contain:
7230 .code
7231 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7232 .endd
7233 If the lookup succeeds, the result is placed in &$value$&, which in this case
7234 is used on its own as the result. If the lookup does not succeed, the
7235 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7236 &<<SECTforexpfai>>& for an explanation of what this means.
7237
7238 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7239 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7240 If no type is given, TXT is assumed.
7241
7242 For any record type, if multiple records are found, the data is returned as a
7243 concatenation, with newline as the default separator. The order, of course,
7244 depends on the DNS resolver. You can specify a different separator character
7245 between multiple records by putting a right angle-bracket followed immediately
7246 by the new separator at the start of the query. For example:
7247 .code
7248 ${lookup dnsdb{>: a=host1.example}}
7249 .endd
7250 It is permitted to specify a space as the separator character. Further
7251 white space is ignored.
7252 For lookup types that return multiple fields per record,
7253 an alternate field separator can be specified using a comma after the main
7254 separator character, followed immediately by the field separator.
7255
7256 .cindex "PTR record" "in &(dnsdb)& lookup"
7257 When the type is PTR,
7258 the data can be an IP address, written as normal; inversion and the addition of
7259 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7260 .code
7261 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7262 .endd
7263 If the data for a PTR record is not a syntactically valid IP address, it is not
7264 altered and nothing is added.
7265
7266 .cindex "MX record" "in &(dnsdb)& lookup"
7267 .cindex "SRV record" "in &(dnsdb)& lookup"
7268 For an MX lookup, both the preference value and the host name are returned for
7269 each record, separated by a space. For an SRV lookup, the priority, weight,
7270 port, and host name are returned for each record, separated by spaces.
7271 The field separator can be modified as above.
7272
7273 .cindex "TXT record" "in &(dnsdb)& lookup"
7274 .cindex "SPF record" "in &(dnsdb)& lookup"
7275 For TXT records with multiple items of data, only the first item is returned,
7276 unless a field separator is specified.
7277 To concatenate items without a separator, use a semicolon instead.
7278 For SPF records the
7279 default behaviour is to concatenate multiple items without using a separator.
7280 .code
7281 ${lookup dnsdb{>\n,: txt=a.b.example}}
7282 ${lookup dnsdb{>\n; txt=a.b.example}}
7283 ${lookup dnsdb{spf=example.org}}
7284 .endd
7285 It is permitted to specify a space as the separator character. Further
7286 white space is ignored.
7287
7288 .cindex "SOA record" "in &(dnsdb)& lookup"
7289 For an SOA lookup, while no result is obtained the lookup is redone with
7290 successively more leading components dropped from the given domain.
7291 Only the primary-nameserver field is returned unless a field separator is
7292 specified.
7293 .code
7294 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7295 .endd
7296
7297 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7298 .cindex "dnsdb modifiers"
7299 .cindex "modifiers" "dnsdb"
7300 .cindex "options" "dnsdb"
7301 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7302 each followed by a comma,
7303 that may appear before the record type.
7304
7305 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7306 temporary DNS error for any of them, the behaviour is controlled by
7307 a defer-option modifier.
7308 The possible keywords are
7309 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7310 With &"strict"& behaviour, any temporary DNS error causes the
7311 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7312 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7313 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7314 error causes the whole lookup to defer only if none of the other lookups
7315 succeed. The default is &"lax"&, so the following lookups are equivalent:
7316 .code
7317 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7318 ${lookup dnsdb{a=one.host.com:two.host.com}}
7319 .endd
7320 Thus, in the default case, as long as at least one of the DNS lookups
7321 yields some data, the lookup succeeds.
7322
7323 .cindex "DNSSEC" "dns lookup"
7324 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7325 The possible keywords are
7326 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7327 With &"strict"& or &"lax"& DNSSEC information is requested
7328 with the lookup.
7329 With &"strict"& a response from the DNS resolver that
7330 is not labelled as authenticated data
7331 is treated as equivalent to a temporary DNS error.
7332 The default is &"lax"&.
7333
7334 See also the &$lookup_dnssec_authenticated$& variable.
7335
7336 .cindex timeout "dns lookup"
7337 .cindex "DNS" timeout
7338 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7339 The form is &"retrans_VAL"& where VAL is an Exim time specification
7340 (e.g. &"5s"&).
7341 The default value is set by the main configuration option &%dns_retrans%&.
7342
7343 Retries for the dnsdb lookup can be controlled by a retry modifier.
7344 The form if &"retry_VAL"& where VAL is an integer.
7345 The default count is set by the main configuration option &%dns_retry%&.
7346
7347 .cindex caching "of dns lookup"
7348 .cindex TTL "of dns lookup"
7349 .cindex DNS TTL
7350 Dnsdb lookup results are cached within a single process (and its children).
7351 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7352 value of the set of returned DNS records.
7353
7354
7355 .section "Pseudo dnsdb record types" "SECID66"
7356 .cindex "MX record" "in &(dnsdb)& lookup"
7357 By default, both the preference value and the host name are returned for
7358 each MX record, separated by a space. If you want only host names, you can use
7359 the pseudo-type MXH:
7360 .code
7361 ${lookup dnsdb{mxh=a.b.example}}
7362 .endd
7363 In this case, the preference values are omitted, and just the host names are
7364 returned.
7365
7366 .cindex "name server for enclosing domain"
7367 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7368 records on the given domain, but if none are found, it removes the first
7369 component of the domain name, and tries again. This process continues until NS
7370 records are found or there are no more components left (or there is a DNS
7371 error). In other words, it may return the name servers for a top-level domain,
7372 but it never returns the root name servers. If there are no NS records for the
7373 top-level domain, the lookup fails. Consider these examples:
7374 .code
7375 ${lookup dnsdb{zns=xxx.quercite.com}}
7376 ${lookup dnsdb{zns=xxx.edu}}
7377 .endd
7378 Assuming that in each case there are no NS records for the full domain name,
7379 the first returns the name servers for &%quercite.com%&, and the second returns
7380 the name servers for &%edu%&.
7381
7382 You should be careful about how you use this lookup because, unless the
7383 top-level domain does not exist, the lookup always returns some host names. The
7384 sort of use to which this might be put is for seeing if the name servers for a
7385 given domain are on a blacklist. You can probably assume that the name servers
7386 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7387 such a list.
7388
7389 .cindex "CSA" "in &(dnsdb)& lookup"
7390 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7391 records according to the CSA rules, which are described in section
7392 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7393 not sufficient because of the extra parent domain search behaviour of CSA. The
7394 result of a successful lookup such as:
7395 .code
7396 ${lookup dnsdb {csa=$sender_helo_name}}
7397 .endd
7398 has two space-separated fields: an authorization code and a target host name.
7399 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7400 authorization required but absent, or &"?"& for unknown.
7401
7402 .cindex "A+" "in &(dnsdb)& lookup"
7403 The pseudo-type A+ performs an AAAA
7404 and then an A lookup.  All results are returned; defer processing
7405 (see below) is handled separately for each lookup.  Example:
7406 .code
7407 ${lookup dnsdb {>; a+=$sender_helo_name}}
7408 .endd
7409
7410
7411 .section "Multiple dnsdb lookups" "SECID67"
7412 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7413 However, you can specify a list of domains or IP addresses in a single
7414 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7415 the default separator, but with the ability to change this. For example:
7416 .code
7417 ${lookup dnsdb{one.domain.com:two.domain.com}}
7418 ${lookup dnsdb{a=one.host.com:two.host.com}}
7419 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7420 .endd
7421 In order to retain backwards compatibility, there is one special case: if
7422 the lookup type is PTR and no change of separator is specified, Exim looks
7423 to see if the rest of the string is precisely one IPv6 address. In this
7424 case, it does not treat it as a list.
7425
7426 The data from each lookup is concatenated, with newline separators by default,
7427 in the same way that multiple DNS records for a single item are handled. A
7428 different separator can be specified, as described above.
7429
7430
7431
7432
7433 .section "More about LDAP" "SECTldap"
7434 .cindex "LDAP" "lookup, more about"
7435 .cindex "lookup" "LDAP"
7436 .cindex "Solaris" "LDAP"
7437 The original LDAP implementation came from the University of Michigan; this has
7438 become &"Open LDAP"&, and there are now two different releases. Another
7439 implementation comes from Netscape, and Solaris 7 and subsequent releases
7440 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7441 the lookup function level, their error handling is different. For this reason
7442 it is necessary to set a compile-time variable when building Exim with LDAP, to
7443 indicate which LDAP library is in use. One of the following should appear in
7444 your &_Local/Makefile_&:
7445 .code
7446 LDAP_LIB_TYPE=UMICHIGAN
7447 LDAP_LIB_TYPE=OPENLDAP1
7448 LDAP_LIB_TYPE=OPENLDAP2
7449 LDAP_LIB_TYPE=NETSCAPE
7450 LDAP_LIB_TYPE=SOLARIS
7451 .endd
7452 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7453 same interface as the University of Michigan version.
7454
7455 There are three LDAP lookup types in Exim. These behave slightly differently in
7456 the way they handle the results of a query:
7457
7458 .ilist
7459 &(ldap)& requires the result to contain just one entry; if there are more, it
7460 gives an error.
7461 .next
7462 &(ldapdn)& also requires the result to contain just one entry, but it is the
7463 Distinguished Name that is returned rather than any attribute values.
7464 .next
7465 &(ldapm)& permits the result to contain more than one entry; the attributes
7466 from all of them are returned.
7467 .endlist
7468
7469
7470 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7471 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7472 the data returned by a successful lookup is described in the next section.
7473 First we explain how LDAP queries are coded.
7474
7475
7476 .section "Format of LDAP queries" "SECTforldaque"
7477 .cindex "LDAP" "query format"
7478 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7479 the configuration of a &(redirect)& router one might have this setting:
7480 .code
7481 data = ${lookup ldap \
7482   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7483   c=UK?mailbox?base?}}
7484 .endd
7485 .cindex "LDAP" "with TLS"
7486 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7487 secure (encrypted) LDAP connections. The second of these ensures that an
7488 encrypted TLS connection is used.
7489
7490 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7491 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7492 See the &%ldap_start_tls%& option.
7493
7494 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7495 controlled. Every part of the TLS configuration can be configured by settings in
7496 &_exim.conf_&. Depending on the version of the client libraries installed on
7497 your system, some of the initialization may have required setting options in
7498 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7499 certificates. This revealed a nuance where the current UID that exim was
7500 running as could affect which config files it read. With Exim 4.83, these
7501 methods become optional, only taking effect if not specifically set in
7502 &_exim.conf_&.
7503
7504
7505 .section "LDAP quoting" "SECID68"
7506 .cindex "LDAP" "quoting"
7507 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7508 and the second because the LDAP query is represented as a URL. Furthermore,
7509 within an LDAP query, two different kinds of quoting are required. For this
7510 reason, there are two different LDAP-specific quoting operators.
7511
7512 The &%quote_ldap%& operator is designed for use on strings that are part of
7513 filter specifications. Conceptually, it first does the following conversions on
7514 the string:
7515 .code
7516 *   =>   \2A
7517 (   =>   \28
7518 )   =>   \29
7519 \   =>   \5C
7520 .endd
7521 in accordance with RFC 2254. The resulting string is then quoted according
7522 to the rules for URLs, that is, all non-alphanumeric characters except
7523 .code
7524 ! $ ' - . _ ( ) * +
7525 .endd
7526 are converted to their hex values, preceded by a percent sign. For example:
7527 .code
7528 ${quote_ldap: a(bc)*, a<yz>; }
7529 .endd
7530 yields
7531 .code
7532 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7533 .endd
7534 Removing the URL quoting, this is (with a leading and a trailing space):
7535 .code
7536 a\28bc\29\2A, a<yz>;
7537 .endd
7538 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7539 base DN specifications in queries. Conceptually, it first converts the string
7540 by inserting a backslash in front of any of the following characters:
7541 .code
7542 , + " \ < > ;
7543 .endd
7544 It also inserts a backslash before any leading spaces or # characters, and
7545 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7546 is then quoted according to the rules for URLs. For example:
7547 .code
7548 ${quote_ldap_dn: a(bc)*, a<yz>; }
7549 .endd
7550 yields
7551 .code
7552 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7553 .endd
7554 Removing the URL quoting, this is (with a trailing space):
7555 .code
7556 \ a(bc)*\, a\<yz\>\;\
7557 .endd
7558 There are some further comments about quoting in the section on LDAP
7559 authentication below.
7560
7561
7562 .section "LDAP connections" "SECID69"
7563 .cindex "LDAP" "connections"
7564 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7565 is in use, via a Unix domain socket. The example given above does not specify
7566 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7567 by starting it with
7568 .code
7569 ldap://<hostname>:<port>/...
7570 .endd
7571 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7572 used. When no server is specified in a query, a list of default servers is
7573 taken from the &%ldap_default_servers%& configuration option. This supplies a
7574 colon-separated list of servers which are tried in turn until one successfully
7575 handles a query, or there is a serious error. Successful handling either
7576 returns the requested data, or indicates that it does not exist. Serious errors
7577 are syntactical, or multiple values when only a single value is expected.
7578 Errors which cause the next server to be tried are connection failures, bind
7579 failures, and timeouts.
7580
7581 For each server name in the list, a port number can be given. The standard way
7582 of specifying a host and port is to use a colon separator (RFC 1738). Because
7583 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7584 doubled. For example
7585 .code
7586 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7587 .endd
7588 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7589 to the LDAP library with no server name, and the library's default (normally
7590 the local host) is used.
7591
7592 If you are using the OpenLDAP library, you can connect to an LDAP server using
7593 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7594 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7595 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7596 not available.
7597
7598 For this type of connection, instead of a host name for the server, a pathname
7599 for the socket is required, and the port number is not relevant. The pathname
7600 can be specified either as an item in &%ldap_default_servers%&, or inline in
7601 the query. In the former case, you can have settings such as
7602 .code
7603 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7604 .endd
7605 When the pathname is given in the query, you have to escape the slashes as
7606 &`%2F`& to fit in with the LDAP URL syntax. For example:
7607 .code
7608 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7609 .endd
7610 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7611 a pathname, it uses the Unix domain socket code, even if the query actually
7612 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7613 socket connection. This behaviour means that you can use a setting of
7614 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7615 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7616 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7617 backup host.
7618
7619 If an explicit &`ldapi`& type is given in a query when a host name is
7620 specified, an error is diagnosed. However, if there are more items in
7621 &%ldap_default_servers%&, they are tried. In other words:
7622
7623 .ilist
7624 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7625 interface.
7626 .next
7627 Using &`ldapi`& with a host name causes an error.
7628 .endlist
7629
7630
7631 Using &`ldapi`& with no host or path in the query, and no setting of
7632 &%ldap_default_servers%&, does whatever the library does by default.
7633
7634
7635
7636 .section "LDAP authentication and control information" "SECID70"
7637 .cindex "LDAP" "authentication"
7638 The LDAP URL syntax provides no way of passing authentication and other control
7639 information to the server. To make this possible, the URL in an LDAP query may
7640 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7641 spaces. If a value contains spaces it must be enclosed in double quotes, and
7642 when double quotes are used, backslash is interpreted in the usual way inside
7643 them. The following names are recognized:
7644 .display
7645 &`DEREFERENCE`&  set the dereferencing parameter
7646 &`NETTIME    `&  set a timeout for a network operation
7647 &`USER       `&  set the DN, for authenticating the LDAP bind
7648 &`PASS       `&  set the password, likewise
7649 &`REFERRALS  `&  set the referrals parameter
7650 &`SERVERS    `&  set alternate server list for this query only
7651 &`SIZE       `&  set the limit for the number of entries returned
7652 &`TIME       `&  set the maximum waiting time for a query
7653 .endd
7654 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7655 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7656 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7657 library from trying to follow referrals issued by the LDAP server.
7658
7659 .cindex LDAP timeout
7660 .cindex timeout "LDAP lookup"
7661 The name CONNECT is an obsolete name for NETTIME, retained for
7662 backwards compatibility. This timeout (specified as a number of seconds) is
7663 enforced from the client end for operations that can be carried out over a
7664 network. Specifically, it applies to network connections and calls to the
7665 &'ldap_result()'& function. If the value is greater than zero, it is used if
7666 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7667 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7668 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7669 Netscape SDK; for OpenLDAP no action is taken.
7670
7671 The TIME parameter (also a number of seconds) is passed to the server to
7672 set a server-side limit on the time taken to complete a search.
7673
7674 The SERVERS parameter allows you to specify an alternate list of ldap servers
7675 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7676 default list of ldap servers, and a single lookup can specify a single ldap
7677 server to use.  But when you need to do a lookup with a list of servers that is
7678 different than the default list (maybe different order, maybe a completely
7679 different set of servers), the SERVERS parameter allows you to specify this
7680 alternate list (colon-separated).
7681
7682 Here is an example of an LDAP query in an Exim lookup that uses some of these
7683 values. This is a single line, folded to fit on the page:
7684 .code
7685 ${lookup ldap
7686   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7687   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7688   {$value}fail}
7689 .endd
7690 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7691 any of the auxiliary data. Exim configuration settings that include lookups
7692 which contain password information should be preceded by &"hide"& to prevent
7693 non-admin users from using the &%-bP%& option to see their values.
7694
7695 The auxiliary data items may be given in any order. The default is no
7696 connection timeout (the system timeout is used), no user or password, no limit
7697 on the number of entries returned, and no time limit on queries.
7698
7699 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7700 removes any URL quoting that it may contain before passing it LDAP. Apparently
7701 some libraries do this for themselves, but some do not. Removing the URL
7702 quoting has two advantages:
7703
7704 .ilist
7705 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7706 DNs as with DNs inside actual queries.
7707 .next
7708 It permits spaces inside USER= DNs.
7709 .endlist
7710
7711 For example, a setting such as
7712 .code
7713 USER=cn=${quote_ldap_dn:$1}
7714 .endd
7715 should work even if &$1$& contains spaces.
7716
7717 Expanded data for the PASS= value should be quoted using the &%quote%&
7718 expansion operator, rather than the LDAP quote operators. The only reason this
7719 field needs quoting is to ensure that it conforms to the Exim syntax, which
7720 does not allow unquoted spaces. For example:
7721 .code
7722 PASS=${quote:$3}
7723 .endd
7724 The LDAP authentication mechanism can be used to check passwords as part of
7725 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7726 &<<CHAPexpand>>&.
7727
7728
7729
7730 .section "Format of data returned by LDAP" "SECID71"
7731 .cindex "LDAP" "returned data formats"
7732 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7733 as a sequence of values, for example
7734 .code
7735 cn=manager,o=University of Cambridge,c=UK
7736 .endd
7737 The &(ldap)& lookup type generates an error if more than one entry matches the
7738 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7739 the result between the data from different entries. It is possible for multiple
7740 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7741 you know that whatever values are returned all came from a single entry in the
7742 directory.
7743
7744 In the common case where you specify a single attribute in your LDAP query, the
7745 result is not quoted, and does not contain the attribute name. If the attribute
7746 has multiple values, they are separated by commas. Any comma that is
7747 part of an attribute's value is doubled.
7748
7749 If you specify multiple attributes, the result contains space-separated, quoted
7750 strings, each preceded by the attribute name and an equals sign. Within the
7751 quotes, the quote character, backslash, and newline are escaped with
7752 backslashes, and commas are used to separate multiple values for the attribute.
7753 Any commas in attribute values are doubled
7754 (permitting treatment of the values as a comma-separated list).
7755 Apart from the escaping, the string within quotes takes the same form as the
7756 output when a single attribute is requested. Specifying no attributes is the
7757 same as specifying all of an entry's attributes.
7758
7759 Here are some examples of the output format. The first line of each pair is an
7760 LDAP query, and the second is the data that is returned. The attribute called
7761 &%attr1%& has two values, one of them with an embedded comma, whereas
7762 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7763 (they have SUP &%attr%& in their schema definitions).
7764
7765 .code
7766 ldap:///o=base?attr1?sub?(uid=fred)
7767 value1.1,value1,,2
7768
7769 ldap:///o=base?attr2?sub?(uid=fred)
7770 value two
7771
7772 ldap:///o=base?attr?sub?(uid=fred)
7773 value1.1,value1,,2,value two
7774
7775 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7776 attr1="value1.1,value1,,2" attr2="value two"
7777
7778 ldap:///o=base??sub?(uid=fred)
7779 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7780 .endd
7781 You can
7782 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7783 results of LDAP lookups.
7784 The &%extract%& operator in string expansions can be used to pick out
7785 individual fields from data that consists of &'key'&=&'value'& pairs.
7786 The &%listextract%& operator should be used to pick out individual values
7787 of attributes, even when only a single value is expected.
7788 The doubling of embedded commas allows you to use the returned data as a
7789 comma separated list (using the "<," syntax for changing the input list separator).
7790
7791
7792
7793
7794 .section "More about NIS+" "SECTnisplus"
7795 .cindex "NIS+ lookup type"
7796 .cindex "lookup" "NIS+"
7797 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7798 and field name. If this is given, the result of a successful query is the
7799 contents of the named field; otherwise the result consists of a concatenation
7800 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7801 values containing spaces are quoted. For example, the query
7802 .code
7803 [name=mg1456],passwd.org_dir
7804 .endd
7805 might return the string
7806 .code
7807 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7808 home=/home/mg1456 shell=/bin/bash shadow=""
7809 .endd
7810 (split over two lines here to fit on the page), whereas
7811 .code
7812 [name=mg1456],passwd.org_dir:gcos
7813 .endd
7814 would just return
7815 .code
7816 Martin Guerre
7817 .endd
7818 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7819 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7820 operator is to double any quote characters within the text.
7821
7822
7823
7824 .section "SQL lookups" "SECTsql"
7825 .cindex "SQL lookup types"
7826 .cindex "MySQL" "lookup type"
7827 .cindex "PostgreSQL lookup type"
7828 .cindex "lookup" "MySQL"
7829 .cindex "lookup" "PostgreSQL"
7830 .cindex "Oracle" "lookup type"
7831 .cindex "lookup" "Oracle"
7832 .cindex "InterBase lookup type"
7833 .cindex "lookup" "InterBase"
7834 .cindex "Redis lookup type"
7835 .cindex lookup Redis
7836 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7837 and SQLite
7838 databases. Queries for these databases contain SQL statements, so an example
7839 might be
7840 .code
7841 ${lookup mysql{select mailbox from users where id='userx'}\
7842   {$value}fail}
7843 .endd
7844 If the result of the query contains more than one field, the data for each
7845 field in the row is returned, preceded by its name, so the result of
7846 .code
7847 ${lookup pgsql{select home,name from users where id='userx'}\
7848   {$value}}
7849 .endd
7850 might be
7851 .code
7852 home=/home/userx name="Mister X"
7853 .endd
7854 Empty values and values containing spaces are double quoted, with embedded
7855 quotes escaped by a backslash. If the result of the query contains just one
7856 field, the value is passed back verbatim, without a field name, for example:
7857 .code
7858 Mister X
7859 .endd
7860 If the result of the query yields more than one row, it is all concatenated,
7861 with a newline between the data for each row.
7862
7863
7864 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7865 .cindex "MySQL" "lookup type"
7866 .cindex "PostgreSQL lookup type"
7867 .cindex "lookup" "MySQL"
7868 .cindex "lookup" "PostgreSQL"
7869 .cindex "Oracle" "lookup type"
7870 .cindex "lookup" "Oracle"
7871 .cindex "InterBase lookup type"
7872 .cindex "lookup" "InterBase"
7873 .cindex "Redis lookup type"
7874 .cindex lookup Redis
7875 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7876 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7877 or &%redis_servers%&
7878 option (as appropriate) must be set to a colon-separated list of server
7879 information.
7880 (For MySQL and PostgreSQL, the global option need not be set if all
7881 queries contain their own server information &-- see section
7882 &<<SECTspeserque>>&.)
7883 For all but Redis
7884 each item in the list is a slash-separated list of four
7885 items: host name, database name, user name, and password. In the case of
7886 Oracle, the host name field is used for the &"service name"&, and the database
7887 name field is not used and should be empty. For example:
7888 .code
7889 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7890 .endd
7891 Because password data is sensitive, you should always precede the setting with
7892 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7893 option. Here is an example where two MySQL servers are listed:
7894 .code
7895 hide mysql_servers = localhost/users/root/secret:\
7896                      otherhost/users/root/othersecret
7897 .endd
7898 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7899 because this is a colon-separated list, the colon has to be doubled. For each
7900 query, these parameter groups are tried in order until a connection is made and
7901 a query is successfully processed. The result of a query may be that no data is
7902 found, but that is still a successful query. In other words, the list of
7903 servers provides a backup facility, not a list of different places to look.
7904
7905 For Redis the global option need not be specified if all queries contain their
7906 own server information &-- see section &<<SECTspeserque>>&.
7907 If specified, the option must be set to a colon-separated list of server
7908 information.
7909 Each item in the list is a slash-separated list of three items:
7910 host, database number, and password.
7911 .olist
7912 The host is required and may be either an IPv4 address and optional
7913 port number (separated by a colon, which needs doubling due to the
7914 higher-level list), or a Unix socket pathname enclosed in parentheses
7915 .next
7916 The database number is optional; if present that number is selected in the backend
7917 .next
7918 The password is optional; if present it is used to authenticate to the backend
7919 .endlist
7920
7921 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7922 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7923 respectively, and the characters single-quote, double-quote, and backslash
7924 itself are escaped with backslashes.
7925
7926 The &%quote_redis%& expansion operator
7927 escapes whitespace and backslash characters with a backslash.
7928
7929 .section "Specifying the server in the query" "SECTspeserque"
7930 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7931 it is possible to specify a list of servers with an individual query. This is
7932 done by starting the query with
7933 .display
7934 &`servers=`&&'server1:server2:server3:...'&&`;`&
7935 .endd
7936 Each item in the list may take one of two forms:
7937 .olist
7938 If it contains no slashes it is assumed to be just a host name. The appropriate
7939 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7940 of the same name, and the remaining parameters (database, user, password) are
7941 taken from there.
7942 .next
7943 If it contains any slashes, it is taken as a complete parameter set.
7944 .endlist
7945 The list of servers is used in exactly the same way as the global list.
7946 Once a connection to a server has happened and a query has been
7947 successfully executed, processing of the lookup ceases.
7948
7949 This feature is intended for use in master/slave situations where updates
7950 are occurring and you want to update the master rather than a slave. If the
7951 master is in the list as a backup for reading, you might have a global setting
7952 like this:
7953 .code
7954 mysql_servers = slave1/db/name/pw:\
7955                 slave2/db/name/pw:\
7956                 master/db/name/pw
7957 .endd
7958 In an updating lookup, you could then write:
7959 .code
7960 ${lookup mysql{servers=master; UPDATE ...} }
7961 .endd
7962 That query would then be sent only to the master server. If, on the other hand,
7963 the master is not to be used for reading, and so is not present in the global
7964 option, you can still update it by a query of this form:
7965 .code
7966 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7967 .endd
7968
7969
7970 .section "Special MySQL features" "SECID73"
7971 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7972 causes a connection to the server on the local host by means of a Unix domain
7973 socket. An alternate socket can be specified in parentheses.
7974 An option group name for MySQL option files can be specified in square brackets;
7975 the default value is &"exim"&.
7976 The full syntax of each item in &%mysql_servers%& is:
7977 .display
7978 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7979   <&'database'&>/<&'user'&>/<&'password'&>
7980 .endd
7981 Any of the four sub-parts of the first field can be omitted. For normal use on
7982 the local host it can be left blank or set to just &"localhost"&.
7983
7984 No database need be supplied &-- but if it is absent here, it must be given in
7985 the queries.
7986
7987 If a MySQL query is issued that does not request any data (an insert, update,
7988 or delete command), the result of the lookup is the number of rows affected.
7989
7990 &*Warning*&: This can be misleading. If an update does not actually change
7991 anything (for example, setting a field to the value it already has), the result
7992 is zero because no rows are affected.
7993
7994
7995 .section "Special PostgreSQL features" "SECID74"
7996 PostgreSQL lookups can also use Unix domain socket connections to the database.
7997 This is usually faster and costs less CPU time than a TCP/IP connection.
7998 However it can be used only if the mail server runs on the same machine as the
7999 database server. A configuration line for PostgreSQL via Unix domain sockets
8000 looks like this:
8001 .code
8002 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8003 .endd
8004 In other words, instead of supplying a host name, a path to the socket is
8005 given. The path name is enclosed in parentheses so that its slashes aren't
8006 visually confused with the delimiters for the other server parameters.
8007
8008 If a PostgreSQL query is issued that does not request any data (an insert,
8009 update, or delete command), the result of the lookup is the number of rows
8010 affected.
8011
8012 .section "More about SQLite" "SECTsqlite"
8013 .cindex "lookup" "SQLite"
8014 .cindex "sqlite lookup type"
8015 SQLite is different to the other SQL lookups because a filename is required in
8016 addition to the SQL query. An SQLite database is a single file, and there is no
8017 daemon as in the other SQL databases. The interface to Exim requires the name
8018 of the file, as an absolute path, to be given at the start of the query. It is
8019 separated from the query by white space. This means that the path name cannot
8020 contain white space. Here is a lookup expansion example:
8021 .code
8022 ${lookup sqlite {/some/thing/sqlitedb \
8023   select name from aliases where id='userx';}}
8024 .endd
8025 In a list, the syntax is similar. For example:
8026 .code
8027 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8028    select * from relays where ip='$sender_host_address';
8029 .endd
8030 The only character affected by the &%quote_sqlite%& operator is a single
8031 quote, which it doubles.
8032
8033 .cindex timeout SQLite
8034 .cindex sqlite "lookup timeout"
8035 The SQLite library handles multiple simultaneous accesses to the database
8036 internally. Multiple readers are permitted, but only one process can
8037 update at once. Attempts to access the database while it is being updated
8038 are rejected after a timeout period, during which the SQLite library
8039 waits for the lock to be released. In Exim, the default timeout is set
8040 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8041 option.
8042
8043 .section "More about Redis" "SECTredis"
8044 .cindex "lookup" "Redis"
8045 .cindex "redis lookup type"
8046 Redis is a non-SQL database. Commands are simple get and set.
8047 Examples:
8048 .code
8049 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8050 ${lookup redis{get keyname}}
8051 .endd
8052
8053 As of release 4.91, "lightweight" support for Redis Cluster is available.
8054 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8055 of which must be reachable from the running exim instance. If the cluster has
8056 master/slave replication, the list must contain all the master and slave
8057 servers.
8058
8059 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8060 immediately follow the redirection but treats the response as a DEFER, moving on
8061 to the next server in the &%redis_servers%& list until the correct server is
8062 reached.
8063
8064 .ecindex IIDfidalo1
8065 .ecindex IIDfidalo2
8066
8067
8068 . ////////////////////////////////////////////////////////////////////////////
8069 . ////////////////////////////////////////////////////////////////////////////
8070
8071 .chapter "Domain, host, address, and local part lists" &&&
8072          "CHAPdomhosaddlists" &&&
8073          "Domain, host, and address lists"
8074 .scindex IIDdohoadli "lists of domains; hosts; etc."
8075 A number of Exim configuration options contain lists of domains, hosts,
8076 email addresses, or local parts. For example, the &%hold_domains%& option
8077 contains a list of domains whose delivery is currently suspended. These lists
8078 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8079 arguments to expansion conditions such as &%match_domain%&.
8080
8081 Each item in one of these lists is a pattern to be matched against a domain,
8082 host, email address, or local part, respectively. In the sections below, the
8083 different types of pattern for each case are described, but first we cover some
8084 general facilities that apply to all four kinds of list.
8085
8086 Note that other parts of Exim use a &'string list'& which does not
8087 support all the complexity available in
8088 domain, host, address and local part lists.
8089
8090
8091
8092 .section "Expansion of lists" "SECTlistexpand"
8093 .cindex "expansion" "of lists"
8094 Each list is expanded as a single string before it is used.
8095
8096 &'Exception: the router headers_remove option, where list-item
8097 splitting is done before string-expansion.'&
8098
8099 The result of
8100 expansion must be a list, possibly containing empty items, which is split up
8101 into separate items for matching. By default, colon is the separator character,
8102 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8103 &<<SECTempitelis>>& for details of the list syntax; the second of these
8104 discusses the way to specify empty list items.
8105
8106
8107 If the string expansion is forced to fail, Exim behaves as if the item it is
8108 testing (domain, host, address, or local part) is not in the list. Other
8109 expansion failures cause temporary errors.
8110
8111 If an item in a list is a regular expression, backslashes, dollars and possibly
8112 other special characters in the expression must be protected against
8113 misinterpretation by the string expander. The easiest way to do this is to use
8114 the &`\N`& expansion feature to indicate that the contents of the regular
8115 expression should not be expanded. For example, in an ACL you might have:
8116 .code
8117 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8118                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8119 .endd
8120 The first item is a regular expression that is protected from expansion by
8121 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8122 senders based on the receiving domain.
8123
8124
8125
8126
8127 .section "Negated items in lists" "SECID76"
8128 .cindex "list" "negation"
8129 .cindex "negation" "in lists"
8130 Items in a list may be positive or negative. Negative items are indicated by a
8131 leading exclamation mark, which may be followed by optional white space. A list
8132 defines a set of items (domains, etc). When Exim processes one of these lists,
8133 it is trying to find out whether a domain, host, address, or local part
8134 (respectively) is in the set that is defined by the list. It works like this:
8135
8136 The list is scanned from left to right. If a positive item is matched, the
8137 subject that is being checked is in the set; if a negative item is matched, the
8138 subject is not in the set. If the end of the list is reached without the
8139 subject having matched any of the patterns, it is in the set if the last item
8140 was a negative one, but not if it was a positive one. For example, the list in
8141 .code
8142 domainlist relay_to_domains = !a.b.c : *.b.c
8143 .endd
8144 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8145 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8146 list is positive. However, if the setting were
8147 .code
8148 domainlist relay_to_domains = !a.b.c
8149 .endd
8150 then all domains other than &'a.b.c'& would match because the last item in the
8151 list is negative. In other words, a list that ends with a negative item behaves
8152 as if it had an extra item &`:*`& on the end.
8153
8154 Another way of thinking about positive and negative items in lists is to read
8155 the connector as &"or"& after a positive item and as &"and"& after a negative
8156 item.
8157
8158
8159
8160 .section "File names in lists" "SECTfilnamlis"
8161 .cindex "list" "filename in"
8162 If an item in a domain, host, address, or local part list is an absolute
8163 filename (beginning with a slash character), each line of the file is read and
8164 processed as if it were an independent item in the list, except that further
8165 filenames are not allowed,
8166 and no expansion of the data from the file takes place.
8167 Empty lines in the file are ignored, and the file may also contain comment
8168 lines:
8169
8170 .ilist
8171 For domain and host lists, if a # character appears anywhere in a line of the
8172 file, it and all following characters are ignored.
8173 .next
8174 Because local parts may legitimately contain # characters, a comment in an
8175 address list or local part list file is recognized only if # is preceded by
8176 white space or the start of the line. For example:
8177 .code
8178 not#comment@x.y.z   # but this is a comment
8179 .endd
8180 .endlist
8181
8182 Putting a filename in a list has the same effect as inserting each line of the
8183 file as an item in the list (blank lines and comments excepted). However, there
8184 is one important difference: the file is read each time the list is processed,
8185 so if its contents vary over time, Exim's behaviour changes.
8186
8187 If a filename is preceded by an exclamation mark, the sense of any match
8188 within the file is inverted. For example, if
8189 .code
8190 hold_domains = !/etc/nohold-domains
8191 .endd
8192 and the file contains the lines
8193 .code
8194 !a.b.c
8195 *.b.c
8196 .endd
8197 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8198 any domain matching &`*.b.c`& is not.
8199
8200
8201
8202 .section "An lsearch file is not an out-of-line list" "SECID77"
8203 As will be described in the sections that follow, lookups can be used in lists
8204 to provide indexed methods of checking list membership. There has been some
8205 confusion about the way &(lsearch)& lookups work in lists. Because
8206 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8207 sometimes thought that it is allowed to contain wild cards and other kinds of
8208 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8209 always fixed strings, just as for any other single-key lookup type.
8210
8211 If you want to use a file to contain wild-card patterns that form part of a
8212 list, just give the filename on its own, without a search type, as described
8213 in the previous section. You could also use the &(wildlsearch)& or
8214 &(nwildlsearch)&, but there is no advantage in doing this.
8215
8216
8217
8218
8219 .section "Named lists" "SECTnamedlists"
8220 .cindex "named lists"
8221 .cindex "list" "named"
8222 A list of domains, hosts, email addresses, or local parts can be given a name
8223 which is then used to refer to the list elsewhere in the configuration. This is
8224 particularly convenient if the same list is required in several different
8225 places. It also allows lists to be given meaningful names, which can improve
8226 the readability of the configuration. For example, it is conventional to define
8227 a domain list called &'local_domains'& for all the domains that are handled
8228 locally on a host, using a configuration line such as
8229 .code
8230 domainlist local_domains = localhost:my.dom.example
8231 .endd
8232 Named lists are referenced by giving their name preceded by a plus sign, so,
8233 for example, a router that is intended to handle local domains would be
8234 configured with the line
8235 .code
8236 domains = +local_domains
8237 .endd
8238 The first router in a configuration is often one that handles all domains
8239 except the local ones, using a configuration with a negated item like this:
8240 .code
8241 dnslookup:
8242   driver = dnslookup
8243   domains = ! +local_domains
8244   transport = remote_smtp
8245   no_more
8246 .endd
8247 The four kinds of named list are created by configuration lines starting with
8248 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8249 respectively. Then there follows the name that you are defining, followed by an
8250 equals sign and the list itself. For example:
8251 .code
8252 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8253 addresslist bad_senders = cdb;/etc/badsenders
8254 .endd
8255 A named list may refer to other named lists:
8256 .code
8257 domainlist  dom1 = first.example : second.example
8258 domainlist  dom2 = +dom1 : third.example
8259 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8260 .endd
8261 &*Warning*&: If the last item in a referenced list is a negative one, the
8262 effect may not be what you intended, because the negation does not propagate
8263 out to the higher level. For example, consider:
8264 .code
8265 domainlist  dom1 = !a.b
8266 domainlist  dom2 = +dom1 : *.b
8267 .endd
8268 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8269 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8270 means it matches the second list as well. The effect is not the same as
8271 .code
8272 domainlist  dom2 = !a.b : *.b
8273 .endd
8274 where &'x.y'& does not match. It's best to avoid negation altogether in
8275 referenced lists if you can.
8276
8277 Named lists may have a performance advantage. When Exim is routing an
8278 address or checking an incoming message, it caches the result of tests on named
8279 lists. So, if you have a setting such as
8280 .code
8281 domains = +local_domains
8282 .endd
8283 on several of your routers
8284 or in several ACL statements,
8285 the actual test is done only for the first one. However, the caching works only
8286 if there are no expansions within the list itself or any sublists that it
8287 references. In other words, caching happens only for lists that are known to be
8288 the same each time they are referenced.
8289
8290 By default, there may be up to 16 named lists of each type. This limit can be
8291 extended by changing a compile-time variable. The use of domain and host lists
8292 is recommended for concepts such as local domains, relay domains, and relay
8293 hosts. The default configuration is set up like this.
8294
8295
8296
8297 .section "Named lists compared with macros" "SECID78"
8298 .cindex "list" "named compared with macro"
8299 .cindex "macro" "compared with named list"
8300 At first sight, named lists might seem to be no different from macros in the
8301 configuration file. However, macros are just textual substitutions. If you
8302 write
8303 .code
8304 ALIST = host1 : host2
8305 auth_advertise_hosts = !ALIST
8306 .endd
8307 it probably won't do what you want, because that is exactly the same as
8308 .code
8309 auth_advertise_hosts = !host1 : host2
8310 .endd
8311 Notice that the second host name is not negated. However, if you use a host
8312 list, and write
8313 .code
8314 hostlist alist = host1 : host2
8315 auth_advertise_hosts = ! +alist
8316 .endd
8317 the negation applies to the whole list, and so that is equivalent to
8318 .code
8319 auth_advertise_hosts = !host1 : !host2
8320 .endd
8321
8322
8323 .section "Named list caching" "SECID79"
8324 .cindex "list" "caching of named"
8325 .cindex "caching" "named lists"
8326 While processing a message, Exim caches the result of checking a named list if
8327 it is sure that the list is the same each time. In practice, this means that
8328 the cache operates only if the list contains no $ characters, which guarantees
8329 that it will not change when it is expanded. Sometimes, however, you may have
8330 an expanded list that you know will be the same each time within a given
8331 message. For example:
8332 .code
8333 domainlist special_domains = \
8334            ${lookup{$sender_host_address}cdb{/some/file}}
8335 .endd
8336 This provides a list of domains that depends only on the sending host's IP
8337 address. If this domain list is referenced a number of times (for example,
8338 in several ACL lines, or in several routers) the result of the check is not
8339 cached by default, because Exim does not know that it is going to be the
8340 same list each time.
8341
8342 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8343 cache the result anyway. For example:
8344 .code
8345 domainlist_cache special_domains = ${lookup{...
8346 .endd
8347 If you do this, you should be absolutely sure that caching is going to do
8348 the right thing in all cases. When in doubt, leave it out.
8349
8350
8351
8352 .section "Domain lists" "SECTdomainlist"
8353 .cindex "domain list" "patterns for"
8354 .cindex "list" "domain list"
8355 Domain lists contain patterns that are to be matched against a mail domain.
8356 The following types of item may appear in domain lists:
8357
8358 .ilist
8359 .cindex "primary host name"
8360 .cindex "host name" "matched in domain list"
8361 .oindex "&%primary_hostname%&"
8362 .cindex "domain list" "matching primary host name"
8363 .cindex "@ in a domain list"
8364 If a pattern consists of a single @ character, it matches the local host name,
8365 as set by the &%primary_hostname%& option (or defaulted). This makes it
8366 possible to use the same configuration file on several different hosts that
8367 differ only in their names.
8368 .next
8369 .cindex "@[] in a domain list"
8370 .cindex "domain list" "matching local IP interfaces"
8371 .cindex "domain literal"
8372 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8373 in square brackets (as in an email address that contains a domain literal), but
8374 only if that IP address is recognized as local for email routing purposes. The
8375 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8376 control which of a host's several IP addresses are treated as local.
8377 In today's Internet, the use of domain literals is controversial.
8378 .next
8379 .cindex "@mx_any"
8380 .cindex "@mx_primary"
8381 .cindex "@mx_secondary"
8382 .cindex "domain list" "matching MX pointers to local host"
8383 If a pattern consists of the string &`@mx_any`& it matches any domain that
8384 has an MX record pointing to the local host or to any host that is listed in
8385 .oindex "&%hosts_treat_as_local%&"
8386 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8387 are similar, except that the first matches only when a primary MX target is the
8388 local host, and the second only when no primary MX target is the local host,
8389 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8390 preference value &-- there may of course be more than one of them.
8391
8392 The MX lookup that takes place when matching a pattern of this type is
8393 performed with the resolver options for widening names turned off. Thus, for
8394 example, a single-component domain will &'not'& be expanded by adding the
8395 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8396 options of the &(dnslookup)& router for a discussion of domain widening.
8397
8398 Sometimes you may want to ignore certain IP addresses when using one of these
8399 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8400 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8401 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8402 on a router). For example:
8403 .code
8404 domains = @mx_any/ignore=127.0.0.1
8405 .endd
8406 This example matches any domain that has an MX record pointing to one of
8407 the local host's IP addresses other than 127.0.0.1.
8408
8409 The list of IP addresses is in fact processed by the same code that processes
8410 host lists, so it may contain CIDR-coded network specifications and it may also
8411 contain negative items.
8412
8413 Because the list of IP addresses is a sublist within a domain list, you have to
8414 be careful about delimiters if there is more than one address. Like any other
8415 list, the default delimiter can be changed. Thus, you might have:
8416 .code
8417 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8418           an.other.domain : ...
8419 .endd
8420 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8421 involved, it is easiest to change the delimiter for the main list as well:
8422 .code
8423 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8424           an.other.domain ? ...
8425 .endd
8426 .next
8427 .cindex "asterisk" "in domain list"
8428 .cindex "domain list" "asterisk in"
8429 .cindex "domain list" "matching &""ends with""&"
8430 If a pattern starts with an asterisk, the remaining characters of the pattern
8431 are compared with the terminating characters of the domain. The use of &"*"& in
8432 domain lists differs from its use in partial matching lookups. In a domain
8433 list, the character following the asterisk need not be a dot, whereas partial
8434 matching works only in terms of dot-separated components. For example, a domain
8435 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8436 &'cipher.key.ex'&.
8437
8438 .next
8439 .cindex "regular expressions" "in domain list"
8440 .cindex "domain list" "matching regular expression"
8441 If a pattern starts with a circumflex character, it is treated as a regular
8442 expression, and matched against the domain using a regular expression matching
8443 function. The circumflex is treated as part of the regular expression.
8444 Email domains are case-independent, so this regular expression match is by
8445 default case-independent, but you can make it case-dependent by starting it
8446 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8447 are given in chapter &<<CHAPregexp>>&.
8448
8449 &*Warning*&: Because domain lists are expanded before being processed, you
8450 must escape any backslash and dollar characters in the regular expression, or
8451 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8452 it is not to be expanded (unless you really do want to build a regular
8453 expression by expansion, of course).
8454 .next
8455 .cindex "lookup" "in domain list"
8456 .cindex "domain list" "matching by lookup"
8457 If a pattern starts with the name of a single-key lookup type followed by a
8458 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8459 must be a filename in a suitable format for the lookup type. For example, for
8460 &"cdb;"& it must be an absolute path:
8461 .code
8462 domains = cdb;/etc/mail/local_domains.cdb
8463 .endd
8464 The appropriate type of lookup is done on the file using the domain name as the
8465 key. In most cases, the data that is looked up is not used; Exim is interested
8466 only in whether or not the key is present in the file. However, when a lookup
8467 is used for the &%domains%& option on a router
8468 or a &%domains%& condition in an ACL statement, the data is preserved in the
8469 &$domain_data$& variable and can be referred to in other router options or
8470 other statements in the same ACL.
8471
8472 .next
8473 Any of the single-key lookup type names may be preceded by
8474 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8475 .code
8476 domains = partial-dbm;/partial/domains
8477 .endd
8478 This causes partial matching logic to be invoked; a description of how this
8479 works is given in section &<<SECTpartiallookup>>&.
8480
8481 .next
8482 .cindex "asterisk" "in lookup type"
8483 Any of the single-key lookup types may be followed by an asterisk. This causes
8484 a default lookup for a key consisting of a single asterisk to be done if the
8485 original lookup fails. This is not a useful feature when using a domain list to
8486 select particular domains (because any domain would match), but it might have
8487 value if the result of the lookup is being used via the &$domain_data$&
8488 expansion variable.
8489 .next
8490 If the pattern starts with the name of a query-style lookup type followed by a
8491 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8492 pattern must be an appropriate query for the lookup type, as described in
8493 chapter &<<CHAPfdlookup>>&. For example:
8494 .code
8495 hold_domains = mysql;select domain from holdlist \
8496   where domain = '${quote_mysql:$domain}';
8497 .endd
8498 In most cases, the data that is looked up is not used (so for an SQL query, for
8499 example, it doesn't matter what field you select). Exim is interested only in
8500 whether or not the query succeeds. However, when a lookup is used for the
8501 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8502 variable and can be referred to in other options.
8503 .next
8504 .cindex "domain list" "matching literal domain name"
8505 If none of the above cases apply, a caseless textual comparison is made
8506 between the pattern and the domain.
8507 .endlist
8508
8509 Here is an example that uses several different kinds of pattern:
8510 .code
8511 domainlist funny_domains = \
8512   @ : \
8513   lib.unseen.edu : \
8514   *.foundation.fict.example : \
8515   \N^[1-2]\d{3}\.fict\.example$\N : \
8516   partial-dbm;/opt/data/penguin/book : \
8517   nis;domains.byname : \
8518   nisplus;[name=$domain,status=local],domains.org_dir
8519 .endd
8520 There are obvious processing trade-offs among the various matching modes. Using
8521 an asterisk is faster than a regular expression, and listing a few names
8522 explicitly probably is too. The use of a file or database lookup is expensive,
8523 but may be the only option if hundreds of names are required. Because the
8524 patterns are tested in order, it makes sense to put the most commonly matched
8525 patterns earlier.
8526
8527
8528
8529 .section "Host lists" "SECThostlist"
8530 .cindex "host list" "patterns in"
8531 .cindex "list" "host list"
8532 Host lists are used to control what remote hosts are allowed to do. For
8533 example, some hosts may be allowed to use the local host as a relay, and some
8534 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8535 two different ways, by name or by IP address. In a host list, some types of
8536 pattern are matched to a host name, and some are matched to an IP address.
8537 You need to be particularly careful with this when single-key lookups are
8538 involved, to ensure that the right value is being used as the key.
8539
8540
8541 .section "Special host list patterns" "SECID80"
8542 .cindex "empty item in hosts list"
8543 .cindex "host list" "empty string in"
8544 If a host list item is the empty string, it matches only when no remote host is
8545 involved. This is the case when a message is being received from a local
8546 process using SMTP on the standard input, that is, when a TCP/IP connection is
8547 not used.
8548
8549 .cindex "asterisk" "in host list"
8550 The special pattern &"*"& in a host list matches any host or no host. Neither
8551 the IP address nor the name is actually inspected.
8552
8553
8554
8555 .section "Host list patterns that match by IP address" "SECThoslispatip"
8556 .cindex "host list" "matching IP addresses"
8557 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8558 the incoming address actually appears in the IPv6 host as
8559 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8560 list, it is converted into a traditional IPv4 address first. (Not all operating
8561 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8562 concerns.)
8563
8564 The following types of pattern in a host list check the remote host by
8565 inspecting its IP address:
8566
8567 .ilist
8568 If the pattern is a plain domain name (not a regular expression, not starting
8569 with *, not a lookup of any kind), Exim calls the operating system function
8570 to find the associated IP address(es). Exim uses the newer
8571 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8572 This typically causes a forward DNS lookup of the name. The result is compared
8573 with the IP address of the subject host.
8574
8575 If there is a temporary problem (such as a DNS timeout) with the host name
8576 lookup, a temporary error occurs. For example, if the list is being used in an
8577 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8578 temporary SMTP error code. If no IP address can be found for the host name,
8579 what happens is described in section &<<SECTbehipnot>>& below.
8580
8581 .next
8582 .cindex "@ in a host list"
8583 If the pattern is &"@"&, the primary host name is substituted and used as a
8584 domain name, as just described.
8585
8586 .next
8587 If the pattern is an IP address, it is matched against the IP address of the
8588 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8589 IPv6 addresses can be given in colon-separated format, but the colons have to
8590 be doubled so as not to be taken as item separators when the default list
8591 separator is used. IPv6 addresses are recognized even when Exim is compiled
8592 without IPv6 support. This means that if they appear in a host list on an
8593 IPv4-only host, Exim will not treat them as host names. They are just addresses
8594 that can never match a client host.
8595
8596 .next
8597 .cindex "@[] in a host list"
8598 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8599 the local host. For example, if the local host is an IPv4 host with one
8600 interface address 10.45.23.56, these two ACL statements have the same effect:
8601 .code
8602 accept hosts = 127.0.0.1 : 10.45.23.56
8603 accept hosts = @[]
8604 .endd
8605 .next
8606 .cindex "CIDR notation"
8607 If the pattern is an IP address followed by a slash and a mask length (for
8608 example 10.11.42.0/24), it is matched against the IP address of the subject
8609 host under the given mask. This allows, an entire network of hosts to be
8610 included (or excluded) by a single item. The mask uses CIDR notation; it
8611 specifies the number of address bits that must match, starting from the most
8612 significant end of the address.
8613
8614 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8615 of a range of addresses. It is the number of bits in the network portion of the
8616 address. The above example specifies a 24-bit netmask, so it matches all 256
8617 addresses in the 10.11.42.0 network. An item such as
8618 .code
8619 192.168.23.236/31
8620 .endd
8621 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8622 32 for an IPv4 address is the same as no mask at all; just a single address
8623 matches.
8624
8625 Here is another example which shows an IPv4 and an IPv6 network:
8626 .code
8627 recipient_unqualified_hosts = 192.168.0.0/16: \
8628                               3ffe::ffff::836f::::/48
8629 .endd
8630 The doubling of list separator characters applies only when these items
8631 appear inline in a host list. It is not required when indirecting via a file.
8632 For example:
8633 .code
8634 recipient_unqualified_hosts = /opt/exim/unqualnets
8635 .endd
8636 could make use of a file containing
8637 .code
8638 172.16.0.0/12
8639 3ffe:ffff:836f::/48
8640 .endd
8641 to have exactly the same effect as the previous example. When listing IPv6
8642 addresses inline, it is usually more convenient to use the facility for
8643 changing separator characters. This list contains the same two networks:
8644 .code
8645 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8646                                  3ffe:ffff:836f::/48
8647 .endd
8648 The separator is changed to semicolon by the leading &"<;"& at the start of the
8649 list.
8650 .endlist
8651
8652
8653
8654 .section "Host list patterns for single-key lookups by host address" &&&
8655          "SECThoslispatsikey"
8656 .cindex "host list" "lookup of IP address"
8657 When a host is to be identified by a single-key lookup of its complete IP
8658 address, the pattern takes this form:
8659 .display
8660 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8661 .endd
8662 For example:
8663 .code
8664 hosts_lookup = net-cdb;/hosts-by-ip.db
8665 .endd
8666 The text form of the IP address of the subject host is used as the lookup key.
8667 IPv6 addresses are converted to an unabbreviated form, using lower case
8668 letters, with dots as separators because colon is the key terminator in
8669 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8670 quoting the keys, but this is a facility that was added later.] The data
8671 returned by the lookup is not used.
8672
8673 .cindex "IP address" "masking"
8674 .cindex "host list" "masked IP address"
8675 Single-key lookups can also be performed using masked IP addresses, using
8676 patterns of this form:
8677 .display
8678 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8679 .endd
8680 For example:
8681 .code
8682 net24-dbm;/networks.db
8683 .endd
8684 The IP address of the subject host is masked using <&'number'&> as the mask
8685 length. A textual string is constructed from the masked value, followed by the
8686 mask, and this is used as the lookup key. For example, if the host's IP address
8687 is 192.168.34.6, the key that is looked up for the above example is
8688 &"192.168.34.0/24"&.
8689
8690 When an IPv6 address is converted to a string, dots are normally used instead
8691 of colons, so that keys in &(lsearch)& files need not contain colons (which
8692 terminate &(lsearch)& keys). This was implemented some time before the ability
8693 to quote keys was made available in &(lsearch)& files. However, the more
8694 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8695 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8696 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8697 converted using colons and not dots.
8698 .new
8699 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8700 addresses are always used.
8701 The latter are converted to IPv4 addresses, in dotted-quad form.
8702 .wen
8703
8704 Ideally, it would be nice to tidy up this anomalous situation by changing to
8705 colons in all cases, given that quoting is now available for &(lsearch)&.
8706 However, this would be an incompatible change that might break some existing
8707 configurations.
8708
8709 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8710 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8711 the former case the key strings include the mask value, whereas in the latter
8712 case the IP address is used on its own.
8713
8714
8715
8716 .section "Host list patterns that match by host name" "SECThoslispatnam"
8717 .cindex "host" "lookup failures"
8718 .cindex "unknown host name"
8719 .cindex "host list" "matching host name"
8720 There are several types of pattern that require Exim to know the name of the
8721 remote host. These are either wildcard patterns or lookups by name. (If a
8722 complete hostname is given without any wildcarding, it is used to find an IP
8723 address to match against, as described in section &<<SECThoslispatip>>&
8724 above.)
8725
8726 If the remote host name is not already known when Exim encounters one of these
8727 patterns, it has to be found from the IP address.
8728 Although many sites on the Internet are conscientious about maintaining reverse
8729 DNS data for their hosts, there are also many that do not do this.
8730 Consequently, a name cannot always be found, and this may lead to unwanted
8731 effects. Take care when configuring host lists with wildcarded name patterns.
8732 Consider what will happen if a name cannot be found.
8733
8734 Because of the problems of determining host names from IP addresses, matching
8735 against host names is not as common as matching against IP addresses.
8736
8737 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8738 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8739 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8740 are done can be changed by setting the &%host_lookup_order%& option. For
8741 security, once Exim has found one or more names, it looks up the IP addresses
8742 for these names and compares them with the IP address that it started with.
8743 Only those names whose IP addresses match are accepted. Any other names are
8744 discarded. If no names are left, Exim behaves as if the host name cannot be
8745 found. In the most common case there is only one name and one IP address.
8746
8747 There are some options that control what happens if a host name cannot be
8748 found. These are described in section &<<SECTbehipnot>>& below.
8749
8750 .cindex "host" "alias for"
8751 .cindex "alias for host"
8752 As a result of aliasing, hosts may have more than one name. When processing any
8753 of the following types of pattern, all the host's names are checked:
8754
8755 .ilist
8756 .cindex "asterisk" "in host list"
8757 If a pattern starts with &"*"& the remainder of the item must match the end of
8758 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8759 &'.b.c'&. This special simple form is provided because this is a very common
8760 requirement. Other kinds of wildcarding require the use of a regular
8761 expression.
8762 .next
8763 .cindex "regular expressions" "in host list"
8764 .cindex "host list" "regular expression in"
8765 If the item starts with &"^"& it is taken to be a regular expression which is
8766 matched against the host name. Host names are case-independent, so this regular
8767 expression match is by default case-independent, but you can make it
8768 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8769 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8770 example,
8771 .code
8772 ^(a|b)\.c\.d$
8773 .endd
8774 is a regular expression that matches either of the two hosts &'a.c.d'& or
8775 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8776 that backslash and dollar characters are not misinterpreted as part of the
8777 string expansion. The simplest way to do this is to use &`\N`& to mark that
8778 part of the string as non-expandable. For example:
8779 .code
8780 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8781 .endd
8782 &*Warning*&: If you want to match a complete host name, you must include the
8783 &`$`& terminating metacharacter in the regular expression, as in the above
8784 example. Without it, a match at the start of the host name is all that is
8785 required.
8786 .endlist
8787
8788
8789
8790
8791 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8792 .cindex "host" "lookup failures, permanent"
8793 While processing a host list, Exim may need to look up an IP address from a
8794 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8795 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8796 behaviour when it fails to find the information it is seeking is the same.
8797
8798 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8799 apply to temporary DNS errors, whose handling is described in the next section.
8800
8801 .cindex "&`+include_unknown`&"
8802 .cindex "&`+ignore_unknown`&"
8803 Exim parses a host list from left to right. If it encounters a permanent
8804 lookup failure in any item in the host list before it has found a match,
8805 Exim treats it as a failure and the default behavior is as if the host
8806 does not match the list. This may not always be what you want to happen.
8807 To change Exim's behaviour, the special items &`+include_unknown`& or
8808 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8809 not recognized in an indirected file).
8810
8811 .ilist
8812 If any item that follows &`+include_unknown`& requires information that
8813 cannot found, Exim behaves as if the host does match the list. For example,
8814 .code
8815 host_reject_connection = +include_unknown:*.enemy.ex
8816 .endd
8817 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8818 any hosts whose name it cannot find.
8819
8820 .next
8821 If any item that follows &`+ignore_unknown`& requires information that cannot
8822 be found, Exim ignores that item and proceeds to the rest of the list. For
8823 example:
8824 .code
8825 accept hosts = +ignore_unknown : friend.example : \
8826                192.168.4.5
8827 .endd
8828 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8829 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8830 name can be found for 192.168.4.5, it is rejected.
8831 .endlist
8832
8833 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8834 list. The effect of each one lasts until the next, or until the end of the
8835 list.
8836
8837 .section "Mixing wildcarded host names and addresses in host lists" &&&
8838          "SECTmixwilhos"
8839 .cindex "host list" "mixing names and addresses in"
8840
8841 This section explains the host/ip processing logic with the same concepts
8842 as the previous section, but specifically addresses what happens when a
8843 wildcarded hostname is one of the items in the hostlist.
8844
8845 .ilist
8846 If you have name lookups or wildcarded host names and
8847 IP addresses in the same host list, you should normally put the IP
8848 addresses first. For example, in an ACL you could have:
8849 .code
8850 accept hosts = 10.9.8.7 : *.friend.example
8851 .endd
8852 The reason you normally would order it this way lies in the
8853 left-to-right way that Exim processes lists.  It can test IP addresses
8854 without doing any DNS lookups, but when it reaches an item that requires
8855 a host name, it fails if it cannot find a host name to compare with the
8856 pattern. If the above list is given in the opposite order, the
8857 &%accept%& statement fails for a host whose name cannot be found, even
8858 if its IP address is 10.9.8.7.
8859
8860 .next
8861 If you really do want to do the name check first, and still recognize the IP
8862 address, you can rewrite the ACL like this:
8863 .code
8864 accept hosts = *.friend.example
8865 accept hosts = 10.9.8.7
8866 .endd
8867 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8868 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8869 &`+ignore_unknown`&, which was discussed in depth in the first example in
8870 this section.
8871 .endlist
8872
8873
8874 .section "Temporary DNS errors when looking up host information" &&&
8875          "SECTtemdnserr"
8876 .cindex "host" "lookup failures, temporary"
8877 .cindex "&`+include_defer`&"
8878 .cindex "&`+ignore_defer`&"
8879 A temporary DNS lookup failure normally causes a defer action (except when
8880 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8881 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8882 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8883 section. These options should be used with care, probably only in non-critical
8884 host lists such as whitelists.
8885
8886
8887
8888 .section "Host list patterns for single-key lookups by host name" &&&
8889          "SECThoslispatnamsk"
8890 .cindex "unknown host name"
8891 .cindex "host list" "matching host name"
8892 If a pattern is of the form
8893 .display
8894 <&'single-key-search-type'&>;<&'search-data'&>
8895 .endd
8896 for example
8897 .code
8898 dbm;/host/accept/list
8899 .endd
8900 a single-key lookup is performed, using the host name as its key. If the
8901 lookup succeeds, the host matches the item. The actual data that is looked up
8902 is not used.
8903
8904 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8905 keys in the file, not IP addresses. If you want to do lookups based on IP
8906 addresses, you must precede the search type with &"net-"& (see section
8907 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8908 two items in the same list, one doing an address lookup and one doing a name
8909 lookup, both using the same file.
8910
8911
8912
8913 .section "Host list patterns for query-style lookups" "SECID81"
8914 If a pattern is of the form
8915 .display
8916 <&'query-style-search-type'&>;<&'query'&>
8917 .endd
8918 the query is obeyed, and if it succeeds, the host matches the item. The actual
8919 data that is looked up is not used. The variables &$sender_host_address$& and
8920 &$sender_host_name$& can be used in the query. For example:
8921 .code
8922 hosts_lookup = pgsql;\
8923   select ip from hostlist where ip='$sender_host_address'
8924 .endd
8925 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8926 can use the &%sg%& expansion item to change this if you need to. If you want to
8927 use masked IP addresses in database queries, you can use the &%mask%& expansion
8928 operator.
8929
8930 If the query contains a reference to &$sender_host_name$&, Exim automatically
8931 looks up the host name if it has not already done so. (See section
8932 &<<SECThoslispatnam>>& for comments on finding host names.)
8933
8934 Historical note: prior to release 4.30, Exim would always attempt to find a
8935 host name before running the query, unless the search type was preceded by
8936 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8937 still recognized for query-style lookups, but its presence or absence has no
8938 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8939 See section &<<SECThoslispatsikey>>&.)
8940
8941
8942
8943
8944
8945 .section "Address lists" "SECTaddresslist"
8946 .cindex "list" "address list"
8947 .cindex "address list" "empty item"
8948 .cindex "address list" "patterns"
8949 Address lists contain patterns that are matched against mail addresses. There
8950 is one special case to be considered: the sender address of a bounce message is
8951 always empty. You can test for this by providing an empty item in an address
8952 list. For example, you can set up a router to process bounce messages by
8953 using this option setting:
8954 .code
8955 senders = :
8956 .endd
8957 The presence of the colon creates an empty item. If you do not provide any
8958 data, the list is empty and matches nothing. The empty sender can also be
8959 detected by a regular expression that matches an empty string,
8960 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8961
8962 Non-empty items in an address list can be straightforward email addresses. For
8963 example:
8964 .code
8965 senders = jbc@askone.example : hs@anacreon.example
8966 .endd
8967 A certain amount of wildcarding is permitted. If a pattern contains an @
8968 character, but is not a regular expression and does not begin with a
8969 semicolon-terminated lookup type (described below), the local part of the
8970 subject address is compared with the local part of the pattern, which may start
8971 with an asterisk. If the local parts match, the domain is checked in exactly
8972 the same way as for a pattern in a domain list. For example, the domain can be
8973 wildcarded, refer to a named list, or be a lookup:
8974 .code
8975 deny senders = *@*.spamming.site:\
8976                *@+hostile_domains:\
8977                bozo@partial-lsearch;/list/of/dodgy/sites:\
8978                *@dbm;/bad/domains.db
8979 .endd
8980 .cindex "local part" "starting with !"
8981 .cindex "address list" "local part starting with !"
8982 If a local part that begins with an exclamation mark is required, it has to be
8983 specified using a regular expression, because otherwise the exclamation mark is
8984 treated as a sign of negation, as is standard in lists.
8985
8986 If a non-empty pattern that is not a regular expression or a lookup does not
8987 contain an @ character, it is matched against the domain part of the subject
8988 address. The only two formats that are recognized this way are a literal
8989 domain, or a domain pattern that starts with *. In both these cases, the effect
8990 is the same as if &`*@`& preceded the pattern. For example:
8991 .code
8992 deny senders = enemy.domain : *.enemy.domain
8993 .endd
8994
8995 The following kinds of more complicated address list pattern can match any
8996 address, including the empty address that is characteristic of bounce message
8997 senders:
8998
8999 .ilist
9000 .cindex "regular expressions" "in address list"
9001 .cindex "address list" "regular expression in"
9002 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9003 done against the complete address, with the pattern as the regular expression.
9004 You must take care that backslash and dollar characters are not misinterpreted
9005 as part of the string expansion. The simplest way to do this is to use &`\N`&
9006 to mark that part of the string as non-expandable. For example:
9007 .code
9008 deny senders = \N^.*this.*@example\.com$\N : \
9009                \N^\d{8}.+@spamhaus.example$\N : ...
9010 .endd
9011 The &`\N`& sequences are removed by the expansion, so these items do indeed
9012 start with &"^"& by the time they are being interpreted as address patterns.
9013
9014 .next
9015 .cindex "address list" "lookup for complete address"
9016 Complete addresses can be looked up by using a pattern that starts with a
9017 lookup type terminated by a semicolon, followed by the data for the lookup. For
9018 example:
9019 .code
9020 deny senders = cdb;/etc/blocked.senders : \
9021   mysql;select address from blocked where \
9022   address='${quote_mysql:$sender_address}'
9023 .endd
9024 Both query-style and single-key lookup types can be used. For a single-key
9025 lookup type, Exim uses the complete address as the key. However, empty keys are
9026 not supported for single-key lookups, so a match against the empty address
9027 always fails. This restriction does not apply to query-style lookups.
9028
9029 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9030 cannot be used, and is ignored if specified, with an entry being written to the
9031 panic log.
9032 .cindex "*@ with single-key lookup"
9033 However, you can configure lookup defaults, as described in section
9034 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9035 default. For example, with this lookup:
9036 .code
9037 accept senders = lsearch*@;/some/file
9038 .endd
9039 the file could contains lines like this:
9040 .code
9041 user1@domain1.example
9042 *@domain2.example
9043 .endd
9044 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9045 that are tried is:
9046 .code
9047 nimrod@jaeger.example
9048 *@jaeger.example
9049 *
9050 .endd
9051 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9052 would mean that every address matches, thus rendering the test useless.
9053
9054 &*Warning 2*&: Do not confuse these two kinds of item:
9055 .code
9056 deny recipients = dbm*@;/some/file
9057 deny recipients = *@dbm;/some/file
9058 .endd
9059 The first does a whole address lookup, with defaulting, as just described,
9060 because it starts with a lookup type. The second matches the local part and
9061 domain independently, as described in a bullet point below.
9062 .endlist
9063
9064
9065 The following kinds of address list pattern can match only non-empty addresses.
9066 If the subject address is empty, a match against any of these pattern types
9067 always fails.
9068
9069
9070 .ilist
9071 .cindex "@@ with single-key lookup"
9072 .cindex "address list" "@@ lookup type"
9073 .cindex "address list" "split local part and domain"
9074 If a pattern starts with &"@@"& followed by a single-key lookup item
9075 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9076 split into a local part and a domain. The domain is looked up in the file. If
9077 it is not found, there is no match. If it is found, the data that is looked up
9078 from the file is treated as a colon-separated list of local part patterns, each
9079 of which is matched against the subject local part in turn.
9080
9081 .cindex "asterisk" "in address list"
9082 The lookup may be a partial one, and/or one involving a search for a default
9083 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9084 patterns that are looked up can be regular expressions or begin with &"*"&, or
9085 even be further lookups. They may also be independently negated. For example,
9086 with
9087 .code
9088 deny senders = @@dbm;/etc/reject-by-domain
9089 .endd
9090 the data from which the DBM file is built could contain lines like
9091 .code
9092 baddomain.com:  !postmaster : *
9093 .endd
9094 to reject all senders except &%postmaster%& from that domain.
9095
9096 .cindex "local part" "starting with !"
9097 If a local part that actually begins with an exclamation mark is required, it
9098 has to be specified using a regular expression. In &(lsearch)& files, an entry
9099 may be split over several lines by indenting the second and subsequent lines,
9100 but the separating colon must still be included at line breaks. White space
9101 surrounding the colons is ignored. For example:
9102 .code
9103 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9104   spammer3 : spammer4
9105 .endd
9106 As in all colon-separated lists in Exim, a colon can be included in an item by
9107 doubling.
9108
9109 If the last item in the list starts with a right angle-bracket, the remainder
9110 of the item is taken as a new key to look up in order to obtain a continuation
9111 list of local parts. The new key can be any sequence of characters. Thus one
9112 might have entries like
9113 .code
9114 aol.com: spammer1 : spammer 2 : >*
9115 xyz.com: spammer3 : >*
9116 *:       ^\d{8}$
9117 .endd
9118 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9119 local parts for all domains, in addition to the specific local parts listed for
9120 each domain. Of course, using this feature costs another lookup each time a
9121 chain is followed, but the effort needed to maintain the data is reduced.
9122
9123 .cindex "loop" "in lookups"
9124 It is possible to construct loops using this facility, and in order to catch
9125 them, the chains may be no more than fifty items long.
9126
9127 .next
9128 The @@<&'lookup'&> style of item can also be used with a query-style
9129 lookup, but in this case, the chaining facility is not available. The lookup
9130 can only return a single list of local parts.
9131 .endlist
9132
9133 &*Warning*&: There is an important difference between the address list items
9134 in these two examples:
9135 .code
9136 senders = +my_list
9137 senders = *@+my_list
9138 .endd
9139 In the first one, &`my_list`& is a named address list, whereas in the second
9140 example it is a named domain list.
9141
9142
9143
9144
9145 .section "Case of letters in address lists" "SECTcasletadd"
9146 .cindex "case of local parts"
9147 .cindex "address list" "case forcing"
9148 .cindex "case forcing in address lists"
9149 Domains in email addresses are always handled caselessly, but for local parts
9150 case may be significant on some systems (see &%caseful_local_part%& for how
9151 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9152 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9153 blocking lists should be done in a case-independent manner. Since most address
9154 lists in Exim are used for this kind of control, Exim attempts to do this by
9155 default.
9156
9157 The domain portion of an address is always lowercased before matching it to an
9158 address list. The local part is lowercased by default, and any string
9159 comparisons that take place are done caselessly. This means that the data in
9160 the address list itself, in files included as plain filenames, and in any file
9161 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9162 keys in files that are looked up by a search type other than &(lsearch)& (which
9163 works caselessly) must be in lower case, because these lookups are not
9164 case-independent.
9165
9166 .cindex "&`+caseful`&"
9167 To allow for the possibility of caseful address list matching, if an item in
9168 an address list is the string &"+caseful"&, the original case of the local
9169 part is restored for any comparisons that follow, and string comparisons are no
9170 longer case-independent. This does not affect the domain, which remains in
9171 lower case. However, although independent matches on the domain alone are still
9172 performed caselessly, regular expressions that match against an entire address
9173 become case-sensitive after &"+caseful"& has been seen.
9174
9175
9176
9177 .section "Local part lists" "SECTlocparlis"
9178 .cindex "list" "local part list"
9179 .cindex "local part" "list"
9180 Case-sensitivity in local part lists is handled in the same way as for address
9181 lists, as just described. The &"+caseful"& item can be used if required. In a
9182 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9183 set false, the subject is lowercased and the matching is initially
9184 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9185 matching in the local part list, but not elsewhere in the router. If
9186 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9187 option is case-sensitive from the start.
9188
9189 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9190 comments are handled in the same way as address lists &-- they are recognized
9191 only if the # is preceded by white space or the start of the line.
9192 Otherwise, local part lists are matched in the same way as domain lists, except
9193 that the special items that refer to the local host (&`@`&, &`@[]`&,
9194 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9195 Refer to section &<<SECTdomainlist>>& for details of the other available item
9196 types.
9197 .ecindex IIDdohoadli
9198
9199
9200
9201
9202 . ////////////////////////////////////////////////////////////////////////////
9203 . ////////////////////////////////////////////////////////////////////////////
9204
9205 .chapter "String expansions" "CHAPexpand"
9206 .scindex IIDstrexp "expansion" "of strings"
9207 Many strings in Exim's runtime configuration are expanded before use. Some of
9208 them are expanded every time they are used; others are expanded only once.
9209
9210 When a string is being expanded it is copied verbatim from left to right except
9211 .cindex expansion "string concatenation"
9212 when a dollar or backslash character is encountered. A dollar specifies the
9213 start of a portion of the string that is interpreted and replaced as described
9214 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9215 escape character, as described in the following section.
9216
9217 Whether a string is expanded depends upon the context.  Usually this is solely
9218 dependent upon the option for which a value is sought; in this documentation,
9219 options for which string expansion is performed are marked with &dagger; after
9220 the data type.  ACL rules always expand strings.  A couple of expansion
9221 conditions do not expand some of the brace-delimited branches, for security
9222 reasons,
9223 .new
9224 .cindex "tainted data" expansion
9225 .cindex expansion "tainted data"
9226 and expansion of data deriving from the sender (&"tainted data"&)
9227 is not permitted.
9228 .wen
9229
9230
9231
9232 .section "Literal text in expanded strings" "SECTlittext"
9233 .cindex "expansion" "including literal text"
9234 An uninterpreted dollar can be included in an expanded string by putting a
9235 backslash in front of it. A backslash can be used to prevent any special
9236 character being treated specially in an expansion, including backslash itself.
9237 If the string appears in quotes in the configuration file, two backslashes are
9238 required because the quotes themselves cause interpretation of backslashes when
9239 the string is read in (see section &<<SECTstrings>>&).
9240
9241 .cindex "expansion" "non-expandable substrings"
9242 A portion of the string can specified as non-expandable by placing it between
9243 two occurrences of &`\N`&. This is particularly useful for protecting regular
9244 expressions, which often contain backslashes and dollar signs. For example:
9245 .code
9246 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9247 .endd
9248 On encountering the first &`\N`&, the expander copies subsequent characters
9249 without interpretation until it reaches the next &`\N`& or the end of the
9250 string.
9251
9252
9253
9254 .section "Character escape sequences in expanded strings" "SECID82"
9255 .cindex "expansion" "escape sequences"
9256 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9257 expanded string is recognized as an escape sequence for the character newline,
9258 carriage return, or tab, respectively. A backslash followed by up to three
9259 octal digits is recognized as an octal encoding for a single character, and a
9260 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9261 encoding.
9262
9263 These escape sequences are also recognized in quoted strings when they are read
9264 in. Their interpretation in expansions as well is useful for unquoted strings,
9265 and for other cases such as looked-up strings that are then expanded.
9266
9267
9268 .section "Testing string expansions" "SECID83"
9269 .cindex "expansion" "testing"
9270 .cindex "testing" "string expansion"
9271 .oindex "&%-be%&"
9272 Many expansions can be tested by calling Exim with the &%-be%& option. This
9273 takes the command arguments, or lines from the standard input if there are no
9274 arguments, runs them through the string expansion code, and writes the results
9275 to the standard output. Variables based on configuration values are set up, but
9276 since no message is being processed, variables such as &$local_part$& have no
9277 value. Nevertheless the &%-be%& option can be useful for checking out file and
9278 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9279 and &%nhash%&.
9280
9281 Exim gives up its root privilege when it is called with the &%-be%& option, and
9282 instead runs under the uid and gid it was called with, to prevent users from
9283 using &%-be%& for reading files to which they do not have access.
9284
9285 .oindex "&%-bem%&"
9286 If you want to test expansions that include variables whose values are taken
9287 from a message, there are two other options that can be used. The &%-bem%&
9288 option is like &%-be%& except that it is followed by a filename. The file is
9289 read as a message before doing the test expansions. For example:
9290 .code
9291 exim -bem /tmp/test.message '$h_subject:'
9292 .endd
9293 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9294 Exim message identifier. For example:
9295 .code
9296 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9297 .endd
9298 This loads the message from Exim's spool before doing the test expansions, and
9299 is therefore restricted to admin users.
9300
9301
9302 .section "Forced expansion failure" "SECTforexpfai"
9303 .cindex "expansion" "forced failure"
9304 A number of expansions that are described in the following section have
9305 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9306 (which are sometimes called &"curly brackets"&). Which of the two strings is
9307 used depends on some condition that is evaluated as part of the expansion. If,
9308 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9309 the entire string expansion fails in a way that can be detected by the code
9310 that requested the expansion. This is called &"forced expansion failure"&, and
9311 its consequences depend on the circumstances. In some cases it is no different
9312 from any other expansion failure, but in others a different action may be
9313 taken. Such variations are mentioned in the documentation of the option that is
9314 being expanded.
9315
9316
9317
9318
9319 .section "Expansion items" "SECTexpansionitems"
9320 The following items are recognized in expanded strings. White space may be used
9321 between sub-items that are keywords or substrings enclosed in braces inside an
9322 outer set of braces, to improve readability. &*Warning*&: Within braces,
9323 white space is significant.
9324
9325 .vlist
9326 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9327 .cindex "expansion" "variables"
9328 Substitute the contents of the named variable, for example:
9329 .code
9330 $local_part
9331 ${domain}
9332 .endd
9333 The second form can be used to separate the name from subsequent alphanumeric
9334 characters. This form (using braces) is available only for variables; it does
9335 &'not'& apply to message headers. The names of the variables are given in
9336 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9337 given, the expansion fails.
9338
9339 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9340 .cindex "expansion" "operators"
9341 The string is first itself expanded, and then the operation specified by
9342 <&'op'&> is applied to it. For example:
9343 .code
9344 ${lc:$local_part}
9345 .endd
9346 The string starts with the first character after the colon, which may be
9347 leading white space. A list of operators is given in section &<<SECTexpop>>&
9348 below. The operator notation is used for simple expansion items that have just
9349 one argument, because it reduces the number of braces and therefore makes the
9350 string easier to understand.
9351
9352 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9353 This item inserts &"basic"& header lines. It is described with the &%header%&
9354 expansion item below.
9355
9356
9357 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9358 .cindex "expansion" "calling an acl"
9359 .cindex "&%acl%&" "call from expansion"
9360 The name and zero to nine argument strings are first expanded separately.  The expanded
9361 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9362 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9363 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9364 and may use the variables; if another acl expansion is used the values
9365 are restored after it returns.  If the ACL sets
9366 a value using a "message =" modifier and returns accept or deny, the value becomes
9367 the result of the expansion.
9368 If no message is set and the ACL returns accept or deny
9369 the expansion result is an empty string.
9370 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9371
9372
9373 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9374 .cindex authentication "results header"
9375 .cindex headers "authentication-results:"
9376 .cindex authentication "expansion item"
9377 This item returns a string suitable for insertion as an
9378 &'Authentication-Results:'&
9379 header line.
9380 The given <&'authserv-id'&> is included in the result; typically this
9381 will be a domain name identifying the system performing the authentications.
9382 Methods that might be present in the result include:
9383 .code
9384 none
9385 iprev
9386 auth
9387 spf
9388 dkim
9389 .endd
9390
9391 Example use (as an ACL modifier):
9392 .code
9393       add_header = :at_start:${authresults {$primary_hostname}}
9394 .endd
9395 This is safe even if no authentication results are available.
9396
9397
9398 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9399        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9400 .cindex "expansion" "extracting certificate fields"
9401 .cindex "&%certextract%&" "certificate fields"
9402 .cindex "certificate" "extracting fields"
9403 The <&'certificate'&> must be a variable of type certificate.
9404 The field name is expanded and used to retrieve the relevant field from
9405 the certificate.  Supported fields are:
9406 .display
9407 &`version        `&
9408 &`serial_number  `&
9409 &`subject        `& RFC4514 DN
9410 &`issuer         `& RFC4514 DN
9411 &`notbefore      `& time
9412 &`notafter       `& time
9413 &`sig_algorithm  `&
9414 &`signature      `&
9415 &`subj_altname   `& tagged list
9416 &`ocsp_uri       `& list
9417 &`crl_uri        `& list
9418 .endd
9419 If the field is found,
9420 <&'string2'&> is expanded, and replaces the whole item;
9421 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9422 variable &$value$& contains the value that has been extracted. Afterwards, it
9423 is restored to any previous value it might have had.
9424
9425 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9426 key is not found. If {<&'string2'&>} is also omitted, the value that was
9427 extracted is used.
9428
9429 Some field names take optional modifiers, appended and separated by commas.
9430
9431 The field selectors marked as "RFC4514" above
9432 output a Distinguished Name string which is
9433 not quite
9434 parseable by Exim as a comma-separated tagged list
9435 (the exceptions being elements containing commas).
9436 RDN elements of a single type may be selected by
9437 a modifier of the type label; if so the expansion
9438 result is a list (newline-separated by default).
9439 The separator may be changed by another modifier of
9440 a right angle-bracket followed immediately by the new separator.
9441 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9442
9443 The field selectors marked as "time" above
9444 take an optional modifier of "int"
9445 for which the result is the number of seconds since epoch.
9446 Otherwise the result is a human-readable string
9447 in the timezone selected by the main "timezone" option.
9448
9449 The field selectors marked as "list" above return a list,
9450 newline-separated by default,
9451 (embedded separator characters in elements are doubled).
9452 The separator may be changed by a modifier of
9453 a right angle-bracket followed immediately by the new separator.
9454
9455 The field selectors marked as "tagged" above
9456 prefix each list element with a type string and an equals sign.
9457 Elements of only one type may be selected by a modifier
9458 which is one of "dns", "uri" or "mail";
9459 if so the element tags are omitted.
9460
9461 If not otherwise noted field values are presented in human-readable form.
9462
9463 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9464        {*&<&'arg'&>&*}...}*&"
9465 .cindex &%dlfunc%&
9466 This expansion dynamically loads and then calls a locally-written C function.
9467 This functionality is available only if Exim is compiled with
9468 .code
9469 EXPAND_DLFUNC=yes
9470 .endd
9471 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9472 object so that it doesn't reload the same object file in the same Exim process
9473 (but of course Exim does start new processes frequently).
9474
9475 There may be from zero to eight arguments to the function. When compiling
9476 a local function that is to be called in this way, &_local_scan.h_& should be
9477 included. The Exim variables and functions that are defined by that API
9478 are also available for dynamically loaded functions. The function itself
9479 must have the following type:
9480 .code
9481 int dlfunction(uschar **yield, int argc, uschar *argv[])
9482 .endd
9483 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9484 function should return one of the following values:
9485
9486 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9487 into the expanded string that is being built.
9488
9489 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9490 from &'yield'&, if it is set.
9491
9492 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9493 taken from &'yield'& if it is set.
9494
9495 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9496
9497 When compiling a function that is to be used in this way with gcc,
9498 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9499 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9500
9501
9502 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9503 .cindex "expansion" "extracting value from environment"
9504 .cindex "environment" "values from"
9505 The key is first expanded separately, and leading and trailing white space
9506 removed.
9507 This is then searched for as a name in the environment.
9508 If a variable is found then its value is placed in &$value$&
9509 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9510
9511 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9512 appear, for example:
9513 .code
9514 ${env{USER}{$value} fail }
9515 .endd
9516 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9517 {<&'string1'&>} must be present for &"fail"& to be recognized.
9518
9519 If {<&'string2'&>} is omitted an empty string is substituted on
9520 search failure.
9521 If {<&'string1'&>} is omitted the search result is substituted on
9522 search success.
9523
9524 The environment is adjusted by the &%keep_environment%& and
9525 &%add_environment%& main section options.
9526
9527
9528 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9529        {*&<&'string3'&>&*}}*&"
9530 .cindex "expansion" "extracting substrings by key"
9531 .cindex "&%extract%&" "substrings by key"
9532 The key and <&'string1'&> are first expanded separately. Leading and trailing
9533 white space is removed from the key (but not from any of the strings). The key
9534 must not be empty and must not consist entirely of digits.
9535 The expanded <&'string1'&> must be of the form:
9536 .display
9537 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9538 .endd
9539 .vindex "&$value$&"
9540 where the equals signs and spaces (but not both) are optional. If any of the
9541 values contain white space, they must be enclosed in double quotes, and any
9542 values that are enclosed in double quotes are subject to escape processing as
9543 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9544 for the value that corresponds to the key. The search is case-insensitive. If
9545 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9546 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9547 variable &$value$& contains the value that has been extracted. Afterwards, it
9548 is restored to any previous value it might have had.
9549
9550 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9551 key is not found. If {<&'string2'&>} is also omitted, the value that was
9552 extracted is used. Thus, for example, these two expansions are identical, and
9553 yield &"2001"&:
9554 .code
9555 ${extract{gid}{uid=1984 gid=2001}}
9556 ${extract{gid}{uid=1984 gid=2001}{$value}}
9557 .endd
9558 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9559 appear, for example:
9560 .code
9561 ${extract{Z}{A=... B=...}{$value} fail }
9562 .endd
9563 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9564 {<&'string2'&>} must be present for &"fail"& to be recognized.
9565
9566 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9567        {*&<&'string3'&>&*}}*&" &&&
9568        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9569        {*&<&'string3'&>&*}}*&"
9570 .cindex "expansion" "extracting from JSON object"
9571 .cindex JSON expansions
9572 The key and <&'string1'&> are first expanded separately. Leading and trailing
9573 white space is removed from the key (but not from any of the strings). The key
9574 must not be empty and must not consist entirely of digits.
9575 The expanded <&'string1'&> must be of the form:
9576 .display
9577 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9578 .endd
9579 .vindex "&$value$&"
9580 The braces, commas and colons, and the quoting of the member name are required;
9581 the spaces are optional.
9582 Matching of the key against the member names is done case-sensitively.
9583 For the &"json"& variant,
9584 if a returned value is a JSON string, it retains its leading and
9585 trailing quotes.
9586 .new
9587 For the &"jsons"& variant, which is intended for use with JSON strings, the
9588 leading and trailing quotes are removed from the returned value.
9589 .wen
9590 . XXX should be a UTF-8 compare
9591
9592 The results of matching are handled as above.
9593
9594
9595 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9596         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9597 .cindex "expansion" "extracting substrings by number"
9598 .cindex "&%extract%&" "substrings by number"
9599 The <&'number'&> argument must consist entirely of decimal digits,
9600 apart from leading and trailing white space, which is ignored.
9601 This is what distinguishes this form of &%extract%& from the previous kind. It
9602 behaves in the same way, except that, instead of extracting a named field, it
9603 extracts from <&'string1'&> the field whose number is given as the first
9604 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9605 <&'string3'&> as before.
9606
9607 The fields in the string are separated by any one of the characters in the
9608 separator string. These may include space or tab characters.
9609 The first field is numbered one. If the number is negative, the fields are
9610 counted from the end of the string, with the rightmost one numbered -1. If the
9611 number given is zero, the entire string is returned. If the modulus of the
9612 number is greater than the number of fields in the string, the result is the
9613 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9614 provided. For example:
9615 .code
9616 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9617 .endd
9618 yields &"42"&, and
9619 .code
9620 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9621 .endd
9622 yields &"99"&. Two successive separators mean that the field between them is
9623 empty (for example, the fifth field above).
9624
9625
9626 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9627         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9628        "&*${extract jsons{*&<&'number'&>&*}}&&&
9629         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9630 .cindex "expansion" "extracting from JSON array"
9631 .cindex JSON expansions
9632 The <&'number'&> argument must consist entirely of decimal digits,
9633 apart from leading and trailing white space, which is ignored.
9634
9635 Field selection and result handling is as above;
9636 there is no choice of field separator.
9637 For the &"json"& variant,
9638 if a returned value is a JSON string, it retains its leading and
9639 trailing quotes.
9640 .new
9641 For the &"jsons"& variant, which is intended for use with JSON strings, the
9642 leading and trailing quotes are removed from the returned value.
9643 .wen
9644
9645
9646 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9647 .cindex "list" "selecting by condition"
9648 .cindex "expansion" "selecting from list by condition"
9649 .vindex "&$item$&"
9650 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9651 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9652 For each item
9653 in this list, its value is place in &$item$&, and then the condition is
9654 evaluated. If the condition is true, &$item$& is added to the output as an
9655 item in a new list; if the condition is false, the item is discarded. The
9656 separator used for the output list is the same as the one used for the
9657 input, but a separator setting is not included in the output. For example:
9658 .code
9659 ${filter{a:b:c}{!eq{$item}{b}}}
9660 .endd
9661 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9662 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9663
9664
9665 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9666 .cindex "hash function" "textual"
9667 .cindex "expansion" "textual hash"
9668 This is a textual hashing function, and was the first to be implemented in
9669 early versions of Exim. In current releases, there are other hashing functions
9670 (numeric, MD5, and SHA-1), which are described below.
9671
9672 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9673 <&'n'&>. If you are using fixed values for these numbers, that is, if
9674 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9675 use the simpler operator notation that avoids some of the braces:
9676 .code
9677 ${hash_<n>_<m>:<string>}
9678 .endd
9679 The second number is optional (in both notations). If <&'n'&> is greater than
9680 or equal to the length of the string, the expansion item returns the string.
9681 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9682 function to the string. The new string consists of characters taken from the
9683 first <&'m'&> characters of the string
9684 .code
9685 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9686 .endd
9687 If <&'m'&> is not present the value 26 is used, so that only lower case
9688 letters appear. For example:
9689 .display
9690 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9691 &`$hash{5}{monty}}           `&   yields  &`monty`&
9692 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9693 .endd
9694
9695 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9696         &*$h_*&<&'header&~name'&>&*:*&" &&&
9697        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9698         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9699        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9700         &*$lh_*&<&'header&~name'&>&*:*&"
9701        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9702         &*$rh_*&<&'header&~name'&>&*:*&"
9703 .cindex "expansion" "header insertion"
9704 .vindex "&$header_$&"
9705 .vindex "&$bheader_$&"
9706 .vindex "&$lheader_$&"
9707 .vindex "&$rheader_$&"
9708 .cindex "header lines" "in expansion strings"
9709 .cindex "header lines" "character sets"
9710 .cindex "header lines" "decoding"
9711 Substitute the contents of the named message header line, for example
9712 .code
9713 $header_reply-to:
9714 .endd
9715 The newline that terminates a header line is not included in the expansion, but
9716 internal newlines (caused by splitting the header line over several physical
9717 lines) may be present.
9718
9719 The difference between the four pairs of expansions is in the way
9720 the data in the header line is interpreted.
9721
9722 .ilist
9723 .cindex "white space" "in header lines"
9724 &%rheader%& gives the original &"raw"& content of the header line, with no
9725 processing at all, and without the removal of leading and trailing white space.
9726
9727 .next
9728 .cindex "list" "of header lines"
9729 &%lheader%& gives a colon-separated list, one element per header when there
9730 are multiple headers with a given name.
9731 Any embedded colon characters within an element are doubled, so normal Exim
9732 list-processing facilities can be used.
9733 The terminating newline of each element is removed; in other respects
9734 the content is &"raw"&.
9735
9736 .next
9737 .cindex "base64 encoding" "in header lines"
9738 &%bheader%& removes leading and trailing white space, and then decodes base64
9739 or quoted-printable MIME &"words"& within the header text, but does no
9740 character set translation. If decoding of what looks superficially like a MIME
9741 &"word"& fails, the raw string is returned. If decoding
9742 .cindex "binary zero" "in header line"
9743 produces a binary zero character, it is replaced by a question mark &-- this is
9744 what Exim does for binary zeros that are actually received in header lines.
9745
9746 .next
9747 &%header%& tries to translate the string as decoded by &%bheader%& to a
9748 standard character set. This is an attempt to produce the same string as would
9749 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9750 returned. Translation is attempted only on operating systems that support the
9751 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9752 a system Makefile or in &_Local/Makefile_&.
9753 .endlist ilist
9754
9755 In a filter file, the target character set for &%header%& can be specified by a
9756 command of the following form:
9757 .code
9758 headers charset "UTF-8"
9759 .endd
9760 This command affects all references to &$h_$& (or &$header_$&) expansions in
9761 subsequently obeyed filter commands. In the absence of this command, the target
9762 character set in a filter is taken from the setting of the &%headers_charset%&
9763 option in the runtime configuration. The value of this option defaults to the
9764 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9765 ISO-8859-1.
9766
9767 Header names follow the syntax of RFC 2822, which states that they may contain
9768 any printing characters except space and colon. Consequently, curly brackets
9769 &'do not'& terminate header names, and should not be used to enclose them as
9770 if they were variables. Attempting to do so causes a syntax error.
9771
9772 Only header lines that are common to all copies of a message are visible to
9773 this mechanism. These are the original header lines that are received with the
9774 message, and any that are added by an ACL statement or by a system
9775 filter. Header lines that are added to a particular copy of a message by a
9776 router or transport are not accessible.
9777
9778 For incoming SMTP messages, no header lines are visible in
9779 ACLs that are obeyed before the data phase completes,
9780 because the header structure is not set up until the message is received.
9781 They are visible in DKIM, PRDR and DATA ACLs.
9782 Header lines that are added in a RCPT ACL (for example)
9783 are saved until the message's incoming header lines are available, at which
9784 point they are added.
9785 When any of the above ACLs ar
9786 running, however, header lines added by earlier ACLs are visible.
9787
9788 Upper case and lower case letters are synonymous in header names. If the
9789 following character is white space, the terminating colon may be omitted, but
9790 this is not recommended, because you may then forget it when it is needed. When
9791 white space terminates the header name, this white space is included in the
9792 expanded string.  If the message does not contain the given header, the
9793 expansion item is replaced by an empty string. (See the &%def%& condition in
9794 section &<<SECTexpcond>>& for a means of testing for the existence of a
9795 header.)
9796
9797 If there is more than one header with the same name, they are all concatenated
9798 to form the substitution string, up to a maximum length of 64K. Unless
9799 &%rheader%& is being used, leading and trailing white space is removed from
9800 each header before concatenation, and a completely empty header is ignored. A
9801 newline character is then inserted between non-empty headers, but there is no
9802 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9803 those headers that contain lists of addresses, a comma is also inserted at the
9804 junctions between headers. This does not happen for the &%rheader%& expansion.
9805
9806
9807 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9808 .cindex "expansion" "hmac hashing"
9809 .cindex &%hmac%&
9810 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9811 shared secret and some text into a message authentication code, as specified in
9812 RFC 2104. This differs from &`${md5:secret_text...}`& or
9813 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9814 cryptographic hash, allowing for authentication that is not possible with MD5
9815 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9816 present. For example:
9817 .code
9818 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9819 .endd
9820 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9821 produces:
9822 .code
9823 dd97e3ba5d1a61b5006108f8c8252953
9824 .endd
9825 As an example of how this might be used, you might put in the main part of
9826 an Exim configuration:
9827 .code
9828 SPAMSCAN_SECRET=cohgheeLei2thahw
9829 .endd
9830 In a router or a transport you could then have:
9831 .code
9832 headers_add = \
9833   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9834   ${hmac{md5}{SPAMSCAN_SECRET}\
9835   {${primary_hostname},${message_exim_id},$h_message-id:}}
9836 .endd
9837 Then given a message, you can check where it was scanned by looking at the
9838 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9839 this header line is authentic by recomputing the authentication code from the
9840 host name, message ID and the &'Message-id:'& header line. This can be done
9841 using Exim's &%-be%& option, or by other means, for example, by using the
9842 &'hmac_md5_hex()'& function in Perl.
9843
9844
9845 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9846 .cindex "expansion" "conditional"
9847 .cindex "&%if%&, expansion item"
9848 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9849 item; otherwise <&'string2'&> is used. The available conditions are described
9850 in section &<<SECTexpcond>>& below. For example:
9851 .code
9852 ${if eq {$local_part}{postmaster} {yes}{no} }
9853 .endd
9854 The second string need not be present; if it is not and the condition is not
9855 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9856 be present instead of the second string (without any curly brackets). In this
9857 case, the expansion is forced to fail if the condition is not true (see section
9858 &<<SECTforexpfai>>&).
9859
9860 If both strings are omitted, the result is the string &`true`& if the condition
9861 is true, and the empty string if the condition is false. This makes it less
9862 cumbersome to write custom ACL and router conditions. For example, instead of
9863 .code
9864 condition = ${if >{$acl_m4}{3}{true}{false}}
9865 .endd
9866 you can use
9867 .code
9868 condition = ${if >{$acl_m4}{3}}
9869 .endd
9870
9871
9872
9873 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9874 .cindex expansion "imap folder"
9875 .cindex "&%imapfolder%& expansion item"
9876 This item converts a (possibly multilevel, or with non-ASCII characters)
9877 folder specification to a Maildir name for filesystem use.
9878 For information on internationalisation support see &<<SECTi18nMDA>>&.
9879
9880
9881
9882 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9883 .cindex "expansion" "string truncation"
9884 .cindex "&%length%& expansion item"
9885 The &%length%& item is used to extract the initial portion of a string. Both
9886 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9887 you are using a fixed value for the number, that is, if <&'string1'&> does not
9888 change when expanded, you can use the simpler operator notation that avoids
9889 some of the braces:
9890 .code
9891 ${length_<n>:<string>}
9892 .endd
9893 The result of this item is either the first <&'n'&> bytes or the whole
9894 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9895 &%strlen%&, which gives the length of a string.
9896 All measurement is done in bytes and is not UTF-8 aware.
9897
9898
9899 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9900         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9901 .cindex "expansion" "extracting list elements by number"
9902 .cindex "&%listextract%&" "extract list elements by number"
9903 .cindex "list" "extracting elements by number"
9904 The <&'number'&> argument must consist entirely of decimal digits,
9905 apart from an optional leading minus,
9906 and leading and trailing white space (which is ignored).
9907
9908 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9909 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9910
9911 The first field of the list is numbered one.
9912 If the number is negative, the fields are
9913 counted from the end of the list, with the rightmost one numbered -1.
9914 The numbered element of the list is extracted and placed in &$value$&,
9915 then <&'string2'&> is expanded as the result.
9916
9917 If the modulus of the
9918 number is zero or greater than the number of fields in the string,
9919 the result is the expansion of <&'string3'&>.
9920
9921 For example:
9922 .code
9923 ${listextract{2}{x:42:99}}
9924 .endd
9925 yields &"42"&, and
9926 .code
9927 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9928 .endd
9929 yields &"result: 42"&.
9930
9931 If {<&'string3'&>} is omitted, an empty string is used for string3.
9932 If {<&'string2'&>} is also omitted, the value that was
9933 extracted is used.
9934 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9935
9936
9937 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9938         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9939 This is the first of one of two different types of lookup item, which are both
9940 described in the next item.
9941
9942 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9943         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9944 .cindex "expansion" "lookup in"
9945 .cindex "file" "lookups"
9946 .cindex "lookup" "in expanded string"
9947 The two forms of lookup item specify data lookups in files and databases, as
9948 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9949 lookups, and the second is used for query-style lookups. The <&'key'&>,
9950 <&'file'&>, and <&'query'&> strings are expanded before use.
9951
9952 If there is any white space in a lookup item which is part of a filter command,
9953 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9954 other place where white space is significant, the lookup item must be enclosed
9955 in double quotes. The use of data lookups in users' filter files may be locked
9956 out by the system administrator.
9957
9958 .vindex "&$value$&"
9959 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9960 During its expansion, the variable &$value$& contains the data returned by the
9961 lookup. Afterwards it reverts to the value it had previously (at the outer
9962 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9963 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9964 string on failure. If <&'string2'&> is provided, it can itself be a nested
9965 lookup, thus providing a mechanism for looking up a default value when the
9966 original lookup fails.
9967
9968 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9969 data for the outer lookup while the parameters of the second lookup are
9970 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9971 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9972 appear, and in this case, if the lookup fails, the entire expansion is forced
9973 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9974 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9975 successful lookup, and nothing in the case of failure.
9976
9977 For single-key lookups, the string &"partial"& is permitted to precede the
9978 search type in order to do partial matching, and * or *@ may follow a search
9979 type to request default lookups if the key does not match (see sections
9980 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9981
9982 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9983 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9984 and non-wild parts of the key during the expansion of the replacement text.
9985 They return to their previous values at the end of the lookup item.
9986
9987 This example looks up the postmaster alias in the conventional alias file:
9988 .code
9989 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9990 .endd
9991 This example uses NIS+ to look up the full name of the user corresponding to
9992 the local part of an address, forcing the expansion to fail if it is not found:
9993 .code
9994 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9995   {$value}fail}
9996 .endd
9997
9998
9999 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10000 .cindex "expansion" "list creation"
10001 .vindex "&$item$&"
10002 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10003 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10004 For each item
10005 in this list, its value is place in &$item$&, and then <&'string2'&> is
10006 expanded and added to the output as an item in a new list. The separator used
10007 for the output list is the same as the one used for the input, but a separator
10008 setting is not included in the output. For example:
10009 .code
10010 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10011 .endd
10012 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10013 value of &$item$& is restored to what it was before. See also the &%filter%&
10014 and &%reduce%& expansion items.
10015
10016 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10017 .cindex "expansion" "numeric hash"
10018 .cindex "hash function" "numeric"
10019 The three strings are expanded; the first two must yield numbers. Call them
10020 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10021 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10022 can use the simpler operator notation that avoids some of the braces:
10023 .code
10024 ${nhash_<n>_<m>:<string>}
10025 .endd
10026 The second number is optional (in both notations). If there is only one number,
10027 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10028 processed by a div/mod hash function that returns two numbers, separated by a
10029 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10030 example,
10031 .code
10032 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10033 .endd
10034 returns the string &"6/33"&.
10035
10036
10037
10038 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10039 .cindex "Perl" "use in expanded string"
10040 .cindex "expansion" "calling Perl from"
10041 This item is available only if Exim has been built to include an embedded Perl
10042 interpreter. The subroutine name and the arguments are first separately
10043 expanded, and then the Perl subroutine is called with those arguments. No
10044 additional arguments need be given; the maximum number permitted, including the
10045 name of the subroutine, is nine.
10046
10047 The return value of the subroutine is inserted into the expanded string, unless
10048 the return value is &%undef%&. In that case, the expansion fails in the same
10049 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10050 Whatever you return is evaluated in a scalar context. For example, if you
10051 return the name of a Perl vector, the return value is the size of the vector,
10052 not its contents.
10053
10054 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10055 with the error message that was passed to &%die%&. More details of the embedded
10056 Perl facility are given in chapter &<<CHAPperl>>&.
10057
10058 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10059 out the use of this expansion item in filter files.
10060
10061
10062 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10063 .cindex "&%prvs%& expansion item"
10064 The first argument is a complete email address and the second is secret
10065 keystring. The third argument, specifying a key number, is optional. If absent,
10066 it defaults to 0. The result of the expansion is a prvs-signed email address,
10067 to be typically used with the &%return_path%& option on an &(smtp)& transport
10068 as part of a bounce address tag validation (BATV) scheme. For more discussion
10069 and an example, see section &<<SECTverifyPRVS>>&.
10070
10071 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10072         {*&<&'string'&>&*}}*&"
10073 .cindex "&%prvscheck%& expansion item"
10074 This expansion item is the complement of the &%prvs%& item. It is used for
10075 checking prvs-signed addresses. If the expansion of the first argument does not
10076 yield a syntactically valid prvs-signed address, the whole item expands to the
10077 empty string. When the first argument does expand to a syntactically valid
10078 prvs-signed address, the second argument is expanded, with the prvs-decoded
10079 version of the address and the key number extracted from the address in the
10080 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10081
10082 These two variables can be used in the expansion of the second argument to
10083 retrieve the secret. The validity of the prvs-signed address is then checked
10084 against the secret. The result is stored in the variable &$prvscheck_result$&,
10085 which is empty for failure or &"1"& for success.
10086
10087 The third argument is optional; if it is missing, it defaults to an empty
10088 string. This argument is now expanded. If the result is an empty string, the
10089 result of the expansion is the decoded version of the address. This is the case
10090 whether or not the signature was valid. Otherwise, the result of the expansion
10091 is the expansion of the third argument.
10092
10093 All three variables can be used in the expansion of the third argument.
10094 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10095 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10096
10097 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10098 .cindex "expansion" "inserting an entire file"
10099 .cindex "file" "inserting into expansion"
10100 .cindex "&%readfile%& expansion item"
10101 The filename and end-of-line string are first expanded separately. The file is
10102 then read, and its contents replace the entire item. All newline characters in
10103 the file are replaced by the end-of-line string if it is present. Otherwise,
10104 newlines are left in the string.
10105 String expansion is not applied to the contents of the file. If you want this,
10106 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10107 the string expansion fails.
10108
10109 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10110 locks out the use of this expansion item in filter files.
10111
10112
10113
10114 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10115         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10116 .cindex "expansion" "inserting from a socket"
10117 .cindex "socket, use of in expansion"
10118 .cindex "&%readsocket%& expansion item"
10119 This item inserts data from a Unix domain or TCP socket into the expanded
10120 string. The minimal way of using it uses just two arguments, as in these
10121 examples:
10122 .code
10123 ${readsocket{/socket/name}{request string}}
10124 ${readsocket{inet:some.host:1234}{request string}}
10125 .endd
10126 For a Unix domain socket, the first substring must be the path to the socket.
10127 For an Internet socket, the first substring must contain &`inet:`& followed by
10128 a host name or IP address, followed by a colon and a port, which can be a
10129 number or the name of a TCP port in &_/etc/services_&. An IP address may
10130 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10131 example:
10132 .code
10133 ${readsocket{inet:[::1]:1234}{request string}}
10134 .endd
10135 Only a single host name may be given, but if looking it up yields more than
10136 one IP address, they are each tried in turn until a connection is made. For
10137 both kinds of socket, Exim makes a connection, writes the request string
10138 unless it is an empty string; and no terminating NUL is ever sent)
10139 and reads from the socket until an end-of-file
10140 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10141 extend what can be done. Firstly, you can vary the timeout. For example:
10142 .code
10143 ${readsocket{/socket/name}{request string}{3s}}
10144 .endd
10145
10146 The third argument is a list of options, of which the first element is the timeout
10147 and must be present if the argument is given.
10148 Further elements are options of form &'name=value'&.
10149 Two option types is currently recognised: shutdown and tls.
10150 The first defines whether (the default)
10151 or not a shutdown is done on the connection after sending the request.
10152 Example, to not do so (preferred, eg. by some webservers):
10153 .code
10154 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10155 .endd
10156 The second, tls, controls the use of TLS on the connection.  Example:
10157 .code
10158 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10159 .endd
10160 The default is to not use TLS.
10161 If it is enabled, a shutdown as descripbed above is never done.
10162
10163 A fourth argument allows you to change any newlines that are in the data
10164 that is read, in the same way as for &%readfile%& (see above). This example
10165 turns them into spaces:
10166 .code
10167 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10168 .endd
10169 As with all expansions, the substrings are expanded before the processing
10170 happens. Errors in these sub-expansions cause the expansion to fail. In
10171 addition, the following errors can occur:
10172
10173 .ilist
10174 Failure to create a socket file descriptor;
10175 .next
10176 Failure to connect the socket;
10177 .next
10178 Failure to write the request string;
10179 .next
10180 Timeout on reading from the socket.
10181 .endlist
10182
10183 By default, any of these errors causes the expansion to fail. However, if
10184 you supply a fifth substring, it is expanded and used when any of the above
10185 errors occurs. For example:
10186 .code
10187 ${readsocket{/socket/name}{request string}{3s}{\n}\
10188   {socket failure}}
10189 .endd
10190 You can test for the existence of a Unix domain socket by wrapping this
10191 expansion in &`${if exists`&, but there is a race condition between that test
10192 and the actual opening of the socket, so it is safer to use the fifth argument
10193 if you want to be absolutely sure of avoiding an expansion error for a
10194 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10195
10196 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10197 locks out the use of this expansion item in filter files.
10198
10199
10200 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10201 .cindex "expansion" "reducing a list to a scalar"
10202 .cindex "list" "reducing to a scalar"
10203 .vindex "&$value$&"
10204 .vindex "&$item$&"
10205 This operation reduces a list to a single, scalar string. After expansion,
10206 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10207 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10208 Then <&'string2'&> is expanded and
10209 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10210 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10211 them. The result of that expansion is assigned to &$value$& before the next
10212 iteration. When the end of the list is reached, the final value of &$value$& is
10213 added to the expansion output. The &%reduce%& expansion item can be used in a
10214 number of ways. For example, to add up a list of numbers:
10215 .code
10216 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10217 .endd
10218 The result of that expansion would be &`6`&. The maximum of a list of numbers
10219 can be found:
10220 .code
10221 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10222 .endd
10223 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10224 restored to what they were before. See also the &%filter%& and &%map%&
10225 expansion items.
10226
10227 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10228 This item inserts &"raw"& header lines. It is described with the &%header%&
10229 expansion item in section &<<SECTexpansionitems>>& above.
10230
10231 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10232         {*&<&'string2'&>&*}}*&"
10233 .cindex "expansion" "running a command"
10234 .cindex "&%run%& expansion item"
10235 The command and its arguments are first expanded as one string. The string is
10236 split apart into individual arguments by spaces, and then the command is run
10237 in a separate process, but under the same uid and gid.  As in other command
10238 executions from Exim, a shell is not used by default. If the command requires
10239 a shell, you must explicitly code it.
10240
10241 Since the arguments are split by spaces, when there is a variable expansion
10242 which has an empty result, it will cause the situation that the argument will
10243 simply be omitted when the program is actually executed by Exim. If the
10244 script/program requires a specific number of arguments and the expanded
10245 variable could possibly result in this empty expansion, the variable must be
10246 quoted. This is more difficult if the expanded variable itself could result
10247 in a string containing quotes, because it would interfere with the quotes
10248 around the command arguments. A possible guard against this is to wrap the
10249 variable in the &%sg%& operator to change any quote marks to some other
10250 character.
10251
10252 The standard input for the command exists, but is empty. The standard output
10253 and standard error are set to the same file descriptor.
10254 .cindex "return code" "from &%run%& expansion"
10255 .vindex "&$value$&"
10256 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10257 and replaces the entire item; during this expansion, the standard output/error
10258 from the command is in the variable &$value$&. If the command fails,
10259 <&'string2'&>, if present, is expanded and used. Once again, during the
10260 expansion, the standard output/error from the command is in the variable
10261 &$value$&.
10262
10263 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10264 can be the word &"fail"& (not in braces) to force expansion failure if the
10265 command does not succeed. If both strings are omitted, the result is contents
10266 of the standard output/error on success, and nothing on failure.
10267
10268 .vindex "&$run_in_acl$&"
10269 The standard output/error of the command is put in the variable &$value$&.
10270 In this ACL example, the output of a command is logged for the admin to
10271 troubleshoot:
10272 .code
10273 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10274       log_message  = Output of id: $value
10275 .endd
10276 If the command requires shell idioms, such as the > redirect operator, the
10277 shell must be invoked directly, such as with:
10278 .code
10279 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10280 .endd
10281
10282 .vindex "&$runrc$&"
10283 The return code from the command is put in the variable &$runrc$&, and this
10284 remains set afterwards, so in a filter file you can do things like this:
10285 .code
10286 if "${run{x y z}{}}$runrc" is 1 then ...
10287   elif $runrc is 2 then ...
10288   ...
10289 endif
10290 .endd
10291 If execution of the command fails (for example, the command does not exist),
10292 the return code is 127 &-- the same code that shells use for non-existent
10293 commands.
10294
10295 &*Warning*&: In a router or transport, you cannot assume the order in which
10296 option values are expanded, except for those preconditions whose order of
10297 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10298 by the expansion of one option, and use it in another.
10299
10300 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10301 out the use of this expansion item in filter files.
10302
10303
10304 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10305 .cindex "expansion" "string substitution"
10306 .cindex "&%sg%& expansion item"
10307 This item works like Perl's substitution operator (s) with the global (/g)
10308 option; hence its name. However, unlike the Perl equivalent, Exim does not
10309 modify the subject string; instead it returns the modified string for insertion
10310 into the overall expansion. The item takes three arguments: the subject string,
10311 a regular expression, and a substitution string. For example:
10312 .code
10313 ${sg{abcdefabcdef}{abc}{xyz}}
10314 .endd
10315 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10316 if any $, } or \ characters are required in the regular expression or in the
10317 substitution string, they have to be escaped. For example:
10318 .code
10319 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10320 .endd
10321 yields &"defabc"&, and
10322 .code
10323 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10324 .endd
10325 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10326 the regular expression from string expansion.
10327
10328 The regular expression is compiled in 8-bit mode, working against bytes
10329 rather than any Unicode-aware character handling.
10330
10331
10332 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10333 .cindex sorting "a list"
10334 .cindex list sorting
10335 .cindex expansion "list sorting"
10336 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10337 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10338 The <&'comparator'&> argument is interpreted as the operator
10339 of a two-argument expansion condition.
10340 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10341 The comparison should return true when applied to two values
10342 if the first value should sort before the second value.
10343 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10344 the element being placed in &$item$&,
10345 to give values for comparison.
10346
10347 The item result is a sorted list,
10348 with the original list separator,
10349 of the list elements (in full) of the original.
10350
10351 Examples:
10352 .code
10353 ${sort{3:2:1:4}{<}{$item}}
10354 .endd
10355 sorts a list of numbers, and
10356 .code
10357 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10358 .endd
10359 will sort an MX lookup into priority order.
10360
10361
10362 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10363 .cindex "&%substr%& expansion item"
10364 .cindex "substring extraction"
10365 .cindex "expansion" "substring extraction"
10366 The three strings are expanded; the first two must yield numbers. Call them
10367 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10368 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10369 can use the simpler operator notation that avoids some of the braces:
10370 .code
10371 ${substr_<n>_<m>:<string>}
10372 .endd
10373 The second number is optional (in both notations).
10374 If it is absent in the simpler format, the preceding underscore must also be
10375 omitted.
10376
10377 The &%substr%& item can be used to extract more general substrings than
10378 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10379 length required. For example
10380 .code
10381 ${substr{3}{2}{$local_part}}
10382 .endd
10383 If the starting offset is greater than the string length the result is the
10384 null string; if the length plus starting offset is greater than the string
10385 length, the result is the right-hand part of the string, starting from the
10386 given offset. The first byte (character) in the string has offset zero.
10387
10388 The &%substr%& expansion item can take negative offset values to count
10389 from the right-hand end of its operand. The last byte (character) is offset -1,
10390 the second-last is offset -2, and so on. Thus, for example,
10391 .code
10392 ${substr{-5}{2}{1234567}}
10393 .endd
10394 yields &"34"&. If the absolute value of a negative offset is greater than the
10395 length of the string, the substring starts at the beginning of the string, and
10396 the length is reduced by the amount of overshoot. Thus, for example,
10397 .code
10398 ${substr{-5}{2}{12}}
10399 .endd
10400 yields an empty string, but
10401 .code
10402 ${substr{-3}{2}{12}}
10403 .endd
10404 yields &"1"&.
10405
10406 When the second number is omitted from &%substr%&, the remainder of the string
10407 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10408 string preceding the offset point are taken. For example, an offset of -1 and
10409 no length, as in these semantically identical examples:
10410 .code
10411 ${substr_-1:abcde}
10412 ${substr{-1}{abcde}}
10413 .endd
10414 yields all but the last character of the string, that is, &"abcd"&.
10415
10416 All measurement is done in bytes and is not UTF-8 aware.
10417
10418
10419
10420 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10421         {*&<&'replacements'&>&*}}*&"
10422 .cindex "expansion" "character translation"
10423 .cindex "&%tr%& expansion item"
10424 This item does single-character (in bytes) translation on its subject string. The second
10425 argument is a list of characters to be translated in the subject string. Each
10426 matching character is replaced by the corresponding character from the
10427 replacement list. For example
10428 .code
10429 ${tr{abcdea}{ac}{13}}
10430 .endd
10431 yields &`1b3de1`&. If there are duplicates in the second character string, the
10432 last occurrence is used. If the third string is shorter than the second, its
10433 last character is replicated. However, if it is empty, no translation takes
10434 place.
10435
10436 All character handling is done in bytes and is not UTF-8 aware.
10437
10438 .endlist
10439
10440
10441
10442 .section "Expansion operators" "SECTexpop"
10443 .cindex "expansion" "operators"
10444 For expansion items that perform transformations on a single argument string,
10445 the &"operator"& notation is used because it is simpler and uses fewer braces.
10446 The substring is first expanded before the operation is applied to it. The
10447 following operations can be performed:
10448
10449 .vlist
10450 .vitem &*${address:*&<&'string'&>&*}*&
10451 .cindex "expansion" "RFC 2822 address handling"
10452 .cindex "&%address%& expansion item"
10453 The string is interpreted as an RFC 2822 address, as it might appear in a
10454 header line, and the effective address is extracted from it. If the string does
10455 not parse successfully, the result is empty.
10456
10457 The parsing correctly handles SMTPUTF8 Unicode in the string.
10458
10459
10460 .vitem &*${addresses:*&<&'string'&>&*}*&
10461 .cindex "expansion" "RFC 2822 address handling"
10462 .cindex "&%addresses%& expansion item"
10463 The string (after expansion) is interpreted as a list of addresses in RFC
10464 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10465 operative address (&'local-part@domain'&) is extracted from each item, and the
10466 result of the expansion is a colon-separated list, with appropriate
10467 doubling of colons should any happen to be present in the email addresses.
10468 Syntactically invalid RFC2822 address items are omitted from the output.
10469
10470 It is possible to specify a character other than colon for the output
10471 separator by starting the string with > followed by the new separator
10472 character. For example:
10473 .code
10474 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10475 .endd
10476 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10477 first, so if the expanded string starts with >, it may change the output
10478 separator unintentionally. This can be avoided by setting the output
10479 separator explicitly:
10480 .code
10481 ${addresses:>:$h_from:}
10482 .endd
10483
10484 Compare the &%address%& (singular)
10485 expansion item, which extracts the working address from a single RFC2822
10486 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10487 processing lists.
10488
10489 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10490 a strict interpretation of header line formatting.  Exim parses the bare,
10491 unquoted portion of an email address and if it finds a comma, treats it as an
10492 email address separator. For the example header line:
10493 .code
10494 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10495 .endd
10496 The first example below demonstrates that Q-encoded email addresses are parsed
10497 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10498 It does not see the comma because it's still encoded as "=2C".  The second
10499 example below is passed the contents of &`$header_from:`&, meaning it gets
10500 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10501 The third example shows that the presence of a comma is skipped when it is
10502 quoted.  The fourth example shows SMTPUTF8 handling.
10503 .code
10504 # exim -be '${addresses:From: \
10505 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10506 user@example.com
10507 # exim -be '${addresses:From: Last, First <user@example.com>}'
10508 Last:user@example.com
10509 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10510 user@example.com
10511 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10512 フィリップ@example.jp
10513 .endd
10514
10515 .vitem &*${base32:*&<&'digits'&>&*}*&
10516 .cindex "&%base32%& expansion item"
10517 .cindex "expansion" "conversion to base 32"
10518 The string must consist entirely of decimal digits. The number is converted to
10519 base 32 and output as a (empty, for zero) string of characters.
10520 Only lowercase letters are used.
10521
10522 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10523 .cindex "&%base32d%& expansion item"
10524 .cindex "expansion" "conversion to base 32"
10525 The string must consist entirely of base-32 digits.
10526 The number is converted to decimal and output as a string.
10527
10528 .vitem &*${base62:*&<&'digits'&>&*}*&
10529 .cindex "&%base62%& expansion item"
10530 .cindex "expansion" "conversion to base 62"
10531 The string must consist entirely of decimal digits. The number is converted to
10532 base 62 and output as a string of six characters, including leading zeros. In
10533 the few operating environments where Exim uses base 36 instead of base 62 for
10534 its message identifiers (because those systems do not have case-sensitive
10535 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10536 to be absolutely clear: this is &'not'& base64 encoding.
10537
10538 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10539 .cindex "&%base62d%& expansion item"
10540 .cindex "expansion" "conversion to base 62"
10541 The string must consist entirely of base-62 digits, or, in operating
10542 environments where Exim uses base 36 instead of base 62 for its message
10543 identifiers, base-36 digits. The number is converted to decimal and output as a
10544 string.
10545
10546 .vitem &*${base64:*&<&'string'&>&*}*&
10547 .cindex "expansion" "base64 encoding"
10548 .cindex "base64 encoding" "in string expansion"
10549 .cindex "&%base64%& expansion item"
10550 .cindex certificate "base64 of DER"
10551 This operator converts a string into one that is base64 encoded.
10552
10553 If the string is a single variable of type certificate,
10554 returns the base64 encoding of the DER form of the certificate.
10555
10556
10557 .vitem &*${base64d:*&<&'string'&>&*}*&
10558 .cindex "expansion" "base64 decoding"
10559 .cindex "base64 decoding" "in string expansion"
10560 .cindex "&%base64d%& expansion item"
10561 This operator converts a base64-encoded string into the un-coded form.
10562
10563
10564 .vitem &*${domain:*&<&'string'&>&*}*&
10565 .cindex "domain" "extraction"
10566 .cindex "expansion" "domain extraction"
10567 The string is interpreted as an RFC 2822 address and the domain is extracted
10568 from it. If the string does not parse successfully, the result is empty.
10569
10570
10571 .vitem &*${escape:*&<&'string'&>&*}*&
10572 .cindex "expansion" "escaping non-printing characters"
10573 .cindex "&%escape%& expansion item"
10574 If the string contains any non-printing characters, they are converted to
10575 escape sequences starting with a backslash. Whether characters with the most
10576 significant bit set (so-called &"8-bit characters"&) count as printing or not
10577 is controlled by the &%print_topbitchars%& option.
10578
10579 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10580 .cindex "expansion" "escaping 8-bit characters"
10581 .cindex "&%escape8bit%& expansion item"
10582 If the string contains and characters with the most significant bit set,
10583 they are converted to escape sequences starting with a backslash.
10584 Backslashes and DEL characters are also converted.
10585
10586
10587 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10588 .cindex "expansion" "expression evaluation"
10589 .cindex "expansion" "arithmetic expression"
10590 .cindex "&%eval%& expansion item"
10591 These items supports simple arithmetic and bitwise logical operations in
10592 expansion strings. The string (after expansion) must be a conventional
10593 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10594 logical operators, and parentheses. All operations are carried out using
10595 integer arithmetic. The operator priorities are as follows (the same as in the
10596 C programming language):
10597 .table2 70pt 300pt
10598 .irow &'highest:'& "not (~), negate (-)"
10599 .irow ""   "multiply (*), divide (/), remainder (%)"
10600 .irow ""   "plus (+), minus (-)"
10601 .irow ""   "shift-left (<<), shift-right (>>)"
10602 .irow ""   "and (&&)"
10603 .irow ""   "xor (^)"
10604 .irow &'lowest:'&  "or (|)"
10605 .endtable
10606 Binary operators with the same priority are evaluated from left to right. White
10607 space is permitted before or after operators.
10608
10609 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10610 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10611 decimal, even if they start with a leading zero; hexadecimal numbers are not
10612 permitted. This can be useful when processing numbers extracted from dates or
10613 times, which often do have leading zeros.
10614
10615 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10616 or 1024*1024*1024,
10617 respectively. Negative numbers are supported. The result of the computation is
10618 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10619
10620 .display
10621 &`${eval:1+1}            `&  yields 2
10622 &`${eval:1+2*3}          `&  yields 7
10623 &`${eval:(1+2)*3}        `&  yields 9
10624 &`${eval:2+42%5}         `&  yields 4
10625 &`${eval:0xc&amp;5}          `&  yields 4
10626 &`${eval:0xc|5}          `&  yields 13
10627 &`${eval:0xc^5}          `&  yields 9
10628 &`${eval:0xc>>1}         `&  yields 6
10629 &`${eval:0xc<<1}         `&  yields 24
10630 &`${eval:~255&amp;0x1234}    `&  yields 4608
10631 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10632 .endd
10633
10634 As a more realistic example, in an ACL you might have
10635 .code
10636 deny   message = Too many bad recipients
10637        condition =                    \
10638          ${if and {                   \
10639            {>{$rcpt_count}{10}}       \
10640            {                          \
10641            <                          \
10642              {$recipients_count}      \
10643              {${eval:$rcpt_count/2}}  \
10644            }                          \
10645          }{yes}{no}}
10646 .endd
10647 The condition is true if there have been more than 10 RCPT commands and
10648 fewer than half of them have resulted in a valid recipient.
10649
10650
10651 .vitem &*${expand:*&<&'string'&>&*}*&
10652 .cindex "expansion" "re-expansion of substring"
10653 The &%expand%& operator causes a string to be expanded for a second time. For
10654 example,
10655 .code
10656 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10657 .endd
10658 first looks up a string in a file while expanding the operand for &%expand%&,
10659 and then re-expands what it has found.
10660
10661
10662 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10663 .cindex "Unicode"
10664 .cindex "UTF-8" "conversion from"
10665 .cindex "expansion" "UTF-8 conversion"
10666 .cindex "&%from_utf8%& expansion item"
10667 The world is slowly moving towards Unicode, although there are no standards for
10668 email yet. However, other applications (including some databases) are starting
10669 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10670 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10671 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10672 the result is an undefined sequence of bytes.
10673
10674 Unicode code points with values less than 256 are compatible with ASCII and
10675 ISO-8859-1 (also known as Latin-1).
10676 For example, character 169 is the copyright symbol in both cases, though the
10677 way it is encoded is different. In UTF-8, more than one byte is needed for
10678 characters with code values greater than 127, whereas ISO-8859-1 is a
10679 single-byte encoding (but thereby limited to 256 characters). This makes
10680 translation from UTF-8 to ISO-8859-1 straightforward.
10681
10682
10683 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10684 .cindex "hash function" "textual"
10685 .cindex "expansion" "textual hash"
10686 The &%hash%& operator is a simpler interface to the hashing function that can
10687 be used when the two parameters are fixed numbers (as opposed to strings that
10688 change when expanded). The effect is the same as
10689 .code
10690 ${hash{<n>}{<m>}{<string>}}
10691 .endd
10692 See the description of the general &%hash%& item above for details. The
10693 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10694
10695
10696
10697 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10698 .cindex "base64 encoding" "conversion from hex"
10699 .cindex "expansion" "hex to base64"
10700 .cindex "&%hex2b64%& expansion item"
10701 This operator converts a hex string into one that is base64 encoded. This can
10702 be useful for processing the output of the various hashing functions.
10703
10704
10705
10706 .vitem &*${hexquote:*&<&'string'&>&*}*&
10707 .cindex "quoting" "hex-encoded unprintable characters"
10708 .cindex "&%hexquote%& expansion item"
10709 This operator converts non-printable characters in a string into a hex
10710 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10711 as is, and other byte values are converted to &`\xNN`&, for example, a
10712 byte value 127 is converted to &`\x7f`&.
10713
10714
10715 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10716 .cindex "&%ipv6denorm%& expansion item"
10717 .cindex "IP address" normalisation
10718 This expands an IPv6 address to a full eight-element colon-separated set
10719 of hex digits including leading zeroes.
10720 A trailing ipv4-style dotted-decimal set is converted to hex.
10721 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10722
10723 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10724 .cindex "&%ipv6norm%& expansion item"
10725 .cindex "IP address" normalisation
10726 .cindex "IP address" "canonical form"
10727 This converts an IPv6 address to canonical form.
10728 Leading zeroes of groups are omitted, and the longest
10729 set of zero-valued groups is replaced with a double colon.
10730 A trailing ipv4-style dotted-decimal set is converted to hex.
10731 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10732
10733
10734 .vitem &*${lc:*&<&'string'&>&*}*&
10735 .cindex "case forcing in strings"
10736 .cindex "string" "case forcing"
10737 .cindex "lower casing"
10738 .cindex "expansion" "case forcing"
10739 .cindex "&%lc%& expansion item"
10740 This forces the letters in the string into lower-case, for example:
10741 .code
10742 ${lc:$local_part}
10743 .endd
10744 Case is defined per the system C locale.
10745
10746 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10747 .cindex "expansion" "string truncation"
10748 .cindex "&%length%& expansion item"
10749 The &%length%& operator is a simpler interface to the &%length%& function that
10750 can be used when the parameter is a fixed number (as opposed to a string that
10751 changes when expanded). The effect is the same as
10752 .code
10753 ${length{<number>}{<string>}}
10754 .endd
10755 See the description of the general &%length%& item above for details. Note that
10756 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10757 when &%length%& is used as an operator.
10758 All measurement is done in bytes and is not UTF-8 aware.
10759
10760
10761 .vitem &*${listcount:*&<&'string'&>&*}*&
10762 .cindex "expansion" "list item count"
10763 .cindex "list" "item count"
10764 .cindex "list" "count of items"
10765 .cindex "&%listcount%& expansion item"
10766 The string is interpreted as a list and the number of items is returned.
10767
10768
10769 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10770 .cindex "expansion" "named list"
10771 .cindex "&%listnamed%& expansion item"
10772 The name is interpreted as a named list and the content of the list is returned,
10773 expanding any referenced lists, re-quoting as needed for colon-separation.
10774 If the optional type is given it must be one of "a", "d", "h" or "l"
10775 and selects address-, domain-, host- or localpart- lists to search among respectively.
10776 Otherwise all types are searched in an undefined order and the first
10777 matching list is returned.
10778
10779
10780 .vitem &*${local_part:*&<&'string'&>&*}*&
10781 .cindex "expansion" "local part extraction"
10782 .cindex "&%local_part%& expansion item"
10783 The string is interpreted as an RFC 2822 address and the local part is
10784 extracted from it. If the string does not parse successfully, the result is
10785 empty.
10786 The parsing correctly handles SMTPUTF8 Unicode in the string.
10787
10788
10789 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10790 .cindex "masked IP address"
10791 .cindex "IP address" "masking"
10792 .cindex "CIDR notation"
10793 .cindex "expansion" "IP address masking"
10794 .cindex "&%mask%& expansion item"
10795 If the form of the string to be operated on is not an IP address followed by a
10796 slash and an integer (that is, a network address in CIDR notation), the
10797 expansion fails. Otherwise, this operator converts the IP address to binary,
10798 masks off the least significant bits according to the bit count, and converts
10799 the result back to text, with mask appended. For example,
10800 .code
10801 ${mask:10.111.131.206/28}
10802 .endd
10803 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10804 be mostly used for looking up masked addresses in files, the result for an IPv6
10805 address uses dots to separate components instead of colons, because colon
10806 terminates a key string in lsearch files. So, for example,
10807 .code
10808 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10809 .endd
10810 returns the string
10811 .code
10812 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10813 .endd
10814 Letters in IPv6 addresses are always output in lower case.
10815
10816
10817 .vitem &*${md5:*&<&'string'&>&*}*&
10818 .cindex "MD5 hash"
10819 .cindex "expansion" "MD5 hash"
10820 .cindex certificate fingerprint
10821 .cindex "&%md5%& expansion item"
10822 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10823 as a 32-digit hexadecimal number, in which any letters are in lower case.
10824
10825 If the string is a single variable of type certificate,
10826 returns the MD5 hash fingerprint of the certificate.
10827
10828
10829 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10830 .cindex "expansion" "numeric hash"
10831 .cindex "hash function" "numeric"
10832 The &%nhash%& operator is a simpler interface to the numeric hashing function
10833 that can be used when the two parameters are fixed numbers (as opposed to
10834 strings that change when expanded). The effect is the same as
10835 .code
10836 ${nhash{<n>}{<m>}{<string>}}
10837 .endd
10838 See the description of the general &%nhash%& item above for details.
10839
10840
10841 .vitem &*${quote:*&<&'string'&>&*}*&
10842 .cindex "quoting" "in string expansions"
10843 .cindex "expansion" "quoting"
10844 .cindex "&%quote%& expansion item"
10845 The &%quote%& operator puts its argument into double quotes if it
10846 is an empty string or
10847 contains anything other than letters, digits, underscores, dots, and hyphens.
10848 Any occurrences of double quotes and backslashes are escaped with a backslash.
10849 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10850 respectively For example,
10851 .code
10852 ${quote:ab"*"cd}
10853 .endd
10854 becomes
10855 .code
10856 "ab\"*\"cd"
10857 .endd
10858 The place where this is useful is when the argument is a substitution from a
10859 variable or a message header.
10860
10861 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10862 .cindex "&%quote_local_part%& expansion item"
10863 This operator is like &%quote%&, except that it quotes the string only if
10864 required to do so by the rules of RFC 2822 for quoting local parts. For
10865 example, a plus sign would not cause quoting (but it would for &%quote%&).
10866 If you are creating a new email address from the contents of &$local_part$&
10867 (or any other unknown data), you should always use this operator.
10868
10869 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10870 will likely use the quoting form.
10871 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10872
10873
10874 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10875 .cindex "quoting" "lookup-specific"
10876 This operator applies lookup-specific quoting rules to the string. Each
10877 query-style lookup type has its own quoting rules which are described with
10878 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10879 .code
10880 ${quote_ldap:two * two}
10881 .endd
10882 returns
10883 .code
10884 two%20%5C2A%20two
10885 .endd
10886 For single-key lookup types, no quoting is ever necessary and this operator
10887 yields an unchanged string.
10888
10889
10890 .vitem &*${randint:*&<&'n'&>&*}*&
10891 .cindex "random number"
10892 This operator returns a somewhat random number which is less than the
10893 supplied number and is at least 0.  The quality of this randomness depends
10894 on how Exim was built; the values are not suitable for keying material.
10895 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10896 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10897 for versions of GnuTLS with that function.
10898 Otherwise, the implementation may be arc4random(), random() seeded by
10899 srandomdev() or srandom(), or a custom implementation even weaker than
10900 random().
10901
10902
10903 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10904 .cindex "expansion" "IP address"
10905 This operator reverses an IP address; for IPv4 addresses, the result is in
10906 dotted-quad decimal form, while for IPv6 addresses the result is in
10907 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10908 for DNS.  For example,
10909 .code
10910 ${reverse_ip:192.0.2.4}
10911 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10912 .endd
10913 returns
10914 .code
10915 4.2.0.192
10916 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
10917 .endd
10918
10919
10920 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10921 .cindex "expansion" "RFC 2047"
10922 .cindex "RFC 2047" "expansion operator"
10923 .cindex "&%rfc2047%& expansion item"
10924 This operator encodes text according to the rules of RFC 2047. This is an
10925 encoding that is used in header lines to encode non-ASCII characters. It is
10926 assumed that the input string is in the encoding specified by the
10927 &%headers_charset%& option, which gets its default at build time. If the string
10928 contains only characters in the range 33&--126, and no instances of the
10929 characters
10930 .code
10931 ? = ( ) < > @ , ; : \ " . [ ] _
10932 .endd
10933 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10934 string, using as many &"encoded words"& as necessary to encode all the
10935 characters.
10936
10937
10938 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10939 .cindex "expansion" "RFC 2047"
10940 .cindex "RFC 2047" "decoding"
10941 .cindex "&%rfc2047d%& expansion item"
10942 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10943 bytes are replaced by question marks. Characters are converted into the
10944 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10945 not recognized unless &%check_rfc2047_length%& is set false.
10946
10947 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10948 access a header line, RFC 2047 decoding is done automatically. You do not need
10949 to use this operator as well.
10950
10951
10952
10953 .vitem &*${rxquote:*&<&'string'&>&*}*&
10954 .cindex "quoting" "in regular expressions"
10955 .cindex "regular expressions" "quoting"
10956 .cindex "&%rxquote%& expansion item"
10957 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10958 characters in its argument. This is useful when substituting the values of
10959 variables or headers inside regular expressions.
10960
10961
10962 .vitem &*${sha1:*&<&'string'&>&*}*&
10963 .cindex "SHA-1 hash"
10964 .cindex "expansion" "SHA-1 hashing"
10965 .cindex certificate fingerprint
10966 .cindex "&%sha1%& expansion item"
10967 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10968 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10969
10970 If the string is a single variable of type certificate,
10971 returns the SHA-1 hash fingerprint of the certificate.
10972
10973
10974 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10975        &*${sha2:*&<&'string'&>&*}*& &&&
10976        &*${sha2_<n>:*&<&'string'&>&*}*&
10977 .cindex "SHA-256 hash"
10978 .cindex "SHA-2 hash"
10979 .cindex certificate fingerprint
10980 .cindex "expansion" "SHA-256 hashing"
10981 .cindex "&%sha256%& expansion item"
10982 .cindex "&%sha2%& expansion item"
10983 The &%sha256%& operator computes the SHA-256 hash value of the string
10984 and returns
10985 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10986
10987 If the string is a single variable of type certificate,
10988 returns the SHA-256 hash fingerprint of the certificate.
10989
10990 .new
10991 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
10992 (except for certificates, which are not supported).
10993 Finally, if an underbar
10994 and a number is appended it specifies the output length, selecting a
10995 member of the SHA-2 family of hash functions.
10996 Values of 256, 384 and 512 are accepted, with 256 being the default.
10997 .wen
10998
10999
11000 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11001        &*${sha3_<n>:*&<&'string'&>&*}*&
11002 .cindex "SHA3 hash"
11003 .cindex "expansion" "SHA3 hashing"
11004 .cindex "&%sha3%& expansion item"
11005 The &%sha3%& operator computes the SHA3-256 hash value of the string
11006 and returns
11007 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11008
11009 If a number is appended, separated by an underbar, it specifies
11010 the output length.  Values of 224, 256, 384 and 512 are accepted;
11011 with 256 being the default.
11012
11013 The &%sha3%& expansion item is only supported if Exim has been
11014 compiled with GnuTLS 3.5.0 or later,
11015 or OpenSSL 1.1.1 or later.
11016 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11017
11018
11019 .vitem &*${stat:*&<&'string'&>&*}*&
11020 .cindex "expansion" "statting a file"
11021 .cindex "file" "extracting characteristics"
11022 .cindex "&%stat%& expansion item"
11023 The string, after expansion, must be a file path. A call to the &[stat()]&
11024 function is made for this path. If &[stat()]& fails, an error occurs and the
11025 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11026 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11027 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11028 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11029 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11030 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11031 can extract individual fields using the &%extract%& expansion item.
11032
11033 The use of the &%stat%& expansion in users' filter files can be locked out by
11034 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11035 systems for files larger than 2GB.
11036
11037 .vitem &*${str2b64:*&<&'string'&>&*}*&
11038 .cindex "&%str2b64%& expansion item"
11039 Now deprecated, a synonym for the &%base64%& expansion operator.
11040
11041
11042
11043 .vitem &*${strlen:*&<&'string'&>&*}*&
11044 .cindex "expansion" "string length"
11045 .cindex "string" "length in expansion"
11046 .cindex "&%strlen%& expansion item"
11047 The item is replace by the length of the expanded string, expressed as a
11048 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11049 All measurement is done in bytes and is not UTF-8 aware.
11050
11051
11052 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11053 .cindex "&%substr%& expansion item"
11054 .cindex "substring extraction"
11055 .cindex "expansion" "substring expansion"
11056 The &%substr%& operator is a simpler interface to the &%substr%& function that
11057 can be used when the two parameters are fixed numbers (as opposed to strings
11058 that change when expanded). The effect is the same as
11059 .code
11060 ${substr{<start>}{<length>}{<string>}}
11061 .endd
11062 See the description of the general &%substr%& item above for details. The
11063 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11064 All measurement is done in bytes and is not UTF-8 aware.
11065
11066 .vitem &*${time_eval:*&<&'string'&>&*}*&
11067 .cindex "&%time_eval%& expansion item"
11068 .cindex "time interval" "decoding"
11069 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11070 seconds.
11071
11072 .vitem &*${time_interval:*&<&'string'&>&*}*&
11073 .cindex "&%time_interval%& expansion item"
11074 .cindex "time interval" "formatting"
11075 The argument (after sub-expansion) must be a sequence of decimal digits that
11076 represents an interval of time as a number of seconds. It is converted into a
11077 number of larger units and output in Exim's normal time format, for example,
11078 &`1w3d4h2m6s`&.
11079
11080 .vitem &*${uc:*&<&'string'&>&*}*&
11081 .cindex "case forcing in strings"
11082 .cindex "string" "case forcing"
11083 .cindex "upper casing"
11084 .cindex "expansion" "case forcing"
11085 .cindex "&%uc%& expansion item"
11086 This forces the letters in the string into upper-case.
11087 Case is defined per the system C locale.
11088
11089 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11090 .cindex "correction of invalid utf-8 sequences in strings"
11091 .cindex "utf-8" "utf-8 sequences"
11092 .cindex "incorrect utf-8"
11093 .cindex "expansion" "utf-8 forcing"
11094 .cindex "&%utf8clean%& expansion item"
11095 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11096 In versions of Exim before 4.92, this did not correctly do so for a truncated
11097 final codepoint's encoding, and the character would be silently dropped.
11098 If you must handle detection of this scenario across both sets of Exim behavior,
11099 the complexity will depend upon the task.
11100 For instance, to detect if the first character is multibyte and a 1-byte
11101 extraction can be successfully used as a path component (as is common for
11102 dividing up delivery folders), you might use:
11103 .code
11104 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11105 .endd
11106 (which will false-positive if the first character of the local part is a
11107 literal question mark).
11108
11109 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11110        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11111        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11112        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11113 .cindex expansion UTF-8
11114 .cindex UTF-8 expansion
11115 .cindex EAI
11116 .cindex internationalisation
11117 .cindex "&%utf8_domain_to_alabel%& expansion item"
11118 .cindex "&%utf8_domain_from_alabel%& expansion item"
11119 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11120 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11121 These convert EAI mail name components between UTF-8 and a-label forms.
11122 For information on internationalisation support see &<<SECTi18nMTA>>&.
11123 .endlist
11124
11125
11126
11127
11128
11129
11130 .section "Expansion conditions" "SECTexpcond"
11131 .scindex IIDexpcond "expansion" "conditions"
11132 The following conditions are available for testing by the &%${if%& construct
11133 while expanding strings:
11134
11135 .vlist
11136 .vitem &*!*&<&'condition'&>
11137 .cindex "expansion" "negating a condition"
11138 .cindex "negation" "in expansion condition"
11139 Preceding any condition with an exclamation mark negates the result of the
11140 condition.
11141
11142 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11143 .cindex "numeric comparison"
11144 .cindex "expansion" "numeric comparison"
11145 There are a number of symbolic operators for doing numeric comparisons. They
11146 are:
11147 .display
11148 &`=   `&   equal
11149 &`==  `&   equal
11150 &`>   `&   greater
11151 &`>=  `&   greater or equal
11152 &`<   `&   less
11153 &`<=  `&   less or equal
11154 .endd
11155 For example:
11156 .code
11157 ${if >{$message_size}{10M} ...
11158 .endd
11159 Note that the general negation operator provides for inequality testing. The
11160 two strings must take the form of optionally signed decimal integers,
11161 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11162 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11163 As a special case, the numerical value of an empty string is taken as
11164 zero.
11165
11166 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11167 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11168 10M, not if 10M is larger than &$message_size$&.
11169
11170
11171 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11172         {*&<&'arg2'&>&*}...}*&
11173 .cindex "expansion" "calling an acl"
11174 .cindex "&%acl%&" "expansion condition"
11175 The name and zero to nine argument strings are first expanded separately.  The expanded
11176 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11177 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11178 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11179 and may use the variables; if another acl expansion is used the values
11180 are restored after it returns.  If the ACL sets
11181 a value using a "message =" modifier the variable $value becomes
11182 the result of the expansion, otherwise it is empty.
11183 If the ACL returns accept the condition is true; if deny, false.
11184 If the ACL returns defer the result is a forced-fail.
11185
11186 .vitem &*bool&~{*&<&'string'&>&*}*&
11187 .cindex "expansion" "boolean parsing"
11188 .cindex "&%bool%& expansion condition"
11189 This condition turns a string holding a true or false representation into
11190 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11191 (case-insensitively); also integer numbers map to true if non-zero,
11192 false if zero.
11193 An empty string is treated as false.
11194 Leading and trailing whitespace is ignored;
11195 thus a string consisting only of whitespace is false.
11196 All other string values will result in expansion failure.
11197
11198 When combined with ACL variables, this expansion condition will let you
11199 make decisions in one place and act on those decisions in another place.
11200 For example:
11201 .code
11202 ${if bool{$acl_m_privileged_sender} ...
11203 .endd
11204
11205
11206 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11207 .cindex "expansion" "boolean parsing"
11208 .cindex "&%bool_lax%& expansion condition"
11209 Like &%bool%&, this condition turns a string into a boolean state.  But
11210 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11211 loose definition that the Router &%condition%& option uses.  The empty string
11212 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11213 true.  Leading and trailing whitespace is ignored.
11214
11215 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11216
11217 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11218 .cindex "expansion" "encrypted comparison"
11219 .cindex "encrypted strings, comparing"
11220 .cindex "&%crypteq%& expansion condition"
11221 This condition is included in the Exim binary if it is built to support any
11222 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11223 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11224 included in the binary.
11225
11226 The &%crypteq%& condition has two arguments. The first is encrypted and
11227 compared against the second, which is already encrypted. The second string may
11228 be in the LDAP form for storing encrypted strings, which starts with the
11229 encryption type in curly brackets, followed by the data. If the second string
11230 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11231 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11232 Typically this will be a field from a password file. An example of an encrypted
11233 string in LDAP form is:
11234 .code
11235 {md5}CY9rzUYh03PK3k6DJie09g==
11236 .endd
11237 If such a string appears directly in an expansion, the curly brackets have to
11238 be quoted, because they are part of the expansion syntax. For example:
11239 .code
11240 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11241 .endd
11242 The following encryption types (whose names are matched case-independently) are
11243 supported:
11244
11245 .ilist
11246 .cindex "MD5 hash"
11247 .cindex "base64 encoding" "in encrypted password"
11248 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11249 printable characters to compare with the remainder of the second string. If the
11250 length of the comparison string is 24, Exim assumes that it is base64 encoded
11251 (as in the above example). If the length is 32, Exim assumes that it is a
11252 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11253 comparison fails.
11254
11255 .next
11256 .cindex "SHA-1 hash"
11257 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11258 printable characters to compare with the remainder of the second string. If the
11259 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11260 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11261 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11262
11263 .next
11264 .cindex "&[crypt()]&"
11265 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11266 only the first eight characters of the password. However, in modern operating
11267 systems this is no longer true, and in many cases the entire password is used,
11268 whatever its length.
11269
11270 .next
11271 .cindex "&[crypt16()]&"
11272 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11273 use up to 16 characters of the password in some operating systems. Again, in
11274 modern operating systems, more characters may be used.
11275 .endlist
11276 Exim has its own version of &[crypt16()]&, which is just a double call to
11277 &[crypt()]&. For operating systems that have their own version, setting
11278 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11279 operating system version instead of its own. This option is set by default in
11280 the OS-dependent &_Makefile_& for those operating systems that are known to
11281 support &[crypt16()]&.
11282
11283 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11284 it was not using the same algorithm as some operating systems' versions. It
11285 turns out that as well as &[crypt16()]& there is a function called
11286 &[bigcrypt()]& in some operating systems. This may or may not use the same
11287 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11288
11289 However, since there is now a move away from the traditional &[crypt()]&
11290 functions towards using SHA1 and other algorithms, tidying up this area of
11291 Exim is seen as very low priority.
11292
11293 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11294 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11295 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11296 default is &`{crypt}`&. Whatever the default, you can always use either
11297 function by specifying it explicitly in curly brackets.
11298
11299 .vitem &*def:*&<&'variable&~name'&>
11300 .cindex "expansion" "checking for empty variable"
11301 .cindex "&%def%& expansion condition"
11302 The &%def%& condition must be followed by the name of one of the expansion
11303 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11304 variable does not contain the empty string. For example:
11305 .code
11306 ${if def:sender_ident {from $sender_ident}}
11307 .endd
11308 Note that the variable name is given without a leading &%$%& character. If the
11309 variable does not exist, the expansion fails.
11310
11311 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11312         &~&*def:h_*&<&'header&~name'&>&*:*&"
11313 .cindex "expansion" "checking header line existence"
11314 This condition is true if a message is being processed and the named header
11315 exists in the message. For example,
11316 .code
11317 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11318 .endd
11319 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11320 the header name must be terminated by a colon if white space does not follow.
11321
11322 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11323        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11324 .cindex "string" "comparison"
11325 .cindex "expansion" "string comparison"
11326 .cindex "&%eq%& expansion condition"
11327 .cindex "&%eqi%& expansion condition"
11328 The two substrings are first expanded. The condition is true if the two
11329 resulting strings are identical. For &%eq%& the comparison includes the case of
11330 letters, whereas for &%eqi%& the comparison is case-independent, where
11331 case is defined per the system C locale.
11332
11333 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11334 .cindex "expansion" "file existence test"
11335 .cindex "file" "existence test"
11336 .cindex "&%exists%&, expansion condition"
11337 The substring is first expanded and then interpreted as an absolute path. The
11338 condition is true if the named file (or directory) exists. The existence test
11339 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11340 users' filter files may be locked out by the system administrator.
11341
11342 .vitem &*first_delivery*&
11343 .cindex "delivery" "first"
11344 .cindex "first delivery"
11345 .cindex "expansion" "first delivery test"
11346 .cindex "&%first_delivery%& expansion condition"
11347 This condition, which has no data, is true during a message's first delivery
11348 attempt. It is false during any subsequent delivery attempts.
11349
11350
11351 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11352        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11353 .cindex "list" "iterative conditions"
11354 .cindex "expansion" "&*forall*& condition"
11355 .cindex "expansion" "&*forany*& condition"
11356 .vindex "&$item$&"
11357 These conditions iterate over a list. The first argument is expanded to form
11358 the list. By default, the list separator is a colon, but it can be changed by
11359 the normal method (&<<SECTlistsepchange>>&).
11360 The second argument is interpreted as a condition that is to
11361 be applied to each item in the list in turn. During the interpretation of the
11362 condition, the current list item is placed in a variable called &$item$&.
11363 .ilist
11364 For &*forany*&, interpretation stops if the condition is true for any item, and
11365 the result of the whole condition is true. If the condition is false for all
11366 items in the list, the overall condition is false.
11367 .next
11368 For &*forall*&, interpretation stops if the condition is false for any item,
11369 and the result of the whole condition is false. If the condition is true for
11370 all items in the list, the overall condition is true.
11371 .endlist
11372 Note that negation of &*forany*& means that the condition must be false for all
11373 items for the overall condition to succeed, and negation of &*forall*& means
11374 that the condition must be false for at least one item. In this example, the
11375 list separator is changed to a comma:
11376 .code
11377 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11378 .endd
11379 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11380 being processed, to enable these expansion items to be nested.
11381
11382 To scan a named list, expand it with the &*listnamed*& operator.
11383
11384 .new
11385 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11386        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11387        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11388        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11389 .cindex JSON "iterative conditions"
11390 .cindex JSON expansions
11391 .cindex expansion "&*forall_json*& condition"
11392 .cindex expansion "&*forany_json*& condition"
11393 .cindex expansion "&*forall_jsons*& condition"
11394 .cindex expansion "&*forany_jsons*& condition"
11395 As for the above, except that the first argument must, after expansion,
11396 be a JSON array.
11397 The array separator is not changeable.
11398 For the &"jsons"& variants the elements are expected to be JSON strings
11399 and have their quotes removed before the evaluation of the condition.
11400 .wen
11401
11402
11403
11404 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11405        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11406 .cindex "string" "comparison"
11407 .cindex "expansion" "string comparison"
11408 .cindex "&%ge%& expansion condition"
11409 .cindex "&%gei%& expansion condition"
11410 The two substrings are first expanded. The condition is true if the first
11411 string is lexically greater than or equal to the second string. For &%ge%& the
11412 comparison includes the case of letters, whereas for &%gei%& the comparison is
11413 case-independent.
11414 Case and collation order are defined per the system C locale.
11415
11416 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11417        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11418 .cindex "string" "comparison"
11419 .cindex "expansion" "string comparison"
11420 .cindex "&%gt%& expansion condition"
11421 .cindex "&%gti%& expansion condition"
11422 The two substrings are first expanded. The condition is true if the first
11423 string is lexically greater than the second string. For &%gt%& the comparison
11424 includes the case of letters, whereas for &%gti%& the comparison is
11425 case-independent.
11426 Case and collation order are defined per the system C locale.
11427
11428 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11429        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11430 .cindex "string" "comparison"
11431 .cindex "list" "iterative conditions"
11432 Both strings are expanded; the second string is treated as a list of simple
11433 strings; if the first string is a member of the second, then the condition
11434 is true.
11435 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11436
11437 These are simpler to use versions of the more powerful &*forany*& condition.
11438 Examples, and the &*forany*& equivalents:
11439 .code
11440 ${if inlist{needle}{foo:needle:bar}}
11441   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11442 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11443   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11444 .endd
11445
11446 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11447        &*isip4&~{*&<&'string'&>&*}*& &&&
11448        &*isip6&~{*&<&'string'&>&*}*&
11449 .cindex "IP address" "testing string format"
11450 .cindex "string" "testing for IP address"
11451 .cindex "&%isip%& expansion condition"
11452 .cindex "&%isip4%& expansion condition"
11453 .cindex "&%isip6%& expansion condition"
11454 The substring is first expanded, and then tested to see if it has the form of
11455 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11456 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11457
11458 For an IPv4 address, the test is for four dot-separated components, each of
11459 which consists of from one to three digits. For an IPv6 address, up to eight
11460 colon-separated components are permitted, each containing from one to four
11461 hexadecimal digits. There may be fewer than eight components if an empty
11462 component (adjacent colons) is present. Only one empty component is permitted.
11463
11464 &*Note*&: The checks used to be just on the form of the address; actual numerical
11465 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11466 check.
11467 This is no longer the case.
11468
11469 The main use of these tests is to distinguish between IP addresses and
11470 host names, or between IPv4 and IPv6 addresses. For example, you could use
11471 .code
11472 ${if isip4{$sender_host_address}...
11473 .endd
11474 to test which IP version an incoming SMTP connection is using.
11475
11476 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11477 .cindex "LDAP" "use for authentication"
11478 .cindex "expansion" "LDAP authentication test"
11479 .cindex "&%ldapauth%& expansion condition"
11480 This condition supports user authentication using LDAP. See section
11481 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11482 queries. For this use, the query must contain a user name and password. The
11483 query itself is not used, and can be empty. The condition is true if the
11484 password is not empty, and the user name and password are accepted by the LDAP
11485 server. An empty password is rejected without calling LDAP because LDAP binds
11486 with an empty password are considered anonymous regardless of the username, and
11487 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11488 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11489 this can be used.
11490
11491
11492 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11493        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11494 .cindex "string" "comparison"
11495 .cindex "expansion" "string comparison"
11496 .cindex "&%le%& expansion condition"
11497 .cindex "&%lei%& expansion condition"
11498 The two substrings are first expanded. The condition is true if the first
11499 string is lexically less than or equal to the second string. For &%le%& the
11500 comparison includes the case of letters, whereas for &%lei%& the comparison is
11501 case-independent.
11502 Case and collation order are defined per the system C locale.
11503
11504 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11505        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11506 .cindex "string" "comparison"
11507 .cindex "expansion" "string comparison"
11508 .cindex "&%lt%& expansion condition"
11509 .cindex "&%lti%& expansion condition"
11510 The two substrings are first expanded. The condition is true if the first
11511 string is lexically less than the second string. For &%lt%& the comparison
11512 includes the case of letters, whereas for &%lti%& the comparison is
11513 case-independent.
11514 Case and collation order are defined per the system C locale.
11515
11516
11517 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11518 .cindex "expansion" "regular expression comparison"
11519 .cindex "regular expressions" "match in expanded string"
11520 .cindex "&%match%& expansion condition"
11521 The two substrings are first expanded. The second is then treated as a regular
11522 expression and applied to the first. Because of the pre-expansion, if the
11523 regular expression contains dollar, or backslash characters, they must be
11524 escaped. Care must also be taken if the regular expression contains braces
11525 (curly brackets). A closing brace must be escaped so that it is not taken as a
11526 premature termination of <&'string2'&>. The easiest approach is to use the
11527 &`\N`& feature to disable expansion of the regular expression.
11528 For example,
11529 .code
11530 ${if match {$local_part}{\N^\d{3}\N} ...
11531 .endd
11532 If the whole expansion string is in double quotes, further escaping of
11533 backslashes is also required.
11534
11535 The condition is true if the regular expression match succeeds.
11536 The regular expression is not required to begin with a circumflex
11537 metacharacter, but if there is no circumflex, the expression is not anchored,
11538 and it may match anywhere in the subject, not just at the start. If you want
11539 the pattern to match at the end of the subject, you must include the &`$`&
11540 metacharacter at an appropriate point.
11541 All character handling is done in bytes and is not UTF-8 aware,
11542 but we might change this in a future Exim release.
11543
11544 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11545 At the start of an &%if%& expansion the values of the numeric variable
11546 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11547 succeeds causes them to be reset to the substrings of that condition and they
11548 will have these values during the expansion of the success string. At the end
11549 of the &%if%& expansion, the previous values are restored. After testing a
11550 combination of conditions using &%or%&, the subsequent values of the numeric
11551 variables are those of the condition that succeeded.
11552
11553 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11554 .cindex "&%match_address%& expansion condition"
11555 See &*match_local_part*&.
11556
11557 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11558 .cindex "&%match_domain%& expansion condition"
11559 See &*match_local_part*&.
11560
11561 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11562 .cindex "&%match_ip%& expansion condition"
11563 This condition matches an IP address to a list of IP address patterns. It must
11564 be followed by two argument strings. The first (after expansion) must be an IP
11565 address or an empty string. The second (not expanded) is a restricted host
11566 list that can match only an IP address, not a host name. For example:
11567 .code
11568 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11569 .endd
11570 The specific types of host list item that are permitted in the list are:
11571
11572 .ilist
11573 An IP address, optionally with a CIDR mask.
11574 .next
11575 A single asterisk, which matches any IP address.
11576 .next
11577 An empty item, which matches only if the IP address is empty. This could be
11578 useful for testing for a locally submitted message or one from specific hosts
11579 in a single test such as
11580 . ==== As this is a nested list, any displays it contains must be indented
11581 . ==== as otherwise they are too far to the left. This comment applies to
11582 . ==== the use of xmlto plus fop. There's no problem when formatting with
11583 . ==== sdop, with or without the extra indent.
11584 .code
11585   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11586 .endd
11587 where the first item in the list is the empty string.
11588 .next
11589 The item @[] matches any of the local host's interface addresses.
11590 .next
11591 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11592 even if &`net-`& is not specified. There is never any attempt to turn the IP
11593 address into a host name. The most common type of linear search for
11594 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11595 masks. For example:
11596 .code
11597   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11598 .endd
11599 It is of course possible to use other kinds of lookup, and in such a case, you
11600 do need to specify the &`net-`& prefix if you want to specify a specific
11601 address mask, for example:
11602 .code
11603   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11604 .endd
11605 However, unless you are combining a &%match_ip%& condition with others, it is
11606 just as easy to use the fact that a lookup is itself a condition, and write:
11607 .code
11608   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11609 .endd
11610 .endlist ilist
11611
11612 Note that <&'string2'&> is not itself subject to string expansion, unless
11613 Exim was built with the EXPAND_LISTMATCH_RHS option.
11614
11615 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11616
11617 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11618 .cindex "domain list" "in expansion condition"
11619 .cindex "address list" "in expansion condition"
11620 .cindex "local part" "list, in expansion condition"
11621 .cindex "&%match_local_part%& expansion condition"
11622 This condition, together with &%match_address%& and &%match_domain%&, make it
11623 possible to test domain, address, and local part lists within expansions. Each
11624 condition requires two arguments: an item and a list to match. A trivial
11625 example is:
11626 .code
11627 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11628 .endd
11629 In each case, the second argument may contain any of the allowable items for a
11630 list of the appropriate type. Also, because the second argument
11631 is a standard form of list, it is possible to refer to a named list.
11632 Thus, you can use conditions like this:
11633 .code
11634 ${if match_domain{$domain}{+local_domains}{...
11635 .endd
11636 .cindex "&`+caseful`&"
11637 For address lists, the matching starts off caselessly, but the &`+caseful`&
11638 item can be used, as in all address lists, to cause subsequent items to
11639 have their local parts matched casefully. Domains are always matched
11640 caselessly.
11641
11642 Note that <&'string2'&> is not itself subject to string expansion, unless
11643 Exim was built with the EXPAND_LISTMATCH_RHS option.
11644
11645 &*Note*&: Host lists are &'not'& supported in this way. This is because
11646 hosts have two identities: a name and an IP address, and it is not clear
11647 how to specify cleanly how such a test would work. However, IP addresses can be
11648 matched using &%match_ip%&.
11649
11650 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11651 .cindex "PAM authentication"
11652 .cindex "AUTH" "with PAM"
11653 .cindex "Solaris" "PAM support"
11654 .cindex "expansion" "PAM authentication test"
11655 .cindex "&%pam%& expansion condition"
11656 &'Pluggable Authentication Modules'&
11657 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11658 available in the latest releases of Solaris and in some GNU/Linux
11659 distributions. The Exim support, which is intended for use in conjunction with
11660 the SMTP AUTH command, is available only if Exim is compiled with
11661 .code
11662 SUPPORT_PAM=yes
11663 .endd
11664 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11665 in some releases of GNU/Linux &%-ldl%& is also needed.
11666
11667 The argument string is first expanded, and the result must be a
11668 colon-separated list of strings. Leading and trailing white space is ignored.
11669 The PAM module is initialized with the service name &"exim"& and the user name
11670 taken from the first item in the colon-separated data string (<&'string1'&>).
11671 The remaining items in the data string are passed over in response to requests
11672 from the authentication function. In the simple case there will only be one
11673 request, for a password, so the data consists of just two strings.
11674
11675 There can be problems if any of the strings are permitted to contain colon
11676 characters. In the usual way, these have to be doubled to avoid being taken as
11677 separators. If the data is being inserted from a variable, the &%sg%& expansion
11678 item can be used to double any existing colons. For example, the configuration
11679 of a LOGIN authenticator might contain this setting:
11680 .code
11681 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11682 .endd
11683 For a PLAIN authenticator you could use:
11684 .code
11685 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11686 .endd
11687 In some operating systems, PAM authentication can be done only from a process
11688 running as root. Since Exim is running as the Exim user when receiving
11689 messages, this means that PAM cannot be used directly in those systems.
11690 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11691
11692
11693 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11694 .cindex "&'pwcheck'& daemon"
11695 .cindex "Cyrus"
11696 .cindex "expansion" "&'pwcheck'& authentication test"
11697 .cindex "&%pwcheck%& expansion condition"
11698 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11699 This is one way of making it possible for passwords to be checked by a process
11700 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11701 deprecated. Its replacement is &'saslauthd'& (see below).
11702
11703 The pwcheck support is not included in Exim by default. You need to specify
11704 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11705 building Exim. For example:
11706 .code
11707 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11708 .endd
11709 You do not need to install the full Cyrus software suite in order to use
11710 the pwcheck daemon. You can compile and install just the daemon alone
11711 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11712 access to the &_/var/pwcheck_& directory.
11713
11714 The &%pwcheck%& condition takes one argument, which must be the user name and
11715 password, separated by a colon. For example, in a LOGIN authenticator
11716 configuration, you might have this:
11717 .code
11718 server_condition = ${if pwcheck{$auth1:$auth2}}
11719 .endd
11720 Again, for a PLAIN authenticator configuration, this would be:
11721 .code
11722 server_condition = ${if pwcheck{$auth2:$auth3}}
11723 .endd
11724 .vitem &*queue_running*&
11725 .cindex "queue runner" "detecting when delivering from"
11726 .cindex "expansion" "queue runner test"
11727 .cindex "&%queue_running%& expansion condition"
11728 This condition, which has no data, is true during delivery attempts that are
11729 initiated by queue runner processes, and false otherwise.
11730
11731
11732 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11733 .cindex "Radius"
11734 .cindex "expansion" "Radius authentication"
11735 .cindex "&%radius%& expansion condition"
11736 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11737 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11738 the Radius client configuration file in order to build Exim with Radius
11739 support.
11740
11741 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11742 library, using the original API. If you are using release 0.4.0 or later of
11743 this library, you need to set
11744 .code
11745 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11746 .endd
11747 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11748 &%libradius%& library that comes with FreeBSD. To do this, set
11749 .code
11750 RADIUS_LIB_TYPE=RADLIB
11751 .endd
11752 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11753 You may also have to supply a suitable setting in EXTRALIBS so that the
11754 Radius library can be found when Exim is linked.
11755
11756 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11757 Radius client library, which calls the Radius server. The condition is true if
11758 the authentication is successful. For example:
11759 .code
11760 server_condition = ${if radius{<arguments>}}
11761 .endd
11762
11763
11764 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11765         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11766 .cindex "&'saslauthd'& daemon"
11767 .cindex "Cyrus"
11768 .cindex "expansion" "&'saslauthd'& authentication test"
11769 .cindex "&%saslauthd%& expansion condition"
11770 This condition supports user authentication using the Cyrus &'saslauthd'&
11771 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11772 Using this daemon is one way of making it possible for passwords to be checked
11773 by a process that is not running as root.
11774
11775 The saslauthd support is not included in Exim by default. You need to specify
11776 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11777 building Exim. For example:
11778 .code
11779 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11780 .endd
11781 You do not need to install the full Cyrus software suite in order to use
11782 the saslauthd daemon. You can compile and install just the daemon alone
11783 from the Cyrus SASL library.
11784
11785 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11786 two are mandatory. For example:
11787 .code
11788 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11789 .endd
11790 The service and the realm are optional (which is why the arguments are enclosed
11791 in their own set of braces). For details of the meaning of the service and
11792 realm, and how to run the daemon, consult the Cyrus documentation.
11793 .endlist vlist
11794
11795
11796
11797 .section "Combining expansion conditions" "SECID84"
11798 .cindex "expansion" "combining conditions"
11799 Several conditions can be tested at once by combining them using the &%and%&
11800 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11801 conditions on their own, and precede their lists of sub-conditions. Each
11802 sub-condition must be enclosed in braces within the overall braces that contain
11803 the list. No repetition of &%if%& is used.
11804
11805
11806 .vlist
11807 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11808 .cindex "&""or""& expansion condition"
11809 .cindex "expansion" "&""or""& of conditions"
11810 The sub-conditions are evaluated from left to right. The condition is true if
11811 any one of the sub-conditions is true.
11812 For example,
11813 .code
11814 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11815 .endd
11816 When a true sub-condition is found, the following ones are parsed but not
11817 evaluated. If there are several &"match"& sub-conditions the values of the
11818 numeric variables afterwards are taken from the first one that succeeds.
11819
11820 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11821 .cindex "&""and""& expansion condition"
11822 .cindex "expansion" "&""and""& of conditions"
11823 The sub-conditions are evaluated from left to right. The condition is true if
11824 all of the sub-conditions are true. If there are several &"match"&
11825 sub-conditions, the values of the numeric variables afterwards are taken from
11826 the last one. When a false sub-condition is found, the following ones are
11827 parsed but not evaluated.
11828 .endlist
11829 .ecindex IIDexpcond
11830
11831
11832
11833
11834 .section "Expansion variables" "SECTexpvar"
11835 .cindex "expansion" "variables, list of"
11836 This section contains an alphabetical list of all the expansion variables. Some
11837 of them are available only when Exim is compiled with specific options such as
11838 support for TLS or the content scanning extension.
11839
11840 .vlist
11841 .vitem "&$0$&, &$1$&, etc"
11842 .cindex "numerical variables (&$1$& &$2$& etc)"
11843 When a &%match%& expansion condition succeeds, these variables contain the
11844 captured substrings identified by the regular expression during subsequent
11845 processing of the success string of the containing &%if%& expansion item.
11846 In the expansion condition case
11847 they do not retain their values afterwards; in fact, their previous
11848 values are restored at the end of processing an &%if%& item. The numerical
11849 variables may also be set externally by some other matching process which
11850 precedes the expansion of the string. For example, the commands available in
11851 Exim filter files include an &%if%& command with its own regular expression
11852 matching condition.
11853
11854 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11855 Within an acl condition, expansion condition or expansion item
11856 any arguments are copied to these variables,
11857 any unused variables being made empty.
11858
11859 .vitem "&$acl_c...$&"
11860 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11861 can be given any name that starts with &$acl_c$& and is at least six characters
11862 long, but the sixth character must be either a digit or an underscore. For
11863 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11864 variables persist throughout the lifetime of an SMTP connection. They can be
11865 used to pass information between ACLs and between different invocations of the
11866 same ACL. When a message is received, the values of these variables are saved
11867 with the message, and can be accessed by filters, routers, and transports
11868 during subsequent delivery.
11869
11870 .vitem "&$acl_m...$&"
11871 These variables are like the &$acl_c...$& variables, except that their values
11872 are reset after a message has been received. Thus, if several messages are
11873 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11874 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11875 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11876 message is received, the values of these variables are saved with the message,
11877 and can be accessed by filters, routers, and transports during subsequent
11878 delivery.
11879
11880 .vitem &$acl_narg$&
11881 Within an acl condition, expansion condition or expansion item
11882 this variable has the number of arguments.
11883
11884 .vitem &$acl_verify_message$&
11885 .vindex "&$acl_verify_message$&"
11886 After an address verification has failed, this variable contains the failure
11887 message. It retains its value for use in subsequent modifiers. The message can
11888 be preserved by coding like this:
11889 .code
11890 warn !verify = sender
11891      set acl_m0 = $acl_verify_message
11892 .endd
11893 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11894 &%log_message%& modifiers, to include information about the verification
11895 failure.
11896
11897 .vitem &$address_data$&
11898 .vindex "&$address_data$&"
11899 This variable is set by means of the &%address_data%& option in routers. The
11900 value then remains with the address while it is processed by subsequent routers
11901 and eventually a transport. If the transport is handling multiple addresses,
11902 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11903 for more details. &*Note*&: The contents of &$address_data$& are visible in
11904 user filter files.
11905
11906 If &$address_data$& is set when the routers are called from an ACL to verify
11907 a recipient address, the final value is still in the variable for subsequent
11908 conditions and modifiers of the ACL statement. If routing the address caused it
11909 to be redirected to just one address, the child address is also routed as part
11910 of the verification, and in this case the final value of &$address_data$& is
11911 from the child's routing.
11912
11913 If &$address_data$& is set when the routers are called from an ACL to verify a
11914 sender address, the final value is also preserved, but this time in
11915 &$sender_address_data$&, to distinguish it from data from a recipient
11916 address.
11917
11918 In both cases (recipient and sender verification), the value does not persist
11919 after the end of the current ACL statement. If you want to preserve
11920 these values for longer, you can save them in ACL variables.
11921
11922 .vitem &$address_file$&
11923 .vindex "&$address_file$&"
11924 When, as a result of aliasing, forwarding, or filtering, a message is directed
11925 to a specific file, this variable holds the name of the file when the transport
11926 is running. At other times, the variable is empty. For example, using the
11927 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11928 .code
11929 /home/r2d2/savemail
11930 .endd
11931 then when the &(address_file)& transport is running, &$address_file$&
11932 contains the text string &`/home/r2d2/savemail`&.
11933 .cindex "Sieve filter" "value of &$address_file$&"
11934 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11935 then up to the transport configuration to generate an appropriate absolute path
11936 to the relevant file.
11937
11938 .vitem &$address_pipe$&
11939 .vindex "&$address_pipe$&"
11940 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11941 this variable holds the pipe command when the transport is running.
11942
11943 .vitem "&$auth1$& &-- &$auth3$&"
11944 .vindex "&$auth1$&, &$auth2$&, etc"
11945 These variables are used in SMTP authenticators (see chapters
11946 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11947
11948 .vitem &$authenticated_id$&
11949 .cindex "authentication" "id"
11950 .vindex "&$authenticated_id$&"
11951 When a server successfully authenticates a client it may be configured to
11952 preserve some of the authentication information in the variable
11953 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11954 user/password authenticator configuration might preserve the user name for use
11955 in the routers. Note that this is not the same information that is saved in
11956 &$sender_host_authenticated$&.
11957
11958 When a message is submitted locally (that is, not over a TCP connection)
11959 the value of &$authenticated_id$& is normally the login name of the calling
11960 process. However, a trusted user can override this by means of the &%-oMai%&
11961 command line option.
11962 This second case also sets up information used by the
11963 &$authresults$& expansion item.
11964
11965 .vitem &$authenticated_fail_id$&
11966 .cindex "authentication" "fail" "id"
11967 .vindex "&$authenticated_fail_id$&"
11968 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11969 will contain the failed authentication id. If more than one authentication
11970 id is attempted, it will contain only the last one. The variable is
11971 available for processing in the ACL's, generally the quit or notquit ACL.
11972 A message to a local recipient could still be accepted without requiring
11973 authentication, which means this variable could also be visible in all of
11974 the ACL's as well.
11975
11976
11977 .vitem &$authenticated_sender$&
11978 .cindex "sender" "authenticated"
11979 .cindex "authentication" "sender"
11980 .cindex "AUTH" "on MAIL command"
11981 .vindex "&$authenticated_sender$&"
11982 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11983 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11984 described in section &<<SECTauthparamail>>&. Unless the data is the string
11985 &"<>"&, it is set as the authenticated sender of the message, and the value is
11986 available during delivery in the &$authenticated_sender$& variable. If the
11987 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11988
11989 .vindex "&$qualify_domain$&"
11990 When a message is submitted locally (that is, not over a TCP connection), the
11991 value of &$authenticated_sender$& is an address constructed from the login
11992 name of the calling process and &$qualify_domain$&, except that a trusted user
11993 can override this by means of the &%-oMas%& command line option.
11994
11995
11996 .vitem &$authentication_failed$&
11997 .cindex "authentication" "failure"
11998 .vindex "&$authentication_failed$&"
11999 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12000 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12001 possible to distinguish between &"did not try to authenticate"&
12002 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12003 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12004 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12005 negative response to an AUTH command, including (for example) an attempt to use
12006 an undefined mechanism.
12007
12008 .vitem &$av_failed$&
12009 .cindex "content scanning" "AV scanner failure"
12010 This variable is available when Exim is compiled with the content-scanning
12011 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12012 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12013 the ACL malware condition.
12014
12015 .vitem &$body_linecount$&
12016 .cindex "message body" "line count"
12017 .cindex "body of message" "line count"
12018 .vindex "&$body_linecount$&"
12019 When a message is being received or delivered, this variable contains the
12020 number of lines in the message's body. See also &$message_linecount$&.
12021
12022 .vitem &$body_zerocount$&
12023 .cindex "message body" "binary zero count"
12024 .cindex "body of message" "binary zero count"
12025 .cindex "binary zero" "in message body"
12026 .vindex "&$body_zerocount$&"
12027 When a message is being received or delivered, this variable contains the
12028 number of binary zero bytes (ASCII NULs) in the message's body.
12029
12030 .vitem &$bounce_recipient$&
12031 .vindex "&$bounce_recipient$&"
12032 This is set to the recipient address of a bounce message while Exim is creating
12033 it. It is useful if a customized bounce message text file is in use (see
12034 chapter &<<CHAPemsgcust>>&).
12035
12036 .vitem &$bounce_return_size_limit$&
12037 .vindex "&$bounce_return_size_limit$&"
12038 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12039 up to a multiple of 1000. It is useful when a customized error message text
12040 file is in use (see chapter &<<CHAPemsgcust>>&).
12041
12042 .vitem &$caller_gid$&
12043 .cindex "gid (group id)" "caller"
12044 .vindex "&$caller_gid$&"
12045 The real group id under which the process that called Exim was running. This is
12046 not the same as the group id of the originator of a message (see
12047 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12048 incarnation normally contains the Exim gid.
12049
12050 .vitem &$caller_uid$&
12051 .cindex "uid (user id)" "caller"
12052 .vindex "&$caller_uid$&"
12053 The real user id under which the process that called Exim was running. This is
12054 not the same as the user id of the originator of a message (see
12055 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12056 incarnation normally contains the Exim uid.
12057
12058 .vitem &$callout_address$&
12059 .vindex "&$callout_address$&"
12060 After a callout for verification, spamd or malware daemon service, the
12061 address that was connected to.
12062
12063 .vitem &$compile_number$&
12064 .vindex "&$compile_number$&"
12065 The building process for Exim keeps a count of the number
12066 of times it has been compiled. This serves to distinguish different
12067 compilations of the same version of Exim.
12068
12069 .vitem &$config_dir$&
12070 .vindex "&$config_dir$&"
12071 The directory name of the main configuration file. That is, the content of
12072 &$config_file$& with the last component stripped. The value does not
12073 contain the trailing slash. If &$config_file$& does not contain a slash,
12074 &$config_dir$& is ".".
12075
12076 .vitem &$config_file$&
12077 .vindex "&$config_file$&"
12078 The name of the main configuration file Exim is using.
12079
12080 .new
12081 .vitem &$dmarc_domain_policy$& &&&
12082        &$dmarc_status$& &&&
12083        &$dmarc_status_text$& &&&
12084        &$dmarc_used_domains$&
12085 Results of DMARC verification.
12086 For details see section &<<SECDMARC>>&.
12087 .wen
12088
12089 .vitem &$dkim_verify_status$&
12090 Results of DKIM verification.
12091 For details see section &<<SECDKIMVFY>>&.
12092
12093 .vitem &$dkim_cur_signer$& &&&
12094        &$dkim_verify_reason$& &&&
12095        &$dkim_domain$& &&&
12096        &$dkim_identity$& &&&
12097        &$dkim_selector$& &&&
12098        &$dkim_algo$& &&&
12099        &$dkim_canon_body$& &&&
12100        &$dkim_canon_headers$& &&&
12101        &$dkim_copiedheaders$& &&&
12102        &$dkim_bodylength$& &&&
12103        &$dkim_created$& &&&
12104        &$dkim_expires$& &&&
12105        &$dkim_headernames$& &&&
12106        &$dkim_key_testing$& &&&
12107        &$dkim_key_nosubdomains$& &&&
12108        &$dkim_key_srvtype$& &&&
12109        &$dkim_key_granularity$& &&&
12110        &$dkim_key_notes$& &&&
12111        &$dkim_key_length$&
12112 These variables are only available within the DKIM ACL.
12113 For details see section &<<SECDKIMVFY>>&.
12114
12115 .vitem &$dkim_signers$&
12116 .vindex &$dkim_signers$&
12117 When a message has been received this variable contains
12118 a colon-separated list of signer domains and identities for the message.
12119 For details see section &<<SECDKIMVFY>>&.
12120
12121 .vitem &$dnslist_domain$& &&&
12122        &$dnslist_matched$& &&&
12123        &$dnslist_text$& &&&
12124        &$dnslist_value$&
12125 .vindex "&$dnslist_domain$&"
12126 .vindex "&$dnslist_matched$&"
12127 .vindex "&$dnslist_text$&"
12128 .vindex "&$dnslist_value$&"
12129 .cindex "black list (DNS)"
12130 When a DNS (black) list lookup succeeds, these variables are set to contain
12131 the following data from the lookup: the list's domain name, the key that was
12132 looked up, the contents of any associated TXT record, and the value from the
12133 main A record. See section &<<SECID204>>& for more details.
12134
12135 .vitem &$domain$&
12136 .vindex "&$domain$&"
12137 When an address is being routed, or delivered on its own, this variable
12138 contains the domain. Uppercase letters in the domain are converted into lower
12139 case for &$domain$&.
12140
12141 Global address rewriting happens when a message is received, so the value of
12142 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12143 is set during user filtering, but not during system filtering, because a
12144 message may have many recipients and the system filter is called just once.
12145
12146 When more than one address is being delivered at once (for example, several
12147 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12148 have the same domain. Transports can be restricted to handling only one domain
12149 at a time if the value of &$domain$& is required at transport time &-- this is
12150 the default for local transports. For further details of the environment in
12151 which local transports are run, see chapter &<<CHAPenvironment>>&.
12152
12153 .oindex "&%delay_warning_condition%&"
12154 At the end of a delivery, if all deferred addresses have the same domain, it is
12155 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12156
12157 The &$domain$& variable is also used in some other circumstances:
12158
12159 .ilist
12160 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12161 the recipient address. The domain of the &'sender'& address is in
12162 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12163 normally set during the running of the MAIL ACL. However, if the sender address
12164 is verified with a callout during the MAIL ACL, the sender domain is placed in
12165 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12166 the &(smtp)& transport.
12167
12168 .next
12169 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12170 &$domain$& contains the domain portion of the address that is being rewritten;
12171 it can be used in the expansion of the replacement address, for example, to
12172 rewrite domains by file lookup.
12173
12174 .next
12175 With one important exception, whenever a domain list is being scanned,
12176 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12177 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12178 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12179 that, in a RCPT ACL, the sender domain list can be dependent on the
12180 recipient domain (which is what is in &$domain$& at this time).
12181
12182 .next
12183 .cindex "ETRN" "value of &$domain$&"
12184 .oindex "&%smtp_etrn_command%&"
12185 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12186 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12187 .endlist
12188
12189
12190 .vitem &$domain_data$&
12191 .vindex "&$domain_data$&"
12192 When the &%domains%& option on a router matches a domain by
12193 means of a lookup, the data read by the lookup is available during the running
12194 of the router as &$domain_data$&. In addition, if the driver routes the
12195 address to a transport, the value is available in that transport. If the
12196 transport is handling multiple addresses, the value from the first address is
12197 used.
12198
12199 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12200 domain by means of a lookup. The data read by the lookup is available during
12201 the rest of the ACL statement. In all other situations, this variable expands
12202 to nothing.
12203
12204 .vitem &$exim_gid$&
12205 .vindex "&$exim_gid$&"
12206 This variable contains the numerical value of the Exim group id.
12207
12208 .vitem &$exim_path$&
12209 .vindex "&$exim_path$&"
12210 This variable contains the path to the Exim binary.
12211
12212 .vitem &$exim_uid$&
12213 .vindex "&$exim_uid$&"
12214 This variable contains the numerical value of the Exim user id.
12215
12216 .vitem &$exim_version$&
12217 .vindex "&$exim_version$&"
12218 This variable contains the version string of the Exim build.
12219 The first character is a major version number, currently 4.
12220 Then after a dot, the next group of digits is a minor version number.
12221 There may be other characters following the minor version.
12222 This value may be overridden by the &%exim_version%& main config option.
12223
12224 .vitem &$header_$&<&'name'&>
12225 This is not strictly an expansion variable. It is expansion syntax for
12226 inserting the message header line with the given name. Note that the name must
12227 be terminated by colon or white space, because it may contain a wide variety of
12228 characters. Note also that braces must &'not'& be used.
12229 See the full description in section &<<SECTexpansionitems>>& above.
12230
12231 .vitem &$headers_added$&
12232 .vindex "&$headers_added$&"
12233 Within an ACL this variable contains the headers added so far by
12234 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12235 The headers are a newline-separated list.
12236
12237 .vitem &$home$&
12238 .vindex "&$home$&"
12239 When the &%check_local_user%& option is set for a router, the user's home
12240 directory is placed in &$home$& when the check succeeds. In particular, this
12241 means it is set during the running of users' filter files. A router may also
12242 explicitly set a home directory for use by a transport; this can be overridden
12243 by a setting on the transport itself.
12244
12245 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12246 of the environment variable HOME, which is subject to the
12247 &%keep_environment%& and &%add_environment%& main config options.
12248
12249 .vitem &$host$&
12250 .vindex "&$host$&"
12251 If a router assigns an address to a transport (any transport), and passes a
12252 list of hosts with the address, the value of &$host$& when the transport starts
12253 to run is the name of the first host on the list. Note that this applies both
12254 to local and remote transports.
12255
12256 .cindex "transport" "filter"
12257 .cindex "filter" "transport filter"
12258 For the &(smtp)& transport, if there is more than one host, the value of
12259 &$host$& changes as the transport works its way through the list. In
12260 particular, when the &(smtp)& transport is expanding its options for encryption
12261 using TLS, or for specifying a transport filter (see chapter
12262 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12263 is connected.
12264
12265 When used in the client part of an authenticator configuration (see chapter
12266 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12267 client is connected.
12268
12269
12270 .vitem &$host_address$&
12271 .vindex "&$host_address$&"
12272 This variable is set to the remote host's IP address whenever &$host$& is set
12273 for a remote connection. It is also set to the IP address that is being checked
12274 when the &%ignore_target_hosts%& option is being processed.
12275
12276 .vitem &$host_data$&
12277 .vindex "&$host_data$&"
12278 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12279 result of the lookup is made available in the &$host_data$& variable. This
12280 allows you, for example, to do things like this:
12281 .code
12282 deny  hosts = net-lsearch;/some/file
12283 message = $host_data
12284 .endd
12285 .vitem &$host_lookup_deferred$&
12286 .cindex "host name" "lookup, failure of"
12287 .vindex "&$host_lookup_deferred$&"
12288 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12289 message comes from a remote host and there is an attempt to look up the host's
12290 name from its IP address, and the attempt is not successful, one of these
12291 variables is set to &"1"&.
12292
12293 .ilist
12294 If the lookup receives a definite negative response (for example, a DNS lookup
12295 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12296
12297 .next
12298 If there is any kind of problem during the lookup, such that Exim cannot
12299 tell whether or not the host name is defined (for example, a timeout for a DNS
12300 lookup), &$host_lookup_deferred$& is set to &"1"&.
12301 .endlist ilist
12302
12303 Looking up a host's name from its IP address consists of more than just a
12304 single reverse lookup. Exim checks that a forward lookup of at least one of the
12305 names it receives from a reverse lookup yields the original IP address. If this
12306 is not the case, Exim does not accept the looked up name(s), and
12307 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12308 IP address (for example, the existence of a PTR record in the DNS) is not
12309 sufficient on its own for the success of a host name lookup. If the reverse
12310 lookup succeeds, but there is a lookup problem such as a timeout when checking
12311 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12312 &"1"&. See also &$sender_host_name$&.
12313
12314 .cindex authentication "expansion item"
12315 Performing these checks sets up information used by the
12316 &%authresults%& expansion item.
12317
12318
12319 .vitem &$host_lookup_failed$&
12320 .vindex "&$host_lookup_failed$&"
12321 See &$host_lookup_deferred$&.
12322
12323 .vitem &$host_port$&
12324 .vindex "&$host_port$&"
12325 This variable is set to the remote host's TCP port whenever &$host$& is set
12326 for an outbound connection.
12327
12328 .vitem &$initial_cwd$&
12329 .vindex "&$initial_cwd$&
12330 This variable contains the full path name of the initial working
12331 directory of the current Exim process. This may differ from the current
12332 working directory, as Exim changes this to "/" during early startup, and
12333 to &$spool_directory$& later.
12334
12335 .vitem &$inode$&
12336 .vindex "&$inode$&"
12337 The only time this variable is set is while expanding the &%directory_file%&
12338 option in the &(appendfile)& transport. The variable contains the inode number
12339 of the temporary file which is about to be renamed. It can be used to construct
12340 a unique name for the file.
12341
12342 .vitem &$interface_address$&
12343 .vindex "&$interface_address$&"
12344 This is an obsolete name for &$received_ip_address$&.
12345
12346 .vitem &$interface_port$&
12347 .vindex "&$interface_port$&"
12348 This is an obsolete name for &$received_port$&.
12349
12350 .vitem &$item$&
12351 .vindex "&$item$&"
12352 This variable is used during the expansion of &*forall*& and &*forany*&
12353 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12354 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12355 empty.
12356
12357 .vitem &$ldap_dn$&
12358 .vindex "&$ldap_dn$&"
12359 This variable, which is available only when Exim is compiled with LDAP support,
12360 contains the DN from the last entry in the most recently successful LDAP
12361 lookup.
12362
12363 .vitem &$load_average$&
12364 .vindex "&$load_average$&"
12365 This variable contains the system load average, multiplied by 1000 so that it
12366 is an integer. For example, if the load average is 0.21, the value of the
12367 variable is 210. The value is recomputed every time the variable is referenced.
12368
12369 .vitem &$local_part$&
12370 .vindex "&$local_part$&"
12371 When an address is being routed, or delivered on its own, this
12372 variable contains the local part. When a number of addresses are being
12373 delivered together (for example, multiple RCPT commands in an SMTP
12374 session), &$local_part$& is not set.
12375
12376 Global address rewriting happens when a message is received, so the value of
12377 &$local_part$& during routing and delivery is the value after rewriting.
12378 &$local_part$& is set during user filtering, but not during system filtering,
12379 because a message may have many recipients and the system filter is called just
12380 once.
12381
12382 .vindex "&$local_part_prefix$&"
12383 .vindex "&$local_part_suffix$&"
12384 .cindex affix variables
12385 If a local part prefix or suffix has been recognized, it is not included in the
12386 value of &$local_part$& during routing and subsequent delivery. The values of
12387 any prefix or suffix are in &$local_part_prefix$& and
12388 &$local_part_suffix$&, respectively.
12389
12390 When a message is being delivered to a file, pipe, or autoreply transport as a
12391 result of aliasing or forwarding, &$local_part$& is set to the local part of
12392 the parent address, not to the filename or command (see &$address_file$& and
12393 &$address_pipe$&).
12394
12395 When an ACL is running for a RCPT command, &$local_part$& contains the
12396 local part of the recipient address.
12397
12398 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12399 &$local_part$& contains the local part of the address that is being rewritten;
12400 it can be used in the expansion of the replacement address, for example.
12401
12402 In all cases, all quoting is removed from the local part. For example, for both
12403 the addresses
12404 .code
12405 "abc:xyz"@test.example
12406 abc\:xyz@test.example
12407 .endd
12408 the value of &$local_part$& is
12409 .code
12410 abc:xyz
12411 .endd
12412 If you use &$local_part$& to create another address, you should always wrap it
12413 inside a quoting operator. For example, in a &(redirect)& router you could
12414 have:
12415 .code
12416 data = ${quote_local_part:$local_part}@new.domain.example
12417 .endd
12418 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12419 to process local parts in a case-dependent manner in a router, you can set the
12420 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12421
12422 .vitem &$local_part_data$&
12423 .vindex "&$local_part_data$&"
12424 When the &%local_parts%& option on a router matches a local part by means of a
12425 lookup, the data read by the lookup is available during the running of the
12426 router as &$local_part_data$&. In addition, if the driver routes the address
12427 to a transport, the value is available in that transport. If the transport is
12428 handling multiple addresses, the value from the first address is used.
12429
12430 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12431 matches a local part by means of a lookup. The data read by the lookup is
12432 available during the rest of the ACL statement. In all other situations, this
12433 variable expands to nothing.
12434
12435 .vitem &$local_part_prefix$&
12436 .vindex "&$local_part_prefix$&"
12437 .cindex affix variables
12438 When an address is being routed or delivered, and a
12439 specific prefix for the local part was recognized, it is available in this
12440 variable, having been removed from &$local_part$&.
12441
12442 .vitem &$local_part_suffix$&
12443 .vindex "&$local_part_suffix$&"
12444 When an address is being routed or delivered, and a
12445 specific suffix for the local part was recognized, it is available in this
12446 variable, having been removed from &$local_part$&.
12447
12448 .vitem &$local_scan_data$&
12449 .vindex "&$local_scan_data$&"
12450 This variable contains the text returned by the &[local_scan()]& function when
12451 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12452
12453 .vitem &$local_user_gid$&
12454 .vindex "&$local_user_gid$&"
12455 See &$local_user_uid$&.
12456
12457 .vitem &$local_user_uid$&
12458 .vindex "&$local_user_uid$&"
12459 This variable and &$local_user_gid$& are set to the uid and gid after the
12460 &%check_local_user%& router precondition succeeds. This means that their values
12461 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12462 and &%condition%&), for the &%address_data%& expansion, and for any
12463 router-specific expansions. At all other times, the values in these variables
12464 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12465
12466 .vitem &$localhost_number$&
12467 .vindex "&$localhost_number$&"
12468 This contains the expanded value of the
12469 &%localhost_number%& option. The expansion happens after the main options have
12470 been read.
12471
12472 .vitem &$log_inodes$&
12473 .vindex "&$log_inodes$&"
12474 The number of free inodes in the disk partition where Exim's
12475 log files are being written. The value is recalculated whenever the variable is
12476 referenced. If the relevant file system does not have the concept of inodes,
12477 the value of is -1. See also the &%check_log_inodes%& option.
12478
12479 .vitem &$log_space$&
12480 .vindex "&$log_space$&"
12481 The amount of free space (as a number of kilobytes) in the disk
12482 partition where Exim's log files are being written. The value is recalculated
12483 whenever the variable is referenced. If the operating system does not have the
12484 ability to find the amount of free space (only true for experimental systems),
12485 the space value is -1. See also the &%check_log_space%& option.
12486
12487
12488 .vitem &$lookup_dnssec_authenticated$&
12489 .vindex "&$lookup_dnssec_authenticated$&"
12490 This variable is set after a DNS lookup done by
12491 a dnsdb lookup expansion, dnslookup router or smtp transport.
12492 .cindex "DNS" "DNSSEC"
12493 It will be empty if &(DNSSEC)& was not requested,
12494 &"no"& if the result was not labelled as authenticated data
12495 and &"yes"& if it was.
12496 Results that are labelled as authoritative answer that match
12497 the &%dns_trust_aa%& configuration variable count also
12498 as authenticated data.
12499
12500 .vitem &$mailstore_basename$&
12501 .vindex "&$mailstore_basename$&"
12502 This variable is set only when doing deliveries in &"mailstore"& format in the
12503 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12504 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12505 contains the basename of the files that are being written, that is, the name
12506 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12507 variable is empty.
12508
12509 .vitem &$malware_name$&
12510 .vindex "&$malware_name$&"
12511 This variable is available when Exim is compiled with the
12512 content-scanning extension. It is set to the name of the virus that was found
12513 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12514
12515 .vitem &$max_received_linelength$&
12516 .vindex "&$max_received_linelength$&"
12517 .cindex "maximum" "line length"
12518 .cindex "line length" "maximum"
12519 This variable contains the number of bytes in the longest line that was
12520 received as part of the message, not counting the line termination
12521 character(s).
12522 It is not valid if the &%spool_files_wireformat%& option is used.
12523
12524 .vitem &$message_age$&
12525 .cindex "message" "age of"
12526 .vindex "&$message_age$&"
12527 This variable is set at the start of a delivery attempt to contain the number
12528 of seconds since the message was received. It does not change during a single
12529 delivery attempt.
12530
12531 .vitem &$message_body$&
12532 .cindex "body of message" "expansion variable"
12533 .cindex "message body" "in expansion"
12534 .cindex "binary zero" "in message body"
12535 .vindex "&$message_body$&"
12536 .oindex "&%message_body_visible%&"
12537 This variable contains the initial portion of a message's body while it is
12538 being delivered, and is intended mainly for use in filter files. The maximum
12539 number of characters of the body that are put into the variable is set by the
12540 &%message_body_visible%& configuration option; the default is 500.
12541
12542 .oindex "&%message_body_newlines%&"
12543 By default, newlines are converted into spaces in &$message_body$&, to make it
12544 easier to search for phrases that might be split over a line break. However,
12545 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12546 zeros are always converted into spaces.
12547
12548 .vitem &$message_body_end$&
12549 .cindex "body of message" "expansion variable"
12550 .cindex "message body" "in expansion"
12551 .vindex "&$message_body_end$&"
12552 This variable contains the final portion of a message's
12553 body while it is being delivered. The format and maximum size are as for
12554 &$message_body$&.
12555
12556 .vitem &$message_body_size$&
12557 .cindex "body of message" "size"
12558 .cindex "message body" "size"
12559 .vindex "&$message_body_size$&"
12560 When a message is being delivered, this variable contains the size of the body
12561 in bytes. The count starts from the character after the blank line that
12562 separates the body from the header. Newlines are included in the count. See
12563 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12564
12565 If the spool file is wireformat
12566 (see the &%spool_files_wireformat%& main option)
12567 the CRLF line-terminators are included in the count.
12568
12569 .vitem &$message_exim_id$&
12570 .vindex "&$message_exim_id$&"
12571 When a message is being received or delivered, this variable contains the
12572 unique message id that is generated and used by Exim to identify the message.
12573 An id is not created for a message until after its header has been successfully
12574 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12575 line; it is the local id that Exim assigns to the message, for example:
12576 &`1BXTIK-0001yO-VA`&.
12577
12578 .vitem &$message_headers$&
12579 .vindex &$message_headers$&
12580 This variable contains a concatenation of all the header lines when a message
12581 is being processed, except for lines added by routers or transports. The header
12582 lines are separated by newline characters. Their contents are decoded in the
12583 same way as a header line that is inserted by &%bheader%&.
12584
12585 .vitem &$message_headers_raw$&
12586 .vindex &$message_headers_raw$&
12587 This variable is like &$message_headers$& except that no processing of the
12588 contents of header lines is done.
12589
12590 .vitem &$message_id$&
12591 This is an old name for &$message_exim_id$&. It is now deprecated.
12592
12593 .vitem &$message_linecount$&
12594 .vindex "&$message_linecount$&"
12595 This variable contains the total number of lines in the header and body of the
12596 message. Compare &$body_linecount$&, which is the count for the body only.
12597 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12598 number of lines received. Before delivery happens (that is, before filters,
12599 routers, and transports run) the count is increased to include the
12600 &'Received:'& header line that Exim standardly adds, and also any other header
12601 lines that are added by ACLs. The blank line that separates the message header
12602 from the body is not counted.
12603
12604 As with the special case of &$message_size$&, during the expansion of the
12605 appendfile transport's maildir_tag option in maildir format, the value of
12606 &$message_linecount$& is the precise size of the number of newlines in the
12607 file that has been written (minus one for the blank line between the
12608 header and the body).
12609
12610 Here is an example of the use of this variable in a DATA ACL:
12611 .code
12612 deny message   = Too many lines in message header
12613      condition = \
12614       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12615 .endd
12616 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12617 message has not yet been received.
12618
12619 This variable is not valid if the &%spool_files_wireformat%& option is used.
12620
12621 .vitem &$message_size$&
12622 .cindex "size" "of message"
12623 .cindex "message" "size"
12624 .vindex "&$message_size$&"
12625 When a message is being processed, this variable contains its size in bytes. In
12626 most cases, the size includes those headers that were received with the
12627 message, but not those (such as &'Envelope-to:'&) that are added to individual
12628 deliveries as they are written. However, there is one special case: during the
12629 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12630 doing a delivery in maildir format, the value of &$message_size$& is the
12631 precise size of the file that has been written. See also
12632 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12633
12634 .cindex "RCPT" "value of &$message_size$&"
12635 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12636 contains the size supplied on the MAIL command, or -1 if no size was given. The
12637 value may not, of course, be truthful.
12638
12639 .vitem &$mime_$&&'xxx'&
12640 A number of variables whose names start with &$mime$& are
12641 available when Exim is compiled with the content-scanning extension. For
12642 details, see section &<<SECTscanmimepart>>&.
12643
12644 .vitem "&$n0$& &-- &$n9$&"
12645 These variables are counters that can be incremented by means
12646 of the &%add%& command in filter files.
12647
12648 .vitem &$original_domain$&
12649 .vindex "&$domain$&"
12650 .vindex "&$original_domain$&"
12651 When a top-level address is being processed for delivery, this contains the
12652 same value as &$domain$&. However, if a &"child"& address (for example,
12653 generated by an alias, forward, or filter file) is being processed, this
12654 variable contains the domain of the original address (lower cased). This
12655 differs from &$parent_domain$& only when there is more than one level of
12656 aliasing or forwarding. When more than one address is being delivered in a
12657 single transport run, &$original_domain$& is not set.
12658
12659 If a new address is created by means of a &%deliver%& command in a system
12660 filter, it is set up with an artificial &"parent"& address. This has the local
12661 part &'system-filter'& and the default qualify domain.
12662
12663 .vitem &$original_local_part$&
12664 .vindex "&$local_part$&"
12665 .vindex "&$original_local_part$&"
12666 When a top-level address is being processed for delivery, this contains the
12667 same value as &$local_part$&, unless a prefix or suffix was removed from the
12668 local part, because &$original_local_part$& always contains the full local
12669 part. When a &"child"& address (for example, generated by an alias, forward, or
12670 filter file) is being processed, this variable contains the full local part of
12671 the original address.
12672
12673 If the router that did the redirection processed the local part
12674 case-insensitively, the value in &$original_local_part$& is in lower case.
12675 This variable differs from &$parent_local_part$& only when there is more than
12676 one level of aliasing or forwarding. When more than one address is being
12677 delivered in a single transport run, &$original_local_part$& is not set.
12678
12679 If a new address is created by means of a &%deliver%& command in a system
12680 filter, it is set up with an artificial &"parent"& address. This has the local
12681 part &'system-filter'& and the default qualify domain.
12682
12683 .vitem &$originator_gid$&
12684 .cindex "gid (group id)" "of originating user"
12685 .cindex "sender" "gid"
12686 .vindex "&$caller_gid$&"
12687 .vindex "&$originator_gid$&"
12688 This variable contains the value of &$caller_gid$& that was set when the
12689 message was received. For messages received via the command line, this is the
12690 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12691 normally the gid of the Exim user.
12692
12693 .vitem &$originator_uid$&
12694 .cindex "uid (user id)" "of originating user"
12695 .cindex "sender" "uid"
12696 .vindex "&$caller_uid$&"
12697 .vindex "&$originator_uid$&"
12698 The value of &$caller_uid$& that was set when the message was received. For
12699 messages received via the command line, this is the uid of the sending user.
12700 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12701 user.
12702
12703 .vitem &$parent_domain$&
12704 .vindex "&$parent_domain$&"
12705 This variable is similar to &$original_domain$& (see
12706 above), except that it refers to the immediately preceding parent address.
12707
12708 .vitem &$parent_local_part$&
12709 .vindex "&$parent_local_part$&"
12710 This variable is similar to &$original_local_part$&
12711 (see above), except that it refers to the immediately preceding parent address.
12712
12713 .vitem &$pid$&
12714 .cindex "pid (process id)" "of current process"
12715 .vindex "&$pid$&"
12716 This variable contains the current process id.
12717
12718 .vitem &$pipe_addresses$&
12719 .cindex "filter" "transport filter"
12720 .cindex "transport" "filter"
12721 .vindex "&$pipe_addresses$&"
12722 This is not an expansion variable, but is mentioned here because the string
12723 &`$pipe_addresses`& is handled specially in the command specification for the
12724 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12725 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12726 It cannot be used in general expansion strings, and provokes an &"unknown
12727 variable"& error if encountered.
12728
12729 .vitem &$primary_hostname$&
12730 .vindex "&$primary_hostname$&"
12731 This variable contains the value set by &%primary_hostname%& in the
12732 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12733 a single-component name, Exim calls &[gethostbyname()]& (or
12734 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12735 qualified host name. See also &$smtp_active_hostname$&.
12736
12737
12738 .vitem &$proxy_external_address$& &&&
12739        &$proxy_external_port$& &&&
12740        &$proxy_local_address$& &&&
12741        &$proxy_local_port$& &&&
12742        &$proxy_session$&
12743 These variables are only available when built with Proxy Protocol
12744 or SOCKS5 support.
12745 For details see chapter &<<SECTproxyInbound>>&.
12746
12747 .vitem &$prdr_requested$&
12748 .cindex "PRDR" "variable for"
12749 This variable is set to &"yes"& if PRDR was requested by the client for the
12750 current message, otherwise &"no"&.
12751
12752 .vitem &$prvscheck_address$&
12753 This variable is used in conjunction with the &%prvscheck%& expansion item,
12754 which is described in sections &<<SECTexpansionitems>>& and
12755 &<<SECTverifyPRVS>>&.
12756
12757 .vitem &$prvscheck_keynum$&
12758 This variable is used in conjunction with the &%prvscheck%& expansion item,
12759 which is described in sections &<<SECTexpansionitems>>& and
12760 &<<SECTverifyPRVS>>&.
12761
12762 .vitem &$prvscheck_result$&
12763 This variable is used in conjunction with the &%prvscheck%& expansion item,
12764 which is described in sections &<<SECTexpansionitems>>& and
12765 &<<SECTverifyPRVS>>&.
12766
12767 .vitem &$qualify_domain$&
12768 .vindex "&$qualify_domain$&"
12769 The value set for the &%qualify_domain%& option in the configuration file.
12770
12771 .vitem &$qualify_recipient$&
12772 .vindex "&$qualify_recipient$&"
12773 The value set for the &%qualify_recipient%& option in the configuration file,
12774 or if not set, the value of &$qualify_domain$&.
12775
12776 .vitem &$queue_name$&
12777 .vindex &$queue_name$&
12778 .cindex "named queues"
12779 .cindex queues named
12780 The name of the spool queue in use; empty for the default queue.
12781
12782 .new
12783 .vitem &$r_...$&
12784 .vindex &$r_...$&
12785 .cindex router variables
12786 Values can be placed in these variables by the &%set%& option of a router.
12787 They can be given any name that starts with &$r_$&.
12788 The values persist for the address being handled through subsequent routers
12789 and the eventual transport.
12790 .wen
12791
12792 .vitem &$rcpt_count$&
12793 .vindex "&$rcpt_count$&"
12794 When a message is being received by SMTP, this variable contains the number of
12795 RCPT commands received for the current message. If this variable is used in a
12796 RCPT ACL, its value includes the current command.
12797
12798 .vitem &$rcpt_defer_count$&
12799 .vindex "&$rcpt_defer_count$&"
12800 .cindex "4&'xx'& responses" "count of"
12801 When a message is being received by SMTP, this variable contains the number of
12802 RCPT commands in the current message that have previously been rejected with a
12803 temporary (4&'xx'&) response.
12804
12805 .vitem &$rcpt_fail_count$&
12806 .vindex "&$rcpt_fail_count$&"
12807 When a message is being received by SMTP, this variable contains the number of
12808 RCPT commands in the current message that have previously been rejected with a
12809 permanent (5&'xx'&) response.
12810
12811 .vitem &$received_count$&
12812 .vindex "&$received_count$&"
12813 This variable contains the number of &'Received:'& header lines in the message,
12814 including the one added by Exim (so its value is always greater than zero). It
12815 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12816 delivering.
12817
12818 .vitem &$received_for$&
12819 .vindex "&$received_for$&"
12820 If there is only a single recipient address in an incoming message, this
12821 variable contains that address when the &'Received:'& header line is being
12822 built. The value is copied after recipient rewriting has happened, but before
12823 the &[local_scan()]& function is run.
12824
12825 .vitem &$received_ip_address$&
12826 .vindex "&$received_ip_address$&"
12827 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12828 variable is set to the address of the local IP interface, and &$received_port$&
12829 is set to the local port number. (The remote IP address and port are in
12830 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12831 the port value is -1 unless it has been set using the &%-oMi%& command line
12832 option.
12833
12834 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12835 could be used, for example, to make the filename for a TLS certificate depend
12836 on which interface and/or port is being used for the incoming connection. The
12837 values of &$received_ip_address$& and &$received_port$& are saved with any
12838 messages that are received, thus making these variables available at delivery
12839 time.
12840 For outbound connections see &$sending_ip_address$&.
12841
12842 .vitem &$received_port$&
12843 .vindex "&$received_port$&"
12844 See &$received_ip_address$&.
12845
12846 .vitem &$received_protocol$&
12847 .vindex "&$received_protocol$&"
12848 When a message is being processed, this variable contains the name of the
12849 protocol by which it was received. Most of the names used by Exim are defined
12850 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12851 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12852 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12853 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12854 connection and the client was successfully authenticated.
12855
12856 Exim uses the protocol name &"smtps"& for the case when encryption is
12857 automatically set up on connection without the use of STARTTLS (see
12858 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12859 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12860 where the client initially uses EHLO, sets up an encrypted connection using
12861 STARTTLS, and then uses HELO afterwards.
12862
12863 The &%-oMr%& option provides a way of specifying a custom protocol name for
12864 messages that are injected locally by trusted callers. This is commonly used to
12865 identify messages that are being re-injected after some kind of scanning.
12866
12867 .vitem &$received_time$&
12868 .vindex "&$received_time$&"
12869 This variable contains the date and time when the current message was received,
12870 as a number of seconds since the start of the Unix epoch.
12871
12872 .vitem &$recipient_data$&
12873 .vindex "&$recipient_data$&"
12874 This variable is set after an indexing lookup success in an ACL &%recipients%&
12875 condition. It contains the data from the lookup, and the value remains set
12876 until the next &%recipients%& test. Thus, you can do things like this:
12877 .display
12878 &`require recipients  = cdb*@;/some/file`&
12879 &`deny    `&&'some further test involving'& &`$recipient_data`&
12880 .endd
12881 &*Warning*&: This variable is set only when a lookup is used as an indexing
12882 method in the address list, using the semicolon syntax as in the example above.
12883 The variable is not set for a lookup that is used as part of the string
12884 expansion that all such lists undergo before being interpreted.
12885
12886 .vitem &$recipient_verify_failure$&
12887 .vindex "&$recipient_verify_failure$&"
12888 In an ACL, when a recipient verification fails, this variable contains
12889 information about the failure. It is set to one of the following words:
12890
12891 .ilist
12892 &"qualify"&: The address was unqualified (no domain), and the message
12893 was neither local nor came from an exempted host.
12894
12895 .next
12896 &"route"&: Routing failed.
12897
12898 .next
12899 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12900 or before the MAIL command (that is, on initial connection, HELO, or
12901 MAIL).
12902
12903 .next
12904 &"recipient"&: The RCPT command in a callout was rejected.
12905 .next
12906
12907 &"postmaster"&: The postmaster check in a callout was rejected.
12908 .endlist
12909
12910 The main use of this variable is expected to be to distinguish between
12911 rejections of MAIL and rejections of RCPT.
12912
12913 .vitem &$recipients$&
12914 .vindex "&$recipients$&"
12915 This variable contains a list of envelope recipients for a message. A comma and
12916 a space separate the addresses in the replacement text. However, the variable
12917 is not generally available, to prevent exposure of Bcc recipients in
12918 unprivileged users' filter files. You can use &$recipients$& only in these
12919 cases:
12920
12921 .olist
12922 In a system filter file.
12923 .next
12924 In the ACLs associated with the DATA command and with non-SMTP messages, that
12925 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12926 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12927 &%acl_not_smtp_mime%&.
12928 .next
12929 From within a &[local_scan()]& function.
12930 .endlist
12931
12932
12933 .vitem &$recipients_count$&
12934 .vindex "&$recipients_count$&"
12935 When a message is being processed, this variable contains the number of
12936 envelope recipients that came with the message. Duplicates are not excluded
12937 from the count. While a message is being received over SMTP, the number
12938 increases for each accepted recipient. It can be referenced in an ACL.
12939
12940
12941 .vitem &$regex_match_string$&
12942 .vindex "&$regex_match_string$&"
12943 This variable is set to contain the matching regular expression after a
12944 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12945
12946 .vitem "&$regex1$&, &$regex2$&, etc"
12947 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12948 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12949 these variables contain the
12950 captured substrings identified by the regular expression.
12951
12952
12953 .vitem &$reply_address$&
12954 .vindex "&$reply_address$&"
12955 When a message is being processed, this variable contains the contents of the
12956 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12957 contents of the &'From:'& header line. Apart from the removal of leading
12958 white space, the value is not processed in any way. In particular, no RFC 2047
12959 decoding or character code translation takes place.
12960
12961 .vitem &$return_path$&
12962 .vindex "&$return_path$&"
12963 When a message is being delivered, this variable contains the return path &--
12964 the sender field that will be sent as part of the envelope. It is not enclosed
12965 in <> characters. At the start of routing an address, &$return_path$& has the
12966 same value as &$sender_address$&, but if, for example, an incoming message to a
12967 mailing list has been expanded by a router which specifies a different address
12968 for bounce messages, &$return_path$& subsequently contains the new bounce
12969 address, whereas &$sender_address$& always contains the original sender address
12970 that was received with the message. In other words, &$sender_address$& contains
12971 the incoming envelope sender, and &$return_path$& contains the outgoing
12972 envelope sender.
12973
12974 .vitem &$return_size_limit$&
12975 .vindex "&$return_size_limit$&"
12976 This is an obsolete name for &$bounce_return_size_limit$&.
12977
12978 .vitem &$router_name$&
12979 .cindex "router" "name"
12980 .cindex "name" "of router"
12981 .vindex "&$router_name$&"
12982 During the running of a router this variable contains its name.
12983
12984 .vitem &$runrc$&
12985 .cindex "return code" "from &%run%& expansion"
12986 .vindex "&$runrc$&"
12987 This variable contains the return code from a command that is run by the
12988 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12989 assume the order in which option values are expanded, except for those
12990 preconditions whose order of testing is documented. Therefore, you cannot
12991 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12992 another.
12993
12994 .vitem &$self_hostname$&
12995 .oindex "&%self%&" "value of host name"
12996 .vindex "&$self_hostname$&"
12997 When an address is routed to a supposedly remote host that turns out to be the
12998 local host, what happens is controlled by the &%self%& generic router option.
12999 One of its values causes the address to be passed to another router. When this
13000 happens, &$self_hostname$& is set to the name of the local host that the
13001 original router encountered. In other circumstances its contents are null.
13002
13003 .vitem &$sender_address$&
13004 .vindex "&$sender_address$&"
13005 When a message is being processed, this variable contains the sender's address
13006 that was received in the message's envelope. The case of letters in the address
13007 is retained, in both the local part and the domain. For bounce messages, the
13008 value of this variable is the empty string. See also &$return_path$&.
13009
13010 .vitem &$sender_address_data$&
13011 .vindex "&$address_data$&"
13012 .vindex "&$sender_address_data$&"
13013 If &$address_data$& is set when the routers are called from an ACL to verify a
13014 sender address, the final value is preserved in &$sender_address_data$&, to
13015 distinguish it from data from a recipient address. The value does not persist
13016 after the end of the current ACL statement. If you want to preserve it for
13017 longer, you can save it in an ACL variable.
13018
13019 .vitem &$sender_address_domain$&
13020 .vindex "&$sender_address_domain$&"
13021 The domain portion of &$sender_address$&.
13022
13023 .vitem &$sender_address_local_part$&
13024 .vindex "&$sender_address_local_part$&"
13025 The local part portion of &$sender_address$&.
13026
13027 .vitem &$sender_data$&
13028 .vindex "&$sender_data$&"
13029 This variable is set after a lookup success in an ACL &%senders%& condition or
13030 in a router &%senders%& option. It contains the data from the lookup, and the
13031 value remains set until the next &%senders%& test. Thus, you can do things like
13032 this:
13033 .display
13034 &`require senders      = cdb*@;/some/file`&
13035 &`deny    `&&'some further test involving'& &`$sender_data`&
13036 .endd
13037 &*Warning*&: This variable is set only when a lookup is used as an indexing
13038 method in the address list, using the semicolon syntax as in the example above.
13039 The variable is not set for a lookup that is used as part of the string
13040 expansion that all such lists undergo before being interpreted.
13041
13042 .vitem &$sender_fullhost$&
13043 .vindex "&$sender_fullhost$&"
13044 When a message is received from a remote host, this variable contains the host
13045 name and IP address in a single string. It ends with the IP address in square
13046 brackets, followed by a colon and a port number if the logging of ports is
13047 enabled. The format of the rest of the string depends on whether the host
13048 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13049 looking up its IP address. (Looking up the IP address can be forced by the
13050 &%host_lookup%& option, independent of verification.) A plain host name at the
13051 start of the string is a verified host name; if this is not present,
13052 verification either failed or was not requested. A host name in parentheses is
13053 the argument of a HELO or EHLO command. This is omitted if it is identical to
13054 the verified host name or to the host's IP address in square brackets.
13055
13056 .vitem &$sender_helo_dnssec$&
13057 .vindex "&$sender_helo_dnssec$&"
13058 This boolean variable is true if a successful HELO verification was
13059 .cindex "DNS" "DNSSEC"
13060 done using DNS information the resolver library stated was authenticated data.
13061
13062 .vitem &$sender_helo_name$&
13063 .vindex "&$sender_helo_name$&"
13064 When a message is received from a remote host that has issued a HELO or EHLO
13065 command, the argument of that command is placed in this variable. It is also
13066 set if HELO or EHLO is used when a message is received using SMTP locally via
13067 the &%-bs%& or &%-bS%& options.
13068
13069 .vitem &$sender_host_address$&
13070 .vindex "&$sender_host_address$&"
13071 When a message is received from a remote host using SMTP,
13072 this variable contains that
13073 host's IP address. For locally non-SMTP submitted messages, it is empty.
13074
13075 .vitem &$sender_host_authenticated$&
13076 .vindex "&$sender_host_authenticated$&"
13077 This variable contains the name (not the public name) of the authenticator
13078 driver that successfully authenticated the client from which the message was
13079 received. It is empty if there was no successful authentication. See also
13080 &$authenticated_id$&.
13081
13082 .vitem &$sender_host_dnssec$&
13083 .vindex "&$sender_host_dnssec$&"
13084 If an attempt to populate &$sender_host_name$& has been made
13085 (by reference, &%hosts_lookup%& or
13086 otherwise) then this boolean will have been set true if, and only if, the
13087 resolver library states that both
13088 the reverse and forward DNS were authenticated data.  At all
13089 other times, this variable is false.
13090
13091 .cindex "DNS" "DNSSEC"
13092 It is likely that you will need to coerce DNSSEC support on in the resolver
13093 library, by setting:
13094 .code
13095 dns_dnssec_ok = 1
13096 .endd
13097
13098 Exim does not perform DNSSEC validation itself, instead leaving that to a
13099 validating resolver (e.g. unbound, or bind with suitable configuration).
13100
13101 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13102 mechanism in the list, then this variable will be false.
13103
13104 This requires that your system resolver library support EDNS0 (and that
13105 DNSSEC flags exist in the system headers).  If the resolver silently drops
13106 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13107 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13108
13109
13110 .vitem &$sender_host_name$&
13111 .vindex "&$sender_host_name$&"
13112 When a message is received from a remote host, this variable contains the
13113 host's name as obtained by looking up its IP address. For messages received by
13114 other means, this variable is empty.
13115
13116 .vindex "&$host_lookup_failed$&"
13117 If the host name has not previously been looked up, a reference to
13118 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13119 A looked up name is accepted only if it leads back to the original IP address
13120 via a forward lookup. If either the reverse or the forward lookup fails to find
13121 any data, or if the forward lookup does not yield the original IP address,
13122 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13123
13124 .vindex "&$host_lookup_deferred$&"
13125 However, if either of the lookups cannot be completed (for example, there is a
13126 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13127 &$host_lookup_failed$& remains set to &"0"&.
13128
13129 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13130 host name again if there is a subsequent reference to &$sender_host_name$&
13131 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13132 is set to &"1"&.
13133
13134 Exim does not automatically look up every calling host's name. If you want
13135 maximum efficiency, you should arrange your configuration so that it avoids
13136 these lookups altogether. The lookup happens only if one or more of the
13137 following are true:
13138
13139 .ilist
13140 A string containing &$sender_host_name$& is expanded.
13141 .next
13142 The calling host matches the list in &%host_lookup%&. In the default
13143 configuration, this option is set to *, so it must be changed if lookups are
13144 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13145 .next
13146 Exim needs the host name in order to test an item in a host list. The items
13147 that require this are described in sections &<<SECThoslispatnam>>& and
13148 &<<SECThoslispatnamsk>>&.
13149 .next
13150 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13151 In this case, the host name is required to compare with the name quoted in any
13152 EHLO or HELO commands that the client issues.
13153 .next
13154 The remote host issues a EHLO or HELO command that quotes one of the
13155 domains in &%helo_lookup_domains%&. The default value of this option is
13156 . ==== As this is a nested list, any displays it contains must be indented
13157 . ==== as otherwise they are too far to the left.
13158 .code
13159   helo_lookup_domains = @ : @[]
13160 .endd
13161 which causes a lookup if a remote host (incorrectly) gives the server's name or
13162 IP address in an EHLO or HELO command.
13163 .endlist
13164
13165
13166 .vitem &$sender_host_port$&
13167 .vindex "&$sender_host_port$&"
13168 When a message is received from a remote host, this variable contains the port
13169 number that was used on the remote host.
13170
13171 .vitem &$sender_ident$&
13172 .vindex "&$sender_ident$&"
13173 When a message is received from a remote host, this variable contains the
13174 identification received in response to an RFC 1413 request. When a message has
13175 been received locally, this variable contains the login name of the user that
13176 called Exim.
13177
13178 .vitem &$sender_rate_$&&'xxx'&
13179 A number of variables whose names begin &$sender_rate_$& are set as part of the
13180 &%ratelimit%& ACL condition. Details are given in section
13181 &<<SECTratelimiting>>&.
13182
13183 .vitem &$sender_rcvhost$&
13184 .cindex "DNS" "reverse lookup"
13185 .cindex "reverse DNS lookup"
13186 .vindex "&$sender_rcvhost$&"
13187 This is provided specifically for use in &'Received:'& headers. It starts with
13188 either the verified host name (as obtained from a reverse DNS lookup) or, if
13189 there is no verified host name, the IP address in square brackets. After that
13190 there may be text in parentheses. When the first item is a verified host name,
13191 the first thing in the parentheses is the IP address in square brackets,
13192 followed by a colon and a port number if port logging is enabled. When the
13193 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13194 the parentheses.
13195
13196 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13197 was used and its argument was not identical to the real host name or IP
13198 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13199 all three items are present in the parentheses, a newline and tab are inserted
13200 into the string, to improve the formatting of the &'Received:'& header.
13201
13202 .vitem &$sender_verify_failure$&
13203 .vindex "&$sender_verify_failure$&"
13204 In an ACL, when a sender verification fails, this variable contains information
13205 about the failure. The details are the same as for
13206 &$recipient_verify_failure$&.
13207
13208 .vitem &$sending_ip_address$&
13209 .vindex "&$sending_ip_address$&"
13210 This variable is set whenever an outgoing SMTP connection to another host has
13211 been set up. It contains the IP address of the local interface that is being
13212 used. This is useful if a host that has more than one IP address wants to take
13213 on different personalities depending on which one is being used. For incoming
13214 connections, see &$received_ip_address$&.
13215
13216 .vitem &$sending_port$&
13217 .vindex "&$sending_port$&"
13218 This variable is set whenever an outgoing SMTP connection to another host has
13219 been set up. It contains the local port that is being used. For incoming
13220 connections, see &$received_port$&.
13221
13222 .vitem &$smtp_active_hostname$&
13223 .vindex "&$smtp_active_hostname$&"
13224 During an incoming SMTP session, this variable contains the value of the active
13225 host name, as specified by the &%smtp_active_hostname%& option. The value of
13226 &$smtp_active_hostname$& is saved with any message that is received, so its
13227 value can be consulted during routing and delivery.
13228
13229 .vitem &$smtp_command$&
13230 .vindex "&$smtp_command$&"
13231 During the processing of an incoming SMTP command, this variable contains the
13232 entire command. This makes it possible to distinguish between HELO and EHLO in
13233 the HELO ACL, and also to distinguish between commands such as these:
13234 .code
13235 MAIL FROM:<>
13236 MAIL FROM: <>
13237 .endd
13238 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13239 command, the address in &$smtp_command$& is the original address before any
13240 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13241 the address after SMTP-time rewriting.
13242
13243 .vitem &$smtp_command_argument$&
13244 .cindex "SMTP" "command, argument for"
13245 .vindex "&$smtp_command_argument$&"
13246 While an ACL is running to check an SMTP command, this variable contains the
13247 argument, that is, the text that follows the command name, with leading white
13248 space removed. Following the introduction of &$smtp_command$&, this variable is
13249 somewhat redundant, but is retained for backwards compatibility.
13250
13251 .vitem &$smtp_command_history$&
13252 .cindex SMTP "command history"
13253 .vindex "&$smtp_command_history$&"
13254 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13255 received, in time-order left to right.  Only a limited number of commands
13256 are remembered.
13257
13258 .vitem &$smtp_count_at_connection_start$&
13259 .vindex "&$smtp_count_at_connection_start$&"
13260 This variable is set greater than zero only in processes spawned by the Exim
13261 daemon for handling incoming SMTP connections. The name is deliberately long,
13262 in order to emphasize what the contents are. When the daemon accepts a new
13263 connection, it increments this variable. A copy of the variable is passed to
13264 the child process that handles the connection, but its value is fixed, and
13265 never changes. It is only an approximation of how many incoming connections
13266 there actually are, because many other connections may come and go while a
13267 single connection is being processed. When a child process terminates, the
13268 daemon decrements its copy of the variable.
13269
13270 .vitem "&$sn0$& &-- &$sn9$&"
13271 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13272 that were current at the end of the system filter file. This allows a system
13273 filter file to set values that can be tested in users' filter files. For
13274 example, a system filter could set a value indicating how likely it is that a
13275 message is junk mail.
13276
13277 .vitem &$spam_$&&'xxx'&
13278 A number of variables whose names start with &$spam$& are available when Exim
13279 is compiled with the content-scanning extension. For details, see section
13280 &<<SECTscanspamass>>&.
13281
13282 .vitem &$spf_header_comment$& &&&
13283        &$spf_received$& &&&
13284        &$spf_result$& &&&
13285        &$spf_result_guessed$& &&&
13286        &$spf_smtp_comment$&
13287 These variables are only available if Exim is built with SPF support.
13288 For details see section &<<SECSPF>>&.
13289
13290 .vitem &$spool_directory$&
13291 .vindex "&$spool_directory$&"
13292 The name of Exim's spool directory.
13293
13294 .vitem &$spool_inodes$&
13295 .vindex "&$spool_inodes$&"
13296 The number of free inodes in the disk partition where Exim's spool files are
13297 being written. The value is recalculated whenever the variable is referenced.
13298 If the relevant file system does not have the concept of inodes, the value of
13299 is -1. See also the &%check_spool_inodes%& option.
13300
13301 .vitem &$spool_space$&
13302 .vindex "&$spool_space$&"
13303 The amount of free space (as a number of kilobytes) in the disk partition where
13304 Exim's spool files are being written. The value is recalculated whenever the
13305 variable is referenced. If the operating system does not have the ability to
13306 find the amount of free space (only true for experimental systems), the space
13307 value is -1. For example, to check in an ACL that there is at least 50
13308 megabytes free on the spool, you could write:
13309 .code
13310 condition = ${if > {$spool_space}{50000}}
13311 .endd
13312 See also the &%check_spool_space%& option.
13313
13314
13315 .vitem &$thisaddress$&
13316 .vindex "&$thisaddress$&"
13317 This variable is set only during the processing of the &%foranyaddress%&
13318 command in a filter file. Its use is explained in the description of that
13319 command, which can be found in the separate document entitled &'Exim's
13320 interfaces to mail filtering'&.
13321
13322 .vitem &$tls_in_bits$&
13323 .vindex "&$tls_in_bits$&"
13324 Contains an approximation of the TLS cipher's bit-strength
13325 on the inbound connection; the meaning of
13326 this depends upon the TLS implementation used.
13327 If TLS has not been negotiated, the value will be 0.
13328 The value of this is automatically fed into the Cyrus SASL authenticator
13329 when acting as a server, to specify the "external SSF" (a SASL term).
13330
13331 The deprecated &$tls_bits$& variable refers to the inbound side
13332 except when used in the context of an outbound SMTP delivery, when it refers to
13333 the outbound.
13334
13335 .vitem &$tls_out_bits$&
13336 .vindex "&$tls_out_bits$&"
13337 Contains an approximation of the TLS cipher's bit-strength
13338 on an outbound SMTP connection; the meaning of
13339 this depends upon the TLS implementation used.
13340 If TLS has not been negotiated, the value will be 0.
13341
13342 .vitem &$tls_in_ourcert$&
13343 .vindex "&$tls_in_ourcert$&"
13344 .cindex certificate variables
13345 This variable refers to the certificate presented to the peer of an
13346 inbound connection when the message was received.
13347 It is only useful as the argument of a
13348 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13349 or a &%def%& condition.
13350
13351 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13352 when a list of more than one
13353 file is used for &%tls_certificate%&, this variable is not reliable.
13354 .new
13355 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13356 .wen
13357
13358 .vitem &$tls_in_peercert$&
13359 .vindex "&$tls_in_peercert$&"
13360 This variable refers to the certificate presented by the peer of an
13361 inbound connection when the message was received.
13362 It is only useful as the argument of a
13363 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13364 or a &%def%& condition.
13365 If certificate verification fails it may refer to a failing chain element
13366 which is not the leaf.
13367
13368 .vitem &$tls_out_ourcert$&
13369 .vindex "&$tls_out_ourcert$&"
13370 This variable refers to the certificate presented to the peer of an
13371 outbound connection.  It is only useful as the argument of a
13372 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13373 or a &%def%& condition.
13374
13375 .vitem &$tls_out_peercert$&
13376 .vindex "&$tls_out_peercert$&"
13377 This variable refers to the certificate presented by the peer of an
13378 outbound connection.  It is only useful as the argument of a
13379 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13380 or a &%def%& condition.
13381 If certificate verification fails it may refer to a failing chain element
13382 which is not the leaf.
13383
13384 .vitem &$tls_in_certificate_verified$&
13385 .vindex "&$tls_in_certificate_verified$&"
13386 This variable is set to &"1"& if a TLS certificate was verified when the
13387 message was received, and &"0"& otherwise.
13388
13389 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13390 except when used in the context of an outbound SMTP delivery, when it refers to
13391 the outbound.
13392
13393 .vitem &$tls_out_certificate_verified$&
13394 .vindex "&$tls_out_certificate_verified$&"
13395 This variable is set to &"1"& if a TLS certificate was verified when an
13396 outbound SMTP connection was made,
13397 and &"0"& otherwise.
13398
13399 .vitem &$tls_in_cipher$&
13400 .vindex "&$tls_in_cipher$&"
13401 .vindex "&$tls_cipher$&"
13402 When a message is received from a remote host over an encrypted SMTP
13403 connection, this variable is set to the cipher suite that was negotiated, for
13404 example DES-CBC3-SHA. In other circumstances, in particular, for message
13405 received over unencrypted connections, the variable is empty. Testing
13406 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13407 non-encrypted connections during ACL processing.
13408
13409 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13410 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13411 becomes the same as &$tls_out_cipher$&.
13412
13413 .new
13414 .vitem &$tls_in_cipher_std$&
13415 .vindex "&$tls_in_cipher_std$&"
13416 As above, but returning the RFC standard name for the cipher suite.
13417 .wen
13418
13419 .vitem &$tls_out_cipher$&
13420 .vindex "&$tls_out_cipher$&"
13421 This variable is
13422 cleared before any outgoing SMTP connection is made,
13423 and then set to the outgoing cipher suite if one is negotiated. See chapter
13424 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13425 details of the &(smtp)& transport.
13426
13427 ,new
13428 .vitem &$tls_out_cipher_std$&
13429 .vindex "&$tls_out_cipher_std$&"
13430 As above, but returning the RFC standard name for the cipher suite.
13431 .wen
13432
13433 .vitem &$tls_out_dane$&
13434 .vindex &$tls_out_dane$&
13435 DANE active status.  See section &<<SECDANE>>&.
13436
13437 .vitem &$tls_in_ocsp$&
13438 .vindex "&$tls_in_ocsp$&"
13439 When a message is received from a remote client connection
13440 the result of any OCSP request from the client is encoded in this variable:
13441 .code
13442 0 OCSP proof was not requested (default value)
13443 1 No response to request
13444 2 Response not verified
13445 3 Verification failed
13446 4 Verification succeeded
13447 .endd
13448
13449 .vitem &$tls_out_ocsp$&
13450 .vindex "&$tls_out_ocsp$&"
13451 When a message is sent to a remote host connection
13452 the result of any OCSP request made is encoded in this variable.
13453 See &$tls_in_ocsp$& for values.
13454
13455 .vitem &$tls_in_peerdn$&
13456 .vindex "&$tls_in_peerdn$&"
13457 .vindex "&$tls_peerdn$&"
13458 .cindex certificate "extracting fields"
13459 When a message is received from a remote host over an encrypted SMTP
13460 connection, and Exim is configured to request a certificate from the client,
13461 the value of the Distinguished Name of the certificate is made available in the
13462 &$tls_in_peerdn$& during subsequent processing.
13463 If certificate verification fails it may refer to a failing chain element
13464 which is not the leaf.
13465
13466 The deprecated &$tls_peerdn$& variable refers to the inbound side
13467 except when used in the context of an outbound SMTP delivery, when it refers to
13468 the outbound.
13469
13470 .vitem &$tls_out_peerdn$&
13471 .vindex "&$tls_out_peerdn$&"
13472 When a message is being delivered to a remote host over an encrypted SMTP
13473 connection, and Exim is configured to request a certificate from the server,
13474 the value of the Distinguished Name of the certificate is made available in the
13475 &$tls_out_peerdn$& during subsequent processing.
13476 If certificate verification fails it may refer to a failing chain element
13477 which is not the leaf.
13478
13479 .vitem &$tls_in_sni$&
13480 .vindex "&$tls_in_sni$&"
13481 .vindex "&$tls_sni$&"
13482 .cindex "TLS" "Server Name Indication"
13483 When a TLS session is being established, if the client sends the Server
13484 Name Indication extension, the value will be placed in this variable.
13485 If the variable appears in &%tls_certificate%& then this option and
13486 some others, described in &<<SECTtlssni>>&,
13487 will be re-expanded early in the TLS session, to permit
13488 a different certificate to be presented (and optionally a different key to be
13489 used) to the client, based upon the value of the SNI extension.
13490
13491 The deprecated &$tls_sni$& variable refers to the inbound side
13492 except when used in the context of an outbound SMTP delivery, when it refers to
13493 the outbound.
13494
13495 .vitem &$tls_out_sni$&
13496 .vindex "&$tls_out_sni$&"
13497 .cindex "TLS" "Server Name Indication"
13498 During outbound
13499 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13500 the transport.
13501
13502 .vitem &$tls_out_tlsa_usage$&
13503 .vindex &$tls_out_tlsa_usage$&
13504 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13505
13506 .vitem &$tod_bsdinbox$&
13507 .vindex "&$tod_bsdinbox$&"
13508 The time of day and the date, in the format required for BSD-style mailbox
13509 files, for example: Thu Oct 17 17:14:09 1995.
13510
13511 .vitem &$tod_epoch$&
13512 .vindex "&$tod_epoch$&"
13513 The time and date as a number of seconds since the start of the Unix epoch.
13514
13515 .vitem &$tod_epoch_l$&
13516 .vindex "&$tod_epoch_l$&"
13517 The time and date as a number of microseconds since the start of the Unix epoch.
13518
13519 .vitem &$tod_full$&
13520 .vindex "&$tod_full$&"
13521 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13522 +0100. The timezone is always given as a numerical offset from UTC, with
13523 positive values used for timezones that are ahead (east) of UTC, and negative
13524 values for those that are behind (west).
13525
13526 .vitem &$tod_log$&
13527 .vindex "&$tod_log$&"
13528 The time and date in the format used for writing Exim's log files, for example:
13529 1995-10-12 15:32:29, but without a timezone.
13530
13531 .vitem &$tod_logfile$&
13532 .vindex "&$tod_logfile$&"
13533 This variable contains the date in the format yyyymmdd. This is the format that
13534 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13535 flag.
13536
13537 .vitem &$tod_zone$&
13538 .vindex "&$tod_zone$&"
13539 This variable contains the numerical value of the local timezone, for example:
13540 -0500.
13541
13542 .vitem &$tod_zulu$&
13543 .vindex "&$tod_zulu$&"
13544 This variable contains the UTC date and time in &"Zulu"& format, as specified
13545 by ISO 8601, for example: 20030221154023Z.
13546
13547 .vitem &$transport_name$&
13548 .cindex "transport" "name"
13549 .cindex "name" "of transport"
13550 .vindex "&$transport_name$&"
13551 During the running of a transport, this variable contains its name.
13552
13553 .vitem &$value$&
13554 .vindex "&$value$&"
13555 This variable contains the result of an expansion lookup, extraction operation,
13556 or external command, as described above. It is also used during a
13557 &*reduce*& expansion.
13558
13559 .vitem &$verify_mode$&
13560 .vindex "&$verify_mode$&"
13561 While a router or transport is being run in verify mode or for cutthrough delivery,
13562 contains "S" for sender-verification or "R" for recipient-verification.
13563 Otherwise, empty.
13564
13565 .vitem &$version_number$&
13566 .vindex "&$version_number$&"
13567 The version number of Exim. Same as &$exim_version$&, may be overridden
13568 by the &%exim_version%& main config option.
13569
13570 .vitem &$warn_message_delay$&
13571 .vindex "&$warn_message_delay$&"
13572 This variable is set only during the creation of a message warning about a
13573 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13574
13575 .vitem &$warn_message_recipients$&
13576 .vindex "&$warn_message_recipients$&"
13577 This variable is set only during the creation of a message warning about a
13578 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13579 .endlist
13580 .ecindex IIDstrexp
13581
13582
13583
13584 . ////////////////////////////////////////////////////////////////////////////
13585 . ////////////////////////////////////////////////////////////////////////////
13586
13587 .chapter "Embedded Perl" "CHAPperl"
13588 .scindex IIDperl "Perl" "calling from Exim"
13589 Exim can be built to include an embedded Perl interpreter. When this is done,
13590 Perl subroutines can be called as part of the string expansion process. To make
13591 use of the Perl support, you need version 5.004 or later of Perl installed on
13592 your system. To include the embedded interpreter in the Exim binary, include
13593 the line
13594 .code
13595 EXIM_PERL = perl.o
13596 .endd
13597 in your &_Local/Makefile_& and then build Exim in the normal way.
13598
13599
13600 .section "Setting up so Perl can be used" "SECID85"
13601 .oindex "&%perl_startup%&"
13602 Access to Perl subroutines is via a global configuration option called
13603 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13604 no &%perl_startup%& option in the Exim configuration file then no Perl
13605 interpreter is started and there is almost no overhead for Exim (since none of
13606 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13607 option then the associated value is taken to be Perl code which is executed in
13608 a newly created Perl interpreter.
13609
13610 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13611 need backslashes before any characters to escape special meanings. The option
13612 should usually be something like
13613 .code
13614 perl_startup = do '/etc/exim.pl'
13615 .endd
13616 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13617 use from Exim. Exim can be configured either to start up a Perl interpreter as
13618 soon as it is entered, or to wait until the first time it is needed. Starting
13619 the interpreter at the beginning ensures that it is done while Exim still has
13620 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13621 fact used in a particular run. Also, note that this does not mean that Exim is
13622 necessarily running as root when Perl is called at a later time. By default,
13623 the interpreter is started only when it is needed, but this can be changed in
13624 two ways:
13625
13626 .ilist
13627 .oindex "&%perl_at_start%&"
13628 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13629 a startup when Exim is entered.
13630 .next
13631 The command line option &%-ps%& also requests a startup when Exim is entered,
13632 overriding the setting of &%perl_at_start%&.
13633 .endlist
13634
13635 There is also a command line option &%-pd%& (for delay) which suppresses the
13636 initial startup, even if &%perl_at_start%& is set.
13637
13638 .ilist
13639 .oindex "&%perl_taintmode%&"
13640 .cindex "Perl" "taintmode"
13641 To provide more security executing Perl code via the embedded Perl
13642 interpreter, the &%perl_taintmode%& option can be set. This enables the
13643 taint mode of the Perl interpreter. You are encouraged to set this
13644 option to a true value. To avoid breaking existing installations, it
13645 defaults to false.
13646
13647
13648 .section "Calling Perl subroutines" "SECID86"
13649 When the configuration file includes a &%perl_startup%& option you can make use
13650 of the string expansion item to call the Perl subroutines that are defined
13651 by the &%perl_startup%& code. The operator is used in any of the following
13652 forms:
13653 .code
13654 ${perl{foo}}
13655 ${perl{foo}{argument}}
13656 ${perl{foo}{argument1}{argument2} ... }
13657 .endd
13658 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13659 arguments may be passed. Passing more than this results in an expansion failure
13660 with an error message of the form
13661 .code
13662 Too many arguments passed to Perl subroutine "foo" (max is 8)
13663 .endd
13664 The return value of the Perl subroutine is evaluated in a scalar context before
13665 it is passed back to Exim to be inserted into the expanded string. If the
13666 return value is &'undef'&, the expansion is forced to fail in the same way as
13667 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13668 by obeying Perl's &%die%& function, the expansion fails with the error message
13669 that was passed to &%die%&.
13670
13671
13672 .section "Calling Exim functions from Perl" "SECID87"
13673 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13674 is available to call back into Exim's string expansion function. For example,
13675 the Perl code
13676 .code
13677 my $lp = Exim::expand_string('$local_part');
13678 .endd
13679 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13680 Note those are single quotes and not double quotes to protect against
13681 &$local_part$& being interpolated as a Perl variable.
13682
13683 If the string expansion is forced to fail by a &"fail"& item, the result of
13684 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13685 expansion string, the Perl call from the original expansion string fails with
13686 an appropriate error message, in the same way as if &%die%& were used.
13687
13688 .cindex "debugging" "from embedded Perl"
13689 .cindex "log" "writing from embedded Perl"
13690 Two other Exim functions are available for use from within Perl code.
13691 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13692 debugging is enabled. If you want a newline at the end, you must supply it.
13693 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13694 timestamp. In this case, you should not supply a terminating newline.
13695
13696
13697 .section "Use of standard output and error by Perl" "SECID88"
13698 .cindex "Perl" "standard output and error"
13699 You should not write to the standard error or output streams from within your
13700 Perl code, as it is not defined how these are set up. In versions of Exim
13701 before 4.50, it is possible for the standard output or error to refer to the
13702 SMTP connection during message reception via the daemon. Writing to this stream
13703 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13704 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13705 avoided, but the output is lost.
13706
13707 .cindex "Perl" "use of &%warn%&"
13708 The Perl &%warn%& statement writes to the standard error stream by default.
13709 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13710 you have no control. When Exim starts up the Perl interpreter, it arranges for
13711 output from the &%warn%& statement to be written to the Exim main log. You can
13712 change this by including appropriate Perl magic somewhere in your Perl code.
13713 For example, to discard &%warn%& output completely, you need this:
13714 .code
13715 $SIG{__WARN__} = sub { };
13716 .endd
13717 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13718 example, the code for the subroutine is empty, so it does nothing, but you can
13719 include any Perl code that you like. The text of the &%warn%& message is passed
13720 as the first subroutine argument.
13721 .ecindex IIDperl
13722
13723
13724 . ////////////////////////////////////////////////////////////////////////////
13725 . ////////////////////////////////////////////////////////////////////////////
13726
13727 .chapter "Starting the daemon and the use of network interfaces" &&&
13728          "CHAPinterfaces" &&&
13729          "Starting the daemon"
13730 .cindex "daemon" "starting"
13731 .cindex "interface" "listening"
13732 .cindex "network interface"
13733 .cindex "interface" "network"
13734 .cindex "IP address" "for listening"
13735 .cindex "daemon" "listening IP addresses"
13736 .cindex "TCP/IP" "setting listening interfaces"
13737 .cindex "TCP/IP" "setting listening ports"
13738 A host that is connected to a TCP/IP network may have one or more physical
13739 hardware network interfaces. Each of these interfaces may be configured as one
13740 or more &"logical"& interfaces, which are the entities that a program actually
13741 works with. Each of these logical interfaces is associated with an IP address.
13742 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13743 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13744 knowledge about the host's interfaces for use in three different circumstances:
13745
13746 .olist
13747 When a listening daemon is started, Exim needs to know which interfaces
13748 and ports to listen on.
13749 .next
13750 When Exim is routing an address, it needs to know which IP addresses
13751 are associated with local interfaces. This is required for the correct
13752 processing of MX lists by removing the local host and others with the
13753 same or higher priority values. Also, Exim needs to detect cases
13754 when an address is routed to an IP address that in fact belongs to the
13755 local host. Unless the &%self%& router option or the &%allow_localhost%&
13756 option of the smtp transport is set (as appropriate), this is treated
13757 as an error situation.
13758 .next
13759 When Exim connects to a remote host, it may need to know which interface to use
13760 for the outgoing connection.
13761 .endlist
13762
13763
13764 Exim's default behaviour is likely to be appropriate in the vast majority
13765 of cases. If your host has only one interface, and you want all its IP
13766 addresses to be treated in the same way, and you are using only the
13767 standard SMTP port, you should not need to take any special action. The
13768 rest of this chapter does not apply to you.
13769
13770 In a more complicated situation you may want to listen only on certain
13771 interfaces, or on different ports, and for this reason there are a number of
13772 options that can be used to influence Exim's behaviour. The rest of this
13773 chapter describes how they operate.
13774
13775 When a message is received over TCP/IP, the interface and port that were
13776 actually used are set in &$received_ip_address$& and &$received_port$&.
13777
13778
13779
13780 .section "Starting a listening daemon" "SECID89"
13781 When a listening daemon is started (by means of the &%-bd%& command line
13782 option), the interfaces and ports on which it listens are controlled by the
13783 following options:
13784
13785 .ilist
13786 &%daemon_smtp_ports%& contains a list of default ports
13787 or service names.
13788 (For backward compatibility, this option can also be specified in the singular.)
13789 .next
13790 &%local_interfaces%& contains list of interface IP addresses on which to
13791 listen. Each item may optionally also specify a port.
13792 .endlist
13793
13794 The default list separator in both cases is a colon, but this can be changed as
13795 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13796 it is usually best to change the separator to avoid having to double all the
13797 colons. For example:
13798 .code
13799 local_interfaces = <; 127.0.0.1 ; \
13800                       192.168.23.65 ; \
13801                       ::1 ; \
13802                       3ffe:ffff:836f::fe86:a061
13803 .endd
13804 There are two different formats for specifying a port along with an IP address
13805 in &%local_interfaces%&:
13806
13807 .olist
13808 The port is added onto the address with a dot separator. For example, to listen
13809 on port 1234 on two different IP addresses:
13810 .code
13811 local_interfaces = <; 192.168.23.65.1234 ; \
13812                       3ffe:ffff:836f::fe86:a061.1234
13813 .endd
13814 .next
13815 The IP address is enclosed in square brackets, and the port is added
13816 with a colon separator, for example:
13817 .code
13818 local_interfaces = <; [192.168.23.65]:1234 ; \
13819                       [3ffe:ffff:836f::fe86:a061]:1234
13820 .endd
13821 .endlist
13822
13823 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13824 default setting contains just one port:
13825 .code
13826 daemon_smtp_ports = smtp
13827 .endd
13828 If more than one port is listed, each interface that does not have its own port
13829 specified listens on all of them. Ports that are listed in
13830 &%daemon_smtp_ports%& can be identified either by name (defined in
13831 &_/etc/services_&) or by number. However, when ports are given with individual
13832 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13833
13834
13835
13836 .section "Special IP listening addresses" "SECID90"
13837 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13838 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13839 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13840 instead of setting up separate listening sockets for each interface. The
13841 default value of &%local_interfaces%& is
13842 .code
13843 local_interfaces = 0.0.0.0
13844 .endd
13845 when Exim is built without IPv6 support; otherwise it is:
13846 .code
13847 local_interfaces = <; ::0 ; 0.0.0.0
13848 .endd
13849 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13850
13851
13852
13853 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13854 The &%-oX%& command line option can be used to override the values of
13855 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13856 instance. Another way of doing this would be to use macros and the &%-D%&
13857 option. However, &%-oX%& can be used by any admin user, whereas modification of
13858 the runtime configuration by &%-D%& is allowed only when the caller is root or
13859 exim.
13860
13861 The value of &%-oX%& is a list of items. The default colon separator can be
13862 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13863 If there are any items that do not
13864 contain dots or colons (that is, are not IP addresses), the value of
13865 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13866 items that do contain dots or colons, the value of &%local_interfaces%& is
13867 replaced by those items. Thus, for example,
13868 .code
13869 -oX 1225
13870 .endd
13871 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13872 whereas
13873 .code
13874 -oX 192.168.34.5.1125
13875 .endd
13876 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13877 (However, since &%local_interfaces%& now contains no items without ports, the
13878 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13879
13880
13881
13882 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13883 .cindex "submissions protocol"
13884 .cindex "ssmtp protocol"
13885 .cindex "smtps protocol"
13886 .cindex "SMTP" "ssmtp protocol"
13887 .cindex "SMTP" "smtps protocol"
13888 Exim supports the use of TLS-on-connect, used by mail clients in the
13889 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13890 For some years, IETF Standards Track documents only blessed the
13891 STARTTLS-based Submission service (port 587) while common practice was to support
13892 the same feature set on port 465, but using TLS-on-connect.
13893 If your installation needs to provide service to mail clients
13894 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13895 the 465 TCP ports.
13896
13897 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13898 service names, connections to those ports must first establish TLS, before
13899 proceeding to the application layer use of the SMTP protocol.
13900
13901 The common use of this option is expected to be
13902 .code
13903 tls_on_connect_ports = 465
13904 .endd
13905 per RFC 8314.
13906 There is also a command line option &%-tls-on-connect%&, which forces all ports
13907 to behave in this way when a daemon is started.
13908
13909 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13910 daemon to listen on those ports. You must still specify them in
13911 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13912 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13913 connections via the daemon.)
13914
13915
13916
13917
13918 .section "IPv6 address scopes" "SECID92"
13919 .cindex "IPv6" "address scopes"
13920 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13921 can, in principle, have the same link-local IPv6 address on different
13922 interfaces. Thus, additional information is needed, over and above the IP
13923 address, to distinguish individual interfaces. A convention of using a
13924 percent sign followed by something (often the interface name) has been
13925 adopted in some cases, leading to addresses like this:
13926 .code
13927 fe80::202:b3ff:fe03:45c1%eth0
13928 .endd
13929 To accommodate this usage, a percent sign followed by an arbitrary string is
13930 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13931 to convert a textual IPv6 address for actual use. This function recognizes the
13932 percent convention in operating systems that support it, and it processes the
13933 address appropriately. Unfortunately, some older libraries have problems with
13934 &[getaddrinfo()]&. If
13935 .code
13936 IPV6_USE_INET_PTON=yes
13937 .endd
13938 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13939 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13940 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13941 function.) Of course, this means that the additional functionality of
13942 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13943
13944 .section "Disabling IPv6" "SECID93"
13945 .cindex "IPv6" "disabling"
13946 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13947 run on a host whose kernel does not support IPv6. The binary will fall back to
13948 using IPv4, but it may waste resources looking up AAAA records, and trying to
13949 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13950 .oindex "&%disable_ipv6%&"
13951 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13952 activities take place. AAAA records are never looked up, and any IPv6 addresses
13953 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13954 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13955 to handle IPv6 literal addresses.
13956
13957 On the other hand, when IPv6 is in use, there may be times when you want to
13958 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13959 option to globally suppress the lookup of AAAA records for specified domains,
13960 and you can use the &%ignore_target_hosts%& generic router option to ignore
13961 IPv6 addresses in an individual router.
13962
13963
13964
13965 .section "Examples of starting a listening daemon" "SECID94"
13966 The default case in an IPv6 environment is
13967 .code
13968 daemon_smtp_ports = smtp
13969 local_interfaces = <; ::0 ; 0.0.0.0
13970 .endd
13971 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13972 Either one or two sockets may be used, depending on the characteristics of
13973 the TCP/IP stack. (This is complicated and messy; for more information,
13974 read the comments in the &_daemon.c_& source file.)
13975
13976 To specify listening on ports 25 and 26 on all interfaces:
13977 .code
13978 daemon_smtp_ports = 25 : 26
13979 .endd
13980 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13981 .code
13982 local_interfaces = <; ::0.25     ; ::0.26 \
13983                       0.0.0.0.25 ; 0.0.0.0.26
13984 .endd
13985 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13986 IPv4 loopback address only:
13987 .code
13988 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13989 .endd
13990 To specify listening on the default port on specific interfaces only:
13991 .code
13992 local_interfaces = 10.0.0.67 : 192.168.34.67
13993 .endd
13994 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13995
13996
13997
13998 .section "Recognizing the local host" "SECTreclocipadd"
13999 The &%local_interfaces%& option is also used when Exim needs to determine
14000 whether or not an IP address refers to the local host. That is, the IP
14001 addresses of all the interfaces on which a daemon is listening are always
14002 treated as local.
14003
14004 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14005 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14006 available interfaces from the operating system, and extracts the relevant
14007 (that is, IPv4 or IPv6) addresses to use for checking.
14008
14009 Some systems set up large numbers of virtual interfaces in order to provide
14010 many virtual web servers. In this situation, you may want to listen for
14011 email on only a few of the available interfaces, but nevertheless treat all
14012 interfaces as local when routing. You can do this by setting
14013 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14014 &"all"& wildcard values. These addresses are recognized as local, but are not
14015 used for listening. Consider this example:
14016 .code
14017 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14018                       192.168.53.235 ; \
14019                       3ffe:2101:12:1:a00:20ff:fe86:a061
14020
14021 extra_local_interfaces = <; ::0 ; 0.0.0.0
14022 .endd
14023 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14024 address, but all available interface addresses are treated as local when
14025 Exim is routing.
14026
14027 In some environments the local host name may be in an MX list, but with an IP
14028 address that is not assigned to any local interface. In other cases it may be
14029 desirable to treat other host names as if they referred to the local host. Both
14030 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14031 This contains host names rather than IP addresses. When a host is referenced
14032 during routing, either via an MX record or directly, it is treated as the local
14033 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14034 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14035
14036
14037
14038 .section "Delivering to a remote host" "SECID95"
14039 Delivery to a remote host is handled by the smtp transport. By default, it
14040 allows the system's TCP/IP functions to choose which interface to use (if
14041 there is more than one) when connecting to a remote host. However, the
14042 &%interface%& option can be set to specify which interface is used. See the
14043 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14044 details.
14045
14046
14047
14048
14049 . ////////////////////////////////////////////////////////////////////////////
14050 . ////////////////////////////////////////////////////////////////////////////
14051
14052 .chapter "Main configuration" "CHAPmainconfig"
14053 .scindex IIDconfima "configuration file" "main section"
14054 .scindex IIDmaiconf "main configuration"
14055 The first part of the runtime configuration file contains three types of item:
14056
14057 .ilist
14058 Macro definitions: These lines start with an upper case letter. See section
14059 &<<SECTmacrodefs>>& for details of macro processing.
14060 .next
14061 Named list definitions: These lines start with one of the words &"domainlist"&,
14062 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14063 section &<<SECTnamedlists>>&.
14064 .next
14065 Main configuration settings: Each setting occupies one line of the file
14066 (with possible continuations). If any setting is preceded by the word
14067 &"hide"&, the &%-bP%& command line option displays its value to admin users
14068 only. See section &<<SECTcos>>& for a description of the syntax of these option
14069 settings.
14070 .endlist
14071
14072 This chapter specifies all the main configuration options, along with their
14073 types and default values. For ease of finding a particular option, they appear
14074 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14075 are now so many options, they are first listed briefly in functional groups, as
14076 an aid to finding the name of the option you are looking for. Some options are
14077 listed in more than one group.
14078
14079 .section "Miscellaneous" "SECID96"
14080 .table2
14081 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14082 .row &%debug_store%&                 "do extra internal checks"
14083 .row &%disable_ipv6%&                "do no IPv6 processing"
14084 .row &%keep_malformed%&              "for broken files &-- should not happen"
14085 .row &%localhost_number%&            "for unique message ids in clusters"
14086 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14087 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14088 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14089 .row &%print_topbitchars%&           "top-bit characters are printing"
14090 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14091 .row &%timezone%&                    "force time zone"
14092 .endtable
14093
14094
14095 .section "Exim parameters" "SECID97"
14096 .table2
14097 .row &%exim_group%&                  "override compiled-in value"
14098 .row &%exim_path%&                   "override compiled-in value"
14099 .row &%exim_user%&                   "override compiled-in value"
14100 .row &%primary_hostname%&            "default from &[uname()]&"
14101 .row &%split_spool_directory%&       "use multiple directories"
14102 .row &%spool_directory%&             "override compiled-in value"
14103 .endtable
14104
14105
14106
14107 .section "Privilege controls" "SECID98"
14108 .table2
14109 .row &%admin_groups%&                "groups that are Exim admin users"
14110 .row &%commandline_checks_require_admin%& "require admin for various checks"
14111 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14112 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14113 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14114 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14115 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14116 .row &%never_users%&                 "do not run deliveries as these"
14117 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14118 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14119 .row &%trusted_groups%&              "groups that are trusted"
14120 .row &%trusted_users%&               "users that are trusted"
14121 .endtable
14122
14123
14124
14125 .section "Logging" "SECID99"
14126 .table2
14127 .row &%event_action%&                "custom logging"
14128 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14129 .row &%log_file_path%&               "override compiled-in value"
14130 .row &%log_selector%&                "set/unset optional logging"
14131 .row &%log_timezone%&                "add timezone to log lines"
14132 .row &%message_logs%&                "create per-message logs"
14133 .row &%preserve_message_logs%&       "after message completion"
14134 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14135 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14136 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14137 .row &%syslog_facility%&             "set syslog &""facility""& field"
14138 .row &%syslog_pid%&                  "pid in syslog lines"
14139 .row &%syslog_processname%&          "set syslog &""ident""& field"
14140 .row &%syslog_timestamp%&            "timestamp syslog lines"
14141 .row &%write_rejectlog%&             "control use of message log"
14142 .endtable
14143
14144
14145
14146 .section "Frozen messages" "SECID100"
14147 .table2
14148 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14149 .row &%freeze_tell%&                 "send message when freezing"
14150 .row &%move_frozen_messages%&        "to another directory"
14151 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14152 .endtable
14153
14154
14155
14156 .section "Data lookups" "SECID101"
14157 .table2
14158 .row &%ibase_servers%&               "InterBase servers"
14159 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14160 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14161 .row &%ldap_cert_file%&              "client cert file for LDAP"
14162 .row &%ldap_cert_key%&               "client key file for LDAP"
14163 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14164 .row &%ldap_default_servers%&        "used if no server in query"
14165 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14166 .row &%ldap_start_tls%&              "require TLS within LDAP"
14167 .row &%ldap_version%&                "set protocol version"
14168 .row &%lookup_open_max%&             "lookup files held open"
14169 .row &%mysql_servers%&               "default MySQL servers"
14170 .row &%oracle_servers%&              "Oracle servers"
14171 .row &%pgsql_servers%&               "default PostgreSQL servers"
14172 .row &%sqlite_lock_timeout%&         "as it says"
14173 .endtable
14174
14175
14176
14177 .section "Message ids" "SECID102"
14178 .table2
14179 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14180 .row &%message_id_header_text%&      "ditto"
14181 .endtable
14182
14183
14184
14185 .section "Embedded Perl Startup" "SECID103"
14186 .table2
14187 .row &%perl_at_start%&               "always start the interpreter"
14188 .row &%perl_startup%&                "code to obey when starting Perl"
14189 .row &%perl_taintmode%&              "enable taint mode in Perl"
14190 .endtable
14191
14192
14193
14194 .section "Daemon" "SECID104"
14195 .table2
14196 .row &%daemon_smtp_ports%&           "default ports"
14197 .row &%daemon_startup_retries%&      "number of times to retry"
14198 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14199 .row &%extra_local_interfaces%&      "not necessarily listened on"
14200 .row &%local_interfaces%&            "on which to listen, with optional ports"
14201 .row &%pid_file_path%&               "override compiled-in value"
14202 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14203 .endtable
14204
14205
14206
14207 .section "Resource control" "SECID105"
14208 .table2
14209 .row &%check_log_inodes%&            "before accepting a message"
14210 .row &%check_log_space%&             "before accepting a message"
14211 .row &%check_spool_inodes%&          "before accepting a message"
14212 .row &%check_spool_space%&           "before accepting a message"
14213 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14214 .row &%queue_only_load%&             "queue incoming if load high"
14215 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14216 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14217 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14218 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14219 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14220 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14221 .row &%smtp_accept_max_per_connection%& "messages per connection"
14222 .row &%smtp_accept_max_per_host%&    "connections from one host"
14223 .row &%smtp_accept_queue%&           "queue mail if more connections"
14224 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14225                                            connection"
14226 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14227 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14228 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14229 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14230 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14231 .endtable
14232
14233
14234
14235 .section "Policy controls" "SECID106"
14236 .table2
14237 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14238 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14239 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14240 .row &%acl_smtp_auth%&               "ACL for AUTH"
14241 .row &%acl_smtp_connect%&            "ACL for connection"
14242 .row &%acl_smtp_data%&               "ACL for DATA"
14243 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14244 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14245 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14246 .row &%acl_smtp_expn%&               "ACL for EXPN"
14247 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14248 .row &%acl_smtp_mail%&               "ACL for MAIL"
14249 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14250 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14251 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14252 .row &%acl_smtp_predata%&            "ACL for start of data"
14253 .row &%acl_smtp_quit%&               "ACL for QUIT"
14254 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14255 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14256 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14257 .row &%av_scanner%&                  "specify virus scanner"
14258 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14259                                       words""&"
14260 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14261 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14262 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14263 .row &%header_maxsize%&              "total size of message header"
14264 .row &%header_line_maxsize%&         "individual header line limit"
14265 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14266 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14267 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14268 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14269 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14270 .row &%host_lookup%&                 "host name looked up for these hosts"
14271 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14272 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14273 .row &%host_reject_connection%&      "reject connection from these hosts"
14274 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14275 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14276 .row &%message_size_limit%&          "for all messages"
14277 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14278 .row &%spamd_address%&               "set interface to SpamAssassin"
14279 .row &%strict_acl_vars%&             "object to unset ACL variables"
14280 .endtable
14281
14282
14283
14284 .section "Callout cache" "SECID107"
14285 .table2
14286 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14287                                          item"
14288 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14289                                          item"
14290 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14291 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14292 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14293 .endtable
14294
14295
14296
14297 .section "TLS" "SECID108"
14298 .table2
14299 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14300 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14301 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14302 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14303 .row &%tls_certificate%&             "location of server certificate"
14304 .row &%tls_crl%&                     "certificate revocation list"
14305 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14306 .row &%tls_dhparam%&                 "DH parameters for server"
14307 .row &%tls_eccurve%&                 "EC curve selection for server"
14308 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14309 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14310 .row &%tls_privatekey%&              "location of server private key"
14311 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14312 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14313 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14314 .row &%tls_verify_certificates%&     "expected client certificates"
14315 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14316 .endtable
14317
14318
14319
14320 .section "Local user handling" "SECID109"
14321 .table2
14322 .row &%finduser_retries%&            "useful in NIS environments"
14323 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14324 .row &%gecos_pattern%&               "ditto"
14325 .row &%max_username_length%&         "for systems that truncate"
14326 .row &%unknown_login%&               "used when no login name found"
14327 .row &%unknown_username%&            "ditto"
14328 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14329 .row &%uucp_from_sender%&            "ditto"
14330 .endtable
14331
14332
14333
14334 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14335 .table2
14336 .row &%header_maxsize%&              "total size of message header"
14337 .row &%header_line_maxsize%&         "individual header line limit"
14338 .row &%message_size_limit%&          "applies to all messages"
14339 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14340 .row &%received_header_text%&        "expanded to make &'Received:'&"
14341 .row &%received_headers_max%&        "for mail loop detection"
14342 .row &%recipients_max%&              "limit per message"
14343 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14344 .endtable
14345
14346
14347
14348
14349 .section "Non-SMTP incoming messages" "SECID111"
14350 .table2
14351 .row &%receive_timeout%&             "for non-SMTP messages"
14352 .endtable
14353
14354
14355
14356
14357
14358 .section "Incoming SMTP messages" "SECID112"
14359 See also the &'Policy controls'& section above.
14360
14361 .table2
14362 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14363 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14364 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14365 .row &%host_lookup%&                 "host name looked up for these hosts"
14366 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14367 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14368 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14369 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14370 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14371 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14372 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14373 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14374 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14375 .row &%smtp_accept_max_per_connection%& "messages per connection"
14376 .row &%smtp_accept_max_per_host%&    "connections from one host"
14377 .row &%smtp_accept_queue%&           "queue mail if more connections"
14378 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14379                                            connection"
14380 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14381 .row &%smtp_active_hostname%&        "host name to use in messages"
14382 .row &%smtp_banner%&                 "text for welcome banner"
14383 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14384 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14385 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14386 .row &%smtp_etrn_command%&           "what to run for ETRN"
14387 .row &%smtp_etrn_serialize%&         "only one at once"
14388 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14389 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14390 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14391 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14392 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14393 .row &%smtp_receive_timeout%&        "per command or data line"
14394 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14395 .row &%smtp_return_error_details%&   "give detail on rejections"
14396 .endtable
14397
14398
14399
14400 .section "SMTP extensions" "SECID113"
14401 .table2
14402 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14403 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14404 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14405 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14406 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14407 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14408 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14409 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14410 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14411 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14412 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14413 .endtable
14414
14415
14416
14417 .section "Processing messages" "SECID114"
14418 .table2
14419 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14420 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14421 .row &%allow_utf8_domains%&          "in addresses"
14422 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14423                                       words""&"
14424 .row &%delivery_date_remove%&        "from incoming messages"
14425 .row &%envelope_to_remove%&          "from incoming messages"
14426 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14427 .row &%headers_charset%&             "default for translations"
14428 .row &%qualify_domain%&              "default for senders"
14429 .row &%qualify_recipient%&           "default for recipients"
14430 .row &%return_path_remove%&          "from incoming messages"
14431 .row &%strip_excess_angle_brackets%& "in addresses"
14432 .row &%strip_trailing_dot%&          "at end of addresses"
14433 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14434 .endtable
14435
14436
14437
14438 .section "System filter" "SECID115"
14439 .table2
14440 .row &%system_filter%&               "locate system filter"
14441 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14442                                             directory"
14443 .row &%system_filter_file_transport%& "transport for delivery to a file"
14444 .row &%system_filter_group%&         "group for filter running"
14445 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14446 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14447 .row &%system_filter_user%&          "user for filter running"
14448 .endtable
14449
14450
14451
14452 .section "Routing and delivery" "SECID116"
14453 .table2
14454 .row &%disable_ipv6%&                "do no IPv6 processing"
14455 .row &%dns_again_means_nonexist%&    "for broken domains"
14456 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14457 .row &%dns_dnssec_ok%&               "parameter for resolver"
14458 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14459 .row &%dns_retrans%&                 "parameter for resolver"
14460 .row &%dns_retry%&                   "parameter for resolver"
14461 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14462 .row &%dns_use_edns0%&               "parameter for resolver"
14463 .row &%hold_domains%&                "hold delivery for these domains"
14464 .row &%local_interfaces%&            "for routing checks"
14465 .row &%queue_domains%&               "no immediate delivery for these"
14466 .row &%queue_only%&                  "no immediate delivery at all"
14467 .row &%queue_only_file%&             "no immediate delivery if file exists"
14468 .row &%queue_only_load%&             "no immediate delivery if load is high"
14469 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14470 .row &%queue_only_override%&         "allow command line to override"
14471 .row &%queue_run_in_order%&          "order of arrival"
14472 .row &%queue_run_max%&               "of simultaneous queue runners"
14473 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14474 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14475 .row &%remote_sort_domains%&         "order of remote deliveries"
14476 .row &%retry_data_expire%&           "timeout for retry data"
14477 .row &%retry_interval_max%&          "safety net for retry rules"
14478 .endtable
14479
14480
14481
14482 .section "Bounce and warning messages" "SECID117"
14483 .table2
14484 .row &%bounce_message_file%&         "content of bounce"
14485 .row &%bounce_message_text%&         "content of bounce"
14486 .row &%bounce_return_body%&          "include body if returning message"
14487 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14488 .row &%bounce_return_message%&       "include original message in bounce"
14489 .row &%bounce_return_size_limit%&    "limit on returned message"
14490 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14491 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14492 .row &%errors_copy%&                 "copy bounce messages"
14493 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14494 .row &%delay_warning%&               "time schedule"
14495 .row &%delay_warning_condition%&     "condition for warning messages"
14496 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14497 .row &%smtp_return_error_details%&   "give detail on rejections"
14498 .row &%warn_message_file%&           "content of warning message"
14499 .endtable
14500
14501
14502
14503 .section "Alphabetical list of main options" "SECTalomo"
14504 Those options that undergo string expansion before use are marked with
14505 &dagger;.
14506
14507 .option accept_8bitmime main boolean true
14508 .cindex "8BITMIME"
14509 .cindex "8-bit characters"
14510 .cindex "log" "selectors"
14511 .cindex "log" "8BITMIME"
14512 This option causes Exim to send 8BITMIME in its response to an SMTP
14513 EHLO command, and to accept the BODY= parameter on MAIL commands.
14514 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14515 takes no steps to do anything special with messages received by this route.
14516
14517 Historically Exim kept this option off by default, but the maintainers
14518 feel that in today's Internet, this causes more problems than it solves.
14519 It now defaults to true.
14520 A more detailed analysis of the issues is provided by Dan Bernstein:
14521 .display
14522 &url(https://cr.yp.to/smtp/8bitmime.html)
14523 .endd
14524
14525 To log received 8BITMIME status use
14526 .code
14527 log_selector = +8bitmime
14528 .endd
14529
14530 .option acl_not_smtp main string&!! unset
14531 .cindex "&ACL;" "for non-SMTP messages"
14532 .cindex "non-SMTP messages" "ACLs for"
14533 This option defines the ACL that is run when a non-SMTP message has been
14534 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14535 further details.
14536
14537 .option acl_not_smtp_mime main string&!! unset
14538 This option defines the ACL that is run for individual MIME parts of non-SMTP
14539 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14540 SMTP messages.
14541
14542 .option acl_not_smtp_start main string&!! unset
14543 .cindex "&ACL;" "at start of non-SMTP message"
14544 .cindex "non-SMTP messages" "ACLs for"
14545 This option defines the ACL that is run before Exim starts reading a
14546 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14547
14548 .option acl_smtp_auth main string&!! unset
14549 .cindex "&ACL;" "setting up for SMTP commands"
14550 .cindex "AUTH" "ACL for"
14551 This option defines the ACL that is run when an SMTP AUTH command is
14552 received. See chapter &<<CHAPACL>>& for further details.
14553
14554 .option acl_smtp_connect main string&!! unset
14555 .cindex "&ACL;" "on SMTP connection"
14556 This option defines the ACL that is run when an SMTP connection is received.
14557 See chapter &<<CHAPACL>>& for further details.
14558
14559 .option acl_smtp_data main string&!! unset
14560 .cindex "DATA" "ACL for"
14561 This option defines the ACL that is run after an SMTP DATA command has been
14562 processed and the message itself has been received, but before the final
14563 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14564
14565 .option acl_smtp_data_prdr main string&!! accept
14566 .cindex "PRDR" "ACL for"
14567 .cindex "DATA" "PRDR ACL for"
14568 .cindex "&ACL;" "PRDR-related"
14569 .cindex "&ACL;" "per-user data processing"
14570 This option defines the ACL that,
14571 if the PRDR feature has been negotiated,
14572 is run for each recipient after an SMTP DATA command has been
14573 processed and the message itself has been received, but before the
14574 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14575
14576 .option acl_smtp_dkim main string&!! unset
14577 .cindex DKIM "ACL for"
14578 This option defines the ACL that is run for each DKIM signature
14579 (by default, or as specified in the dkim_verify_signers option)
14580 of a received message.
14581 See section &<<SECDKIMVFY>>& for further details.
14582
14583 .option acl_smtp_etrn main string&!! unset
14584 .cindex "ETRN" "ACL for"
14585 This option defines the ACL that is run when an SMTP ETRN command is
14586 received. See chapter &<<CHAPACL>>& for further details.
14587
14588 .option acl_smtp_expn main string&!! unset
14589 .cindex "EXPN" "ACL for"
14590 This option defines the ACL that is run when an SMTP EXPN command is
14591 received. See chapter &<<CHAPACL>>& for further details.
14592
14593 .option acl_smtp_helo main string&!! unset
14594 .cindex "EHLO" "ACL for"
14595 .cindex "HELO" "ACL for"
14596 This option defines the ACL that is run when an SMTP EHLO or HELO
14597 command is received. See chapter &<<CHAPACL>>& for further details.
14598
14599
14600 .option acl_smtp_mail main string&!! unset
14601 .cindex "MAIL" "ACL for"
14602 This option defines the ACL that is run when an SMTP MAIL command is
14603 received. See chapter &<<CHAPACL>>& for further details.
14604
14605 .option acl_smtp_mailauth main string&!! unset
14606 .cindex "AUTH" "on MAIL command"
14607 This option defines the ACL that is run when there is an AUTH parameter on
14608 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14609 &<<CHAPSMTPAUTH>>& for details of authentication.
14610
14611 .option acl_smtp_mime main string&!! unset
14612 .cindex "MIME content scanning" "ACL for"
14613 This option is available when Exim is built with the content-scanning
14614 extension. It defines the ACL that is run for each MIME part in a message. See
14615 section &<<SECTscanmimepart>>& for details.
14616
14617 .option acl_smtp_notquit main string&!! unset
14618 .cindex "not-QUIT, ACL for"
14619 This option defines the ACL that is run when an SMTP session
14620 ends without a QUIT command being received.
14621 See chapter &<<CHAPACL>>& for further details.
14622
14623 .option acl_smtp_predata main string&!! unset
14624 This option defines the ACL that is run when an SMTP DATA command is
14625 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14626 further details.
14627
14628 .option acl_smtp_quit main string&!! unset
14629 .cindex "QUIT, ACL for"
14630 This option defines the ACL that is run when an SMTP QUIT command is
14631 received. See chapter &<<CHAPACL>>& for further details.
14632
14633 .option acl_smtp_rcpt main string&!! unset
14634 .cindex "RCPT" "ACL for"
14635 This option defines the ACL that is run when an SMTP RCPT command is
14636 received. See chapter &<<CHAPACL>>& for further details.
14637
14638 .option acl_smtp_starttls main string&!! unset
14639 .cindex "STARTTLS, ACL for"
14640 This option defines the ACL that is run when an SMTP STARTTLS command is
14641 received. See chapter &<<CHAPACL>>& for further details.
14642
14643 .option acl_smtp_vrfy main string&!! unset
14644 .cindex "VRFY" "ACL for"
14645 This option defines the ACL that is run when an SMTP VRFY command is
14646 received. See chapter &<<CHAPACL>>& for further details.
14647
14648 .option add_environment main "string list" empty
14649 .cindex "environment" "set values"
14650 This option allows to set individual environment variables that the
14651 currently linked libraries and programs in child processes use.
14652 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14653
14654 .option admin_groups main "string list&!!" unset
14655 .cindex "admin user"
14656 This option is expanded just once, at the start of Exim's processing. If the
14657 current group or any of the supplementary groups of an Exim caller is in this
14658 colon-separated list, the caller has admin privileges. If all your system
14659 programmers are in a specific group, for example, you can give them all Exim
14660 admin privileges by putting that group in &%admin_groups%&. However, this does
14661 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14662 To permit this, you have to add individuals to the Exim group.
14663
14664 .option allow_domain_literals main boolean false
14665 .cindex "domain literal"
14666 If this option is set, the RFC 2822 domain literal format is permitted in
14667 email addresses. The option is not set by default, because the domain literal
14668 format is not normally required these days, and few people know about it. It
14669 has, however, been exploited by mail abusers.
14670
14671 Unfortunately, it seems that some DNS black list maintainers are using this
14672 format to report black listing to postmasters. If you want to accept messages
14673 addressed to your hosts by IP address, you need to set
14674 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14675 domains (defined in the named domain list &%local_domains%& in the default
14676 configuration). This &"magic string"& matches the domain literal form of all
14677 the local host's IP addresses.
14678
14679
14680 .option allow_mx_to_ip main boolean false
14681 .cindex "MX record" "pointing to IP address"
14682 It appears that more and more DNS zone administrators are breaking the rules
14683 and putting domain names that look like IP addresses on the right hand side of
14684 MX records. Exim follows the rules and rejects this, giving an error message
14685 that explains the misconfiguration. However, some other MTAs support this
14686 practice, so to avoid &"Why can't Exim do this?"& complaints,
14687 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14688 recommended, except when you have no other choice.
14689
14690 .option allow_utf8_domains main boolean false
14691 .cindex "domain" "UTF-8 characters in"
14692 .cindex "UTF-8" "in domain name"
14693 Lots of discussion is going on about internationalized domain names. One
14694 camp is strongly in favour of just using UTF-8 characters, and it seems
14695 that at least two other MTAs permit this.
14696 This option allows Exim users to experiment if they wish.
14697
14698 If it is set true, Exim's domain parsing function allows valid
14699 UTF-8 multicharacters to appear in domain name components, in addition to
14700 letters, digits, and hyphens.
14701
14702 .new
14703 If Exim is built with internationalization support
14704 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14705 this option can be left as default.
14706 .wen
14707 Without that,
14708 if you want to look up such domain names in the DNS, you must also
14709 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14710 suitable setting is:
14711 .code
14712 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14713   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14714 .endd
14715 Alternatively, you can just disable this feature by setting
14716 .code
14717 dns_check_names_pattern =
14718 .endd
14719 That is, set the option to an empty string so that no check is done.
14720
14721
14722 .option auth_advertise_hosts main "host list&!!" *
14723 .cindex "authentication" "advertising"
14724 .cindex "AUTH" "advertising"
14725 If any server authentication mechanisms are configured, Exim advertises them in
14726 response to an EHLO command only if the calling host matches this list.
14727 Otherwise, Exim does not advertise AUTH.
14728 Exim does not accept AUTH commands from clients to which it has not
14729 advertised the availability of AUTH. The advertising of individual
14730 authentication mechanisms can be controlled by the use of the
14731 &%server_advertise_condition%& generic authenticator option on the individual
14732 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14733
14734 Certain mail clients (for example, Netscape) require the user to provide a name
14735 and password for authentication if AUTH is advertised, even though it may
14736 not be needed (the host may accept messages from hosts on its local LAN without
14737 authentication, for example). The &%auth_advertise_hosts%& option can be used
14738 to make these clients more friendly by excluding them from the set of hosts to
14739 which Exim advertises AUTH.
14740
14741 .cindex "AUTH" "advertising when encrypted"
14742 If you want to advertise the availability of AUTH only when the connection
14743 is encrypted using TLS, you can make use of the fact that the value of this
14744 option is expanded, with a setting like this:
14745 .code
14746 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14747 .endd
14748 .vindex "&$tls_in_cipher$&"
14749 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14750 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14751 expansion is *, which matches all hosts.
14752
14753
14754 .option auto_thaw main time 0s
14755 .cindex "thawing messages"
14756 .cindex "unfreezing messages"
14757 If this option is set to a time greater than zero, a queue runner will try a
14758 new delivery attempt on any frozen message, other than a bounce message, if
14759 this much time has passed since it was frozen. This may result in the message
14760 being re-frozen if nothing has changed since the last attempt. It is a way of
14761 saying &"keep on trying, even though there are big problems"&.
14762
14763 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14764 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14765 thought to be very useful any more, and its use should probably be avoided.
14766
14767
14768 .option av_scanner main string "see below"
14769 This option is available if Exim is built with the content-scanning extension.
14770 It specifies which anti-virus scanner to use. The default value is:
14771 .code
14772 sophie:/var/run/sophie
14773 .endd
14774 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14775 before use. See section &<<SECTscanvirus>>& for further details.
14776
14777
14778 .option bi_command main string unset
14779 .oindex "&%-bi%&"
14780 This option supplies the name of a command that is run when Exim is called with
14781 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14782 just the command name, it is not a complete command line. If an argument is
14783 required, it must come from the &%-oA%& command line option.
14784
14785
14786 .option bounce_message_file main string unset
14787 .cindex "bounce message" "customizing"
14788 .cindex "customizing" "bounce message"
14789 This option defines a template file containing paragraphs of text to be used
14790 for constructing bounce messages.  Details of the file's contents are given in
14791 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14792
14793
14794 .option bounce_message_text main string unset
14795 When this option is set, its contents are included in the default bounce
14796 message immediately after &"This message was created automatically by mail
14797 delivery software."& It is not used if &%bounce_message_file%& is set.
14798
14799 .option bounce_return_body main boolean true
14800 .cindex "bounce message" "including body"
14801 This option controls whether the body of an incoming message is included in a
14802 bounce message when &%bounce_return_message%& is true. The default setting
14803 causes the entire message, both header and body, to be returned (subject to the
14804 value of &%bounce_return_size_limit%&). If this option is false, only the
14805 message header is included. In the case of a non-SMTP message containing an
14806 error that is detected during reception, only those header lines preceding the
14807 point at which the error was detected are returned.
14808 .cindex "bounce message" "including original"
14809
14810 .option bounce_return_linesize_limit main integer 998
14811 .cindex "size" "of bounce lines, limit"
14812 .cindex "bounce message" "line length limit"
14813 .cindex "limit" "bounce message line length"
14814 This option sets a limit in bytes on the line length of messages
14815 that are returned to senders due to delivery problems,
14816 when &%bounce_return_message%& is true.
14817 The default value corresponds to RFC limits.
14818 If the message being returned has lines longer than this value it is
14819 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14820
14821 The option also applies to bounces returned when an error is detected
14822 during reception of a message.
14823 In this case lines from the original are truncated.
14824
14825 The option does not apply to messages generated by an &(autoreply)& transport.
14826
14827
14828 .option bounce_return_message main boolean true
14829 If this option is set false, none of the original message is included in
14830 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14831 &%bounce_return_body%&.
14832
14833
14834 .option bounce_return_size_limit main integer 100K
14835 .cindex "size" "of bounce, limit"
14836 .cindex "bounce message" "size limit"
14837 .cindex "limit" "bounce message size"
14838 This option sets a limit in bytes on the size of messages that are returned to
14839 senders as part of bounce messages when &%bounce_return_message%& is true. The
14840 limit should be less than the value of the global &%message_size_limit%& and of
14841 any &%message_size_limit%& settings on transports, to allow for the bounce text
14842 that Exim generates. If this option is set to zero there is no limit.
14843
14844 When the body of any message that is to be included in a bounce message is
14845 greater than the limit, it is truncated, and a comment pointing this out is
14846 added at the top. The actual cutoff may be greater than the value given, owing
14847 to the use of buffering for transferring the message in chunks (typically 8K in
14848 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14849 messages.
14850
14851 .option bounce_sender_authentication main string unset
14852 .cindex "bounce message" "sender authentication"
14853 .cindex "authentication" "bounce message"
14854 .cindex "AUTH" "on bounce message"
14855 This option provides an authenticated sender address that is sent with any
14856 bounce messages generated by Exim that are sent over an authenticated SMTP
14857 connection. A typical setting might be:
14858 .code
14859 bounce_sender_authentication = mailer-daemon@my.domain.example
14860 .endd
14861 which would cause bounce messages to be sent using the SMTP command:
14862 .code
14863 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14864 .endd
14865 The value of &%bounce_sender_authentication%& must always be a complete email
14866 address.
14867
14868 .option callout_domain_negative_expire main time 3h
14869 .cindex "caching" "callout timeouts"
14870 .cindex "callout" "caching timeouts"
14871 This option specifies the expiry time for negative callout cache data for a
14872 domain. See section &<<SECTcallver>>& for details of callout verification, and
14873 section &<<SECTcallvercache>>& for details of the caching.
14874
14875
14876 .option callout_domain_positive_expire main time 7d
14877 This option specifies the expiry time for positive callout cache data for a
14878 domain. See section &<<SECTcallver>>& for details of callout verification, and
14879 section &<<SECTcallvercache>>& for details of the caching.
14880
14881
14882 .option callout_negative_expire main time 2h
14883 This option specifies the expiry time for negative callout cache data for an
14884 address. See section &<<SECTcallver>>& for details of callout verification, and
14885 section &<<SECTcallvercache>>& for details of the caching.
14886
14887
14888 .option callout_positive_expire main time 24h
14889 This option specifies the expiry time for positive callout cache data for an
14890 address. See section &<<SECTcallver>>& for details of callout verification, and
14891 section &<<SECTcallvercache>>& for details of the caching.
14892
14893
14894 .option callout_random_local_part main string&!! "see below"
14895 This option defines the &"random"& local part that can be used as part of
14896 callout verification. The default value is
14897 .code
14898 $primary_hostname-$tod_epoch-testing
14899 .endd
14900 See section &<<CALLaddparcall>>& for details of how this value is used.
14901
14902
14903 .option check_log_inodes main integer 100
14904 See &%check_spool_space%& below.
14905
14906
14907 .option check_log_space main integer 10M
14908 See &%check_spool_space%& below.
14909
14910 .oindex "&%check_rfc2047_length%&"
14911 .cindex "RFC 2047" "disabling length check"
14912 .option check_rfc2047_length main boolean true
14913 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14914 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14915 word; strings to be encoded that exceed this length are supposed to use
14916 multiple encoded words. By default, Exim does not recognize encoded words that
14917 exceed the maximum length. However, it seems that some software, in violation
14918 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14919 set false, Exim recognizes encoded words of any length.
14920
14921
14922 .option check_spool_inodes main integer 100
14923 See &%check_spool_space%& below.
14924
14925
14926 .option check_spool_space main integer 10M
14927 .cindex "checking disk space"
14928 .cindex "disk space, checking"
14929 .cindex "spool directory" "checking space"
14930 The four &%check_...%& options allow for checking of disk resources before a
14931 message is accepted.
14932
14933 .vindex "&$log_inodes$&"
14934 .vindex "&$log_space$&"
14935 .vindex "&$spool_inodes$&"
14936 .vindex "&$spool_space$&"
14937 When any of these options are nonzero, they apply to all incoming messages. If you
14938 want to apply different checks to different kinds of message, you can do so by
14939 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14940 &$spool_space$& in an ACL with appropriate additional conditions.
14941
14942
14943 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14944 either value is greater than zero, for example:
14945 .code
14946 check_spool_space = 100M
14947 check_spool_inodes = 100
14948 .endd
14949 The spool partition is the one that contains the directory defined by
14950 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14951 transit.
14952
14953 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14954 files are written if either is greater than zero. These should be set only if
14955 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14956
14957 If there is less space or fewer inodes than requested, Exim refuses to accept
14958 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14959 error response to the MAIL command. If ESMTP is in use and there was a
14960 SIZE parameter on the MAIL command, its value is added to the
14961 &%check_spool_space%& value, and the check is performed even if
14962 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14963
14964 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14965 number of kilobytes (though specified in bytes).
14966 If a non-multiple of 1024 is specified, it is rounded up.
14967
14968 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14969 failure a message is written to stderr and Exim exits with a non-zero code, as
14970 it obviously cannot send an error message of any kind.
14971
14972 There is a slight performance penalty for these checks.
14973 Versions of Exim preceding 4.88 had these disabled by default;
14974 high-rate installations confident they will never run out of resources
14975 may wish to deliberately disable them.
14976
14977 .option chunking_advertise_hosts main "host list&!!" *
14978 .cindex CHUNKING advertisement
14979 .cindex "RFC 3030" "CHUNKING"
14980 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14981 these hosts.
14982 Hosts may use the BDAT command as an alternate to DATA.
14983
14984 .option commandline_checks_require_admin main boolean &`false`&
14985 .cindex "restricting access to features"
14986 This option restricts various basic checking features to require an
14987 administrative user.
14988 This affects most of the &%-b*%& options, such as &%-be%&.
14989
14990 .option debug_store main boolean &`false`&
14991 .cindex debugging "memory corruption"
14992 .cindex memory debugging
14993 This option, when true, enables extra checking in Exim's internal memory
14994 management.  For use when a memory corruption issue is being investigated,
14995 it should normally be left as default.
14996
14997 .option daemon_smtp_ports main string &`smtp`&
14998 .cindex "port" "for daemon"
14999 .cindex "TCP/IP" "setting listening ports"
15000 This option specifies one or more default SMTP ports on which the Exim daemon
15001 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15002 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15003
15004 .option daemon_startup_retries main integer 9
15005 .cindex "daemon startup, retrying"
15006 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15007 the daemon at startup when it cannot immediately bind a listening socket
15008 (typically because the socket is already in use): &%daemon_startup_retries%&
15009 defines the number of retries after the first failure, and
15010 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15011
15012 .option daemon_startup_sleep main time 30s
15013 See &%daemon_startup_retries%&.
15014
15015 .option delay_warning main "time list" 24h
15016 .cindex "warning of delay"
15017 .cindex "delay warning, specifying"
15018 .cindex "queue" "delay warning"
15019 When a message is delayed, Exim sends a warning message to the sender at
15020 intervals specified by this option. The data is a colon-separated list of times
15021 after which to send warning messages. If the value of the option is an empty
15022 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15023 message has been in the queue for longer than the last time, the last interval
15024 between the times is used to compute subsequent warning times. For example,
15025 with
15026 .code
15027 delay_warning = 4h:8h:24h
15028 .endd
15029 the first message is sent after 4 hours, the second after 8 hours, and
15030 the third one after 24 hours. After that, messages are sent every 16 hours,
15031 because that is the interval between the last two times on the list. If you set
15032 just one time, it specifies the repeat interval. For example, with:
15033 .code
15034 delay_warning = 6h
15035 .endd
15036 messages are repeated every six hours. To stop warnings after a given time, set
15037 a very large time at the end of the list. For example:
15038 .code
15039 delay_warning = 2h:12h:99d
15040 .endd
15041 Note that the option is only evaluated at the time a delivery attempt fails,
15042 which depends on retry and queue-runner configuration.
15043 Typically retries will be configured more frequently than warning messages.
15044
15045 .option delay_warning_condition main string&!! "see below"
15046 .vindex "&$domain$&"
15047 The string is expanded at the time a warning message might be sent. If all the
15048 deferred addresses have the same domain, it is set in &$domain$& during the
15049 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15050 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15051 &"false"& (the comparison being done caselessly) then the warning message is
15052 not sent. The default is:
15053 .code
15054 delay_warning_condition = ${if or {\
15055   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15056   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15057   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15058   } {no}{yes}}
15059 .endd
15060 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15061 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15062 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15063 &"auto-replied"& in an &'Auto-Submitted:'& header.
15064
15065 .option deliver_drop_privilege main boolean false
15066 .cindex "unprivileged delivery"
15067 .cindex "delivery" "unprivileged"
15068 If this option is set true, Exim drops its root privilege at the start of a
15069 delivery process, and runs as the Exim user throughout. This severely restricts
15070 the kinds of local delivery that are possible, but is viable in certain types
15071 of configuration. There is a discussion about the use of root privilege in
15072 chapter &<<CHAPsecurity>>&.
15073
15074 .option deliver_queue_load_max main fixed-point unset
15075 .cindex "load average"
15076 .cindex "queue runner" "abandoning"
15077 When this option is set, a queue run is abandoned if the system load average
15078 becomes greater than the value of the option. The option has no effect on
15079 ancient operating systems on which Exim cannot determine the load average.
15080 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15081
15082
15083 .option delivery_date_remove main boolean true
15084 .cindex "&'Delivery-date:'& header line"
15085 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15086 message when it is delivered, in exactly the same way as &'Return-path:'& is
15087 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15088 should not be present in incoming messages, and this option causes them to be
15089 removed at the time the message is received, to avoid any problems that might
15090 occur when a delivered message is subsequently sent on to some other recipient.
15091
15092 .option disable_fsync main boolean false
15093 .cindex "&[fsync()]&, disabling"
15094 This option is available only if Exim was built with the compile-time option
15095 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15096 a runtime configuration generates an &"unknown option"& error. You should not
15097 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15098 really, really, really understand what you are doing. &'No pre-compiled
15099 distributions of Exim should ever make this option available.'&
15100
15101 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15102 updated files' data to be written to disc before continuing. Unexpected events
15103 such as crashes and power outages may cause data to be lost or scrambled.
15104 Here be Dragons. &*Beware.*&
15105
15106
15107 .option disable_ipv6 main boolean false
15108 .cindex "IPv6" "disabling"
15109 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15110 activities take place. AAAA records are never looked up, and any IPv6 addresses
15111 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15112 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15113 to handle IPv6 literal addresses.
15114
15115
15116 .new
15117 .option dkim_verify_hashes main "string list" "sha256 : sha512 : sha1"
15118 .cindex DKIM "selecting signature algorithms"
15119 This option gives a list of hash types which are acceptable in signatures,
15120 and an order of processing.
15121 Signatures with algorithms not in the list will be ignored.
15122
15123 Note that the presence of sha1 violates RFC 8301.
15124 Signatures using the rsa-sha1 are however (as of writing) still common.
15125 The default inclusion of sha1 may be dropped in a future release.
15126
15127 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15128 This option gives a list of key types which are acceptable in signatures,
15129 and an order of processing.
15130 Signatures with algorithms not in the list will be ignored.
15131
15132 .option dkim_verify_minimal main boolean false
15133 If set to true, verification of signatures will terminate after the
15134 first success.
15135 .wen
15136
15137 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15138 .cindex DKIM "controlling calls to the ACL"
15139 This option gives a list of DKIM domains for which the DKIM ACL is run.
15140 It is expanded after the message is received; by default it runs
15141 the ACL once for each signature in the message.
15142 See section &<<SECDKIMVFY>>&.
15143
15144
15145 .option dns_again_means_nonexist main "domain list&!!" unset
15146 .cindex "DNS" "&""try again""& response; overriding"
15147 DNS lookups give a &"try again"& response for the DNS errors
15148 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15149 keep trying to deliver a message, or to give repeated temporary errors to
15150 incoming mail. Sometimes the effect is caused by a badly set up name server and
15151 may persist for a long time. If a domain which exhibits this problem matches
15152 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15153 This option should be used with care. You can make it apply to reverse lookups
15154 by a setting such as this:
15155 .code
15156 dns_again_means_nonexist = *.in-addr.arpa
15157 .endd
15158 This option applies to all DNS lookups that Exim does. It also applies when the
15159 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15160 since these are most likely to be caused by DNS lookup problems. The
15161 &(dnslookup)& router has some options of its own for controlling what happens
15162 when lookups for MX or SRV records give temporary errors. These more specific
15163 options are applied after this global option.
15164
15165 .option dns_check_names_pattern main string "see below"
15166 .cindex "DNS" "pre-check of name syntax"
15167 When this option is set to a non-empty string, it causes Exim to check domain
15168 names for characters that are not allowed in host names before handing them to
15169 the DNS resolver, because some resolvers give temporary errors for names that
15170 contain unusual characters. If a domain name contains any unwanted characters,
15171 a &"not found"& result is forced, and the resolver is not called. The check is
15172 done by matching the domain name against a regular expression, which is the
15173 value of this option. The default pattern is
15174 .code
15175 dns_check_names_pattern = \
15176   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15177 .endd
15178 which permits only letters, digits, slashes, and hyphens in components, but
15179 they must start and end with a letter or digit. Slashes are not, in fact,
15180 permitted in host names, but they are found in certain NS records (which can be
15181 accessed in Exim by using a &%dnsdb%& lookup). If you set
15182 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15183 empty string.
15184
15185 .option dns_csa_search_limit main integer 5
15186 This option controls the depth of parental searching for CSA SRV records in the
15187 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15188
15189 .option dns_csa_use_reverse main boolean true
15190 This option controls whether or not an IP address, given as a CSA domain, is
15191 reversed and looked up in the reverse DNS, as described in more detail in
15192 section &<<SECTverifyCSA>>&.
15193
15194 .option dns_cname_loops main integer 1
15195 .cindex DNS "CNAME following"
15196 This option controls the following of CNAME chains, needed if the resolver does
15197 not do it internally.
15198 As of 2018 most should, and the default can be left.
15199 If you have an ancient one, a value of 10 is likely needed.
15200
15201 The default value of one CNAME-follow is needed
15202 thanks to the observed return for an MX request,
15203 given no MX presence but a CNAME to an A, of the CNAME.
15204
15205
15206 .option dns_dnssec_ok main integer -1
15207 .cindex "DNS" "resolver options"
15208 .cindex "DNS" "DNSSEC"
15209 If this option is set to a non-negative number then Exim will initialise the
15210 DNS resolver library to either use or not use DNSSEC, overriding the system
15211 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15212
15213 If the resolver library does not support DNSSEC then this option has no effect.
15214
15215
15216 .option dns_ipv4_lookup main "domain list&!!" unset
15217 .cindex "IPv6" "DNS lookup for AAAA records"
15218 .cindex "DNS" "IPv6 lookup for AAAA records"
15219 .cindex DNS "IPv6 disabling"
15220 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15221 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15222 (A records) when trying to find IP addresses for hosts, unless the host's
15223 domain matches this list.
15224
15225 This is a fudge to help with name servers that give big delays or otherwise do
15226 not work for the AAAA record type. In due course, when the world's name
15227 servers have all been upgraded, there should be no need for this option.
15228 .new
15229 Note that all lookups, including those done for verification, are affected;
15230 this will result in verify failure for IPv6 connections or ones using names
15231 only valid for IPv6 addresses.
15232 .wen
15233
15234
15235 .option dns_retrans main time 0s
15236 .cindex "DNS" "resolver options"
15237 .cindex timeout "dns lookup"
15238 .cindex "DNS" timeout
15239 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15240 retransmission and retry parameters for DNS lookups. Values of zero (the
15241 defaults) leave the system default settings unchanged. The first value is the
15242 time between retries, and the second is the number of retries. It isn't
15243 totally clear exactly how these settings affect the total time a DNS lookup may
15244 take. I haven't found any documentation about timeouts on DNS lookups; these
15245 parameter values are available in the external resolver interface structure,
15246 but nowhere does it seem to describe how they are used or what you might want
15247 to set in them.
15248 See also the &%slow_lookup_log%& option.
15249
15250
15251 .option dns_retry main integer 0
15252 See &%dns_retrans%& above.
15253
15254
15255 .option dns_trust_aa main "domain list&!!" unset
15256 .cindex "DNS" "resolver options"
15257 .cindex "DNS" "DNSSEC"
15258 If this option is set then lookup results marked with the AA bit
15259 (Authoritative Answer) are trusted the same way as if they were
15260 DNSSEC-verified. The authority section's name of the answer must
15261 match with this expanded domain list.
15262
15263 Use this option only if you talk directly to a resolver that is
15264 authoritative for some zones and does not set the AD (Authentic Data)
15265 bit in the answer. Some DNS servers may have an configuration option to
15266 mark the answers from their own zones as verified (they set the AD bit).
15267 Others do not have this option. It is considered as poor practice using
15268 a resolver that is an authoritative server for some zones.
15269
15270 Use this option only if you really have to (e.g. if you want
15271 to use DANE for remote delivery to a server that is listed in the DNS
15272 zones that your resolver is authoritative for).
15273
15274 If the DNS answer packet has the AA bit set and contains resource record
15275 in the answer section, the name of the first NS record appearing in the
15276 authority section is compared against the list. If the answer packet is
15277 authoritative but the answer section is empty, the name of the first SOA
15278 record in the authoritative section is used instead.
15279
15280 .cindex "DNS" "resolver options"
15281 .option dns_use_edns0 main integer -1
15282 .cindex "DNS" "resolver options"
15283 .cindex "DNS" "EDNS0"
15284 .cindex "DNS" "OpenBSD
15285 If this option is set to a non-negative number then Exim will initialise the
15286 DNS resolver library to either use or not use EDNS0 extensions, overriding
15287 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15288 on.
15289
15290 If the resolver library does not support EDNS0 then this option has no effect.
15291
15292 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15293 means that DNSSEC will not work with Exim on that platform either, unless Exim
15294 is linked against an alternative DNS client library.
15295
15296
15297 .option drop_cr main boolean false
15298 This is an obsolete option that is now a no-op. It used to affect the way Exim
15299 handled CR and LF characters in incoming messages. What happens now is
15300 described in section &<<SECTlineendings>>&.
15301
15302 .option dsn_advertise_hosts main "host list&!!" unset
15303 .cindex "bounce messages" "success"
15304 .cindex "DSN" "success"
15305 .cindex "Delivery Status Notification" "success"
15306 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15307 and accepted from, these hosts.
15308 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15309 and RET and ORCPT options on MAIL FROM commands.
15310 A NOTIFY=SUCCESS option requests success-DSN messages.
15311 A NOTIFY= option with no argument requests that no delay or failure DSNs
15312 are sent.
15313
15314 .option dsn_from main "string&!!" "see below"
15315 .cindex "&'From:'& header line" "in bounces"
15316 .cindex "bounce messages" "&'From:'& line, specifying"
15317 This option can be used to vary the contents of &'From:'& header lines in
15318 bounces and other automatically generated messages (&"Delivery Status
15319 Notifications"& &-- hence the name of the option). The default setting is:
15320 .code
15321 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15322 .endd
15323 The value is expanded every time it is needed. If the expansion fails, a
15324 panic is logged, and the default value is used.
15325
15326 .option envelope_to_remove main boolean true
15327 .cindex "&'Envelope-to:'& header line"
15328 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15329 message when it is delivered, in exactly the same way as &'Return-path:'& is
15330 handled. &'Envelope-to:'& records the original recipient address from the
15331 message's envelope that caused the delivery to happen. Such headers should not
15332 be present in incoming messages, and this option causes them to be removed at
15333 the time the message is received, to avoid any problems that might occur when a
15334 delivered message is subsequently sent on to some other recipient.
15335
15336
15337 .option errors_copy main "string list&!!" unset
15338 .cindex "bounce message" "copy to other address"
15339 .cindex "copy of bounce message"
15340 Setting this option causes Exim to send bcc copies of bounce messages that it
15341 generates to other addresses. &*Note*&: This does not apply to bounce messages
15342 coming from elsewhere. The value of the option is a colon-separated list of
15343 items. Each item consists of a pattern, terminated by white space, followed by
15344 a comma-separated list of email addresses. If a pattern contains spaces, it
15345 must be enclosed in double quotes.
15346
15347 Each pattern is processed in the same way as a single item in an address list
15348 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15349 the bounce message, the message is copied to the addresses on the list. The
15350 items are scanned in order, and once a matching one is found, no further items
15351 are examined. For example:
15352 .code
15353 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15354               rqps@mydomain   hostmaster@mydomain.example,\
15355                               postmaster@mydomain.example
15356 .endd
15357 .vindex "&$domain$&"
15358 .vindex "&$local_part$&"
15359 The address list is expanded before use. The expansion variables &$local_part$&
15360 and &$domain$& are set from the original recipient of the error message, and if
15361 there was any wildcard matching in the pattern, the expansion
15362 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15363 variables &$0$&, &$1$&, etc. are set in the normal way.
15364
15365
15366 .option errors_reply_to main string unset
15367 .cindex "bounce message" "&'Reply-to:'& in"
15368 By default, Exim's bounce and delivery warning messages contain the header line
15369 .display
15370 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15371 .endd
15372 .oindex &%quota_warn_message%&
15373 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15374 A warning message that is generated by the &%quota_warn_message%& option in an
15375 &(appendfile)& transport may contain its own &'From:'& header line that
15376 overrides the default.
15377
15378 Experience shows that people reply to bounce messages. If the
15379 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15380 and warning messages. For example:
15381 .code
15382 errors_reply_to = postmaster@my.domain.example
15383 .endd
15384 The value of the option is not expanded. It must specify a valid RFC 2822
15385 address. However, if a warning message that is generated by the
15386 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15387 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15388 not used.
15389
15390
15391 .option event_action main string&!! unset
15392 .cindex events
15393 This option declares a string to be expanded for Exim's events mechanism.
15394 For details see chapter &<<CHAPevents>>&.
15395
15396
15397 .option exim_group main string "compile-time configured"
15398 .cindex "gid (group id)" "Exim's own"
15399 .cindex "Exim group"
15400 This option changes the gid under which Exim runs when it gives up root
15401 privilege. The default value is compiled into the binary. The value of this
15402 option is used only when &%exim_user%& is also set. Unless it consists entirely
15403 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15404 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15405 security issues.
15406
15407
15408 .option exim_path main string "see below"
15409 .cindex "Exim binary, path name"
15410 This option specifies the path name of the Exim binary, which is used when Exim
15411 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15412 the directory configured at compile time by the BIN_DIRECTORY setting. It
15413 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15414 other place.
15415 &*Warning*&: Do not use a macro to define the value of this option, because
15416 you will break those Exim utilities that scan the configuration file to find
15417 where the binary is. (They then use the &%-bP%& option to extract option
15418 settings such as the value of &%spool_directory%&.)
15419
15420
15421 .option exim_user main string "compile-time configured"
15422 .cindex "uid (user id)" "Exim's own"
15423 .cindex "Exim user"
15424 This option changes the uid under which Exim runs when it gives up root
15425 privilege. The default value is compiled into the binary. Ownership of the run
15426 time configuration file and the use of the &%-C%& and &%-D%& command line
15427 options is checked against the values in the binary, not what is set here.
15428
15429 Unless it consists entirely of digits, the string is looked up using
15430 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15431 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15432 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15433
15434
15435 .option exim_version main string "current version"
15436 .cindex "Exim version"
15437 .cindex customizing "version number"
15438 .cindex "version number of Exim" override
15439 This option allows to override the &$version_number$&/&$exim_version$& Exim reports in
15440 various places.  Use with care, this may fool stupid security scanners.
15441
15442
15443 .option extra_local_interfaces main "string list" unset
15444 This option defines network interfaces that are to be considered local when
15445 routing, but which are not used for listening by the daemon. See section
15446 &<<SECTreclocipadd>>& for details.
15447
15448
15449 . Allow this long option name to split; give it unsplit as a fifth argument
15450 . for the automatic .oindex that is generated by .option.
15451
15452 .option "extract_addresses_remove_arguments" main boolean true &&&
15453          extract_addresses_remove_arguments
15454 .oindex "&%-t%&"
15455 .cindex "command line" "addresses with &%-t%&"
15456 .cindex "Sendmail compatibility" "&%-t%& option"
15457 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15458 are present on the command line when the &%-t%& option is used to build an
15459 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15460 line addresses are removed from the recipients list. This is also how Smail
15461 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15462 command line addresses are added to those obtained from the header lines. When
15463 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15464 argument headers. If it is set false, Exim adds rather than removes argument
15465 addresses.
15466
15467
15468 .option finduser_retries main integer 0
15469 .cindex "NIS, retrying user lookups"
15470 On systems running NIS or other schemes in which user and group information is
15471 distributed from a remote system, there can be times when &[getpwnam()]& and
15472 related functions fail, even when given valid data, because things time out.
15473 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15474 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15475 many extra times to find a user or a group, waiting for one second between
15476 retries.
15477
15478 .cindex "&_/etc/passwd_&" "multiple reading of"
15479 You should not set this option greater than zero if your user information is in
15480 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15481 search the file multiple times for non-existent users, and also cause delay.
15482
15483
15484
15485 .option freeze_tell main "string list, comma separated" unset
15486 .cindex "freezing messages" "sending a message when freezing"
15487 On encountering certain errors, or when configured to do so in a system filter,
15488 ACL, or special router, Exim freezes a message. This means that no further
15489 delivery attempts take place until an administrator thaws the message, or the
15490 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15491 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15492 warning message whenever it freezes something, unless the message it is
15493 freezing is a locally-generated bounce message. (Without this exception there
15494 is the possibility of looping.) The warning message is sent to the addresses
15495 supplied as the comma-separated value of this option. If several of the
15496 message's addresses cause freezing, only a single message is sent. If the
15497 freezing was automatic, the reason(s) for freezing can be found in the message
15498 log. If you configure freezing in a filter or ACL, you must arrange for any
15499 logging that you require.
15500
15501
15502 .option gecos_name main string&!! unset
15503 .cindex "HP-UX"
15504 .cindex "&""gecos""& field, parsing"
15505 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15506 password file to hold other information in addition to users' real names. Exim
15507 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15508 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15509 of the field are used unchanged, except that, if an ampersand is encountered,
15510 it is replaced by the user's login name with the first character forced to
15511 upper case, since this is a convention that is observed on many systems.
15512
15513 When these options are set, &%gecos_pattern%& is treated as a regular
15514 expression that is to be applied to the field (again with && replaced by the
15515 login name), and if it matches, &%gecos_name%& is expanded and used as the
15516 user's name.
15517
15518 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15519 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15520 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15521 name terminates at the first comma, the following can be used:
15522 .code
15523 gecos_pattern = ([^,]*)
15524 gecos_name = $1
15525 .endd
15526
15527 .option gecos_pattern main string unset
15528 See &%gecos_name%& above.
15529
15530
15531 .option gnutls_compat_mode main boolean unset
15532 This option controls whether GnuTLS is used in compatibility mode in an Exim
15533 server. This reduces security slightly, but improves interworking with older
15534 implementations of TLS.
15535
15536
15537 .option gnutls_allow_auto_pkcs11 main boolean unset
15538 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15539 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15540
15541 See
15542 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15543 for documentation.
15544
15545
15546
15547 .option headers_charset main string "see below"
15548 This option sets a default character set for translating from encoded MIME
15549 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15550 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15551 ultimate default is ISO-8859-1. For more details see the description of header
15552 insertions in section &<<SECTexpansionitems>>&.
15553
15554
15555
15556 .option header_maxsize main integer "see below"
15557 .cindex "header section" "maximum size of"
15558 .cindex "limit" "size of message header section"
15559 This option controls the overall maximum size of a message's header
15560 section. The default is the value of HEADER_MAXSIZE in
15561 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15562 sections are rejected.
15563
15564
15565 .option header_line_maxsize main integer 0
15566 .cindex "header lines" "maximum size of"
15567 .cindex "limit" "size of one header line"
15568 This option limits the length of any individual header line in a message, after
15569 all the continuations have been joined together. Messages with individual
15570 header lines that are longer than the limit are rejected. The default value of
15571 zero means &"no limit"&.
15572
15573
15574
15575
15576 .option helo_accept_junk_hosts main "host list&!!" unset
15577 .cindex "HELO" "accepting junk data"
15578 .cindex "EHLO" "accepting junk data"
15579 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15580 mail, and gives an error response for invalid data. Unfortunately, there are
15581 some SMTP clients that send syntactic junk. They can be accommodated by setting
15582 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15583 if you want to do semantic checking.
15584 See also &%helo_allow_chars%& for a way of extending the permitted character
15585 set.
15586
15587
15588 .option helo_allow_chars main string unset
15589 .cindex "HELO" "underscores in"
15590 .cindex "EHLO" "underscores in"
15591 .cindex "underscore in EHLO/HELO"
15592 This option can be set to a string of rogue characters that are permitted in
15593 all EHLO and HELO names in addition to the standard letters, digits,
15594 hyphens, and dots. If you really must allow underscores, you can set
15595 .code
15596 helo_allow_chars = _
15597 .endd
15598 Note that the value is one string, not a list.
15599
15600
15601 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15602 .cindex "HELO" "forcing reverse lookup"
15603 .cindex "EHLO" "forcing reverse lookup"
15604 If the domain given by a client in a HELO or EHLO command matches this
15605 list, a reverse lookup is done in order to establish the host's true name. The
15606 default forces a lookup if the client host gives the server's name or any of
15607 its IP addresses (in brackets), something that broken clients have been seen to
15608 do.
15609
15610
15611 .option helo_try_verify_hosts main "host list&!!" unset
15612 .cindex "HELO verifying" "optional"
15613 .cindex "EHLO" "verifying, optional"
15614 By default, Exim just checks the syntax of HELO and EHLO commands (see
15615 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15616 to do more extensive checking of the data supplied by these commands. The ACL
15617 condition &`verify = helo`& is provided to make this possible.
15618 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15619 to force the check to occur. From release 4.53 onwards, this is no longer
15620 necessary. If the check has not been done before &`verify = helo`& is
15621 encountered, it is done at that time. Consequently, this option is obsolete.
15622 Its specification is retained here for backwards compatibility.
15623
15624 When an EHLO or HELO command is received, if the calling host matches
15625 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15626 EHLO command either:
15627
15628 .ilist
15629 is an IP literal matching the calling address of the host, or
15630 .next
15631 .cindex "DNS" "reverse lookup"
15632 .cindex "reverse DNS lookup"
15633 matches the host name that Exim obtains by doing a reverse lookup of the
15634 calling host address, or
15635 .next
15636 when looked up in DNS yields the calling host address.
15637 .endlist
15638
15639 However, the EHLO or HELO command is not rejected if any of the checks
15640 fail. Processing continues, but the result of the check is remembered, and can
15641 be detected later in an ACL by the &`verify = helo`& condition.
15642
15643 If DNS was used for successful verification, the variable
15644 .cindex "DNS" "DNSSEC"
15645 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15646
15647 .option helo_verify_hosts main "host list&!!" unset
15648 .cindex "HELO verifying" "mandatory"
15649 .cindex "EHLO" "verifying, mandatory"
15650 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15651 backwards compatibility. For hosts that match this option, Exim checks the host
15652 name given in the HELO or EHLO in the same way as for
15653 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15654 rejected with a 550 error, and entries are written to the main and reject logs.
15655 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15656 error.
15657
15658 .option hold_domains main "domain list&!!" unset
15659 .cindex "domain" "delaying delivery"
15660 .cindex "delivery" "delaying certain domains"
15661 This option allows mail for particular domains to be held in the queue
15662 manually. The option is overridden if a message delivery is forced with the
15663 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15664 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15665 item in &%hold_domains%&, no routing or delivery for that address is done, and
15666 it is deferred every time the message is looked at.
15667
15668 This option is intended as a temporary operational measure for delaying the
15669 delivery of mail while some problem is being sorted out, or some new
15670 configuration tested. If you just want to delay the processing of some
15671 domains until a queue run occurs, you should use &%queue_domains%& or
15672 &%queue_smtp_domains%&, not &%hold_domains%&.
15673
15674 A setting of &%hold_domains%& does not override Exim's code for removing
15675 messages from the queue if they have been there longer than the longest retry
15676 time in any retry rule. If you want to hold messages for longer than the normal
15677 retry times, insert a dummy retry rule with a long retry time.
15678
15679
15680 .option host_lookup main "host list&!!" unset
15681 .cindex "host name" "lookup, forcing"
15682 Exim does not look up the name of a calling host from its IP address unless it
15683 is required to compare against some host list, or the host matches
15684 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15685 option (which normally contains IP addresses rather than host names). The
15686 default configuration file contains
15687 .code
15688 host_lookup = *
15689 .endd
15690 which causes a lookup to happen for all hosts. If the expense of these lookups
15691 is felt to be too great, the setting can be changed or removed.
15692
15693 After a successful reverse lookup, Exim does a forward lookup on the name it
15694 has obtained, to verify that it yields the IP address that it started with. If
15695 this check fails, Exim behaves as if the name lookup failed.
15696
15697 .vindex "&$host_lookup_failed$&"
15698 .vindex "&$sender_host_name$&"
15699 After any kind of failure, the host name (in &$sender_host_name$&) remains
15700 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15701 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15702 &`verify = reverse_host_lookup`& in ACLs.
15703
15704
15705 .option host_lookup_order main "string list" &`bydns:byaddr`&
15706 This option specifies the order of different lookup methods when Exim is trying
15707 to find a host name from an IP address. The default is to do a DNS lookup
15708 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15709 if that fails. You can change the order of these lookups, or omit one entirely,
15710 if you want.
15711
15712 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15713 multiple PTR records in the DNS and the IP address is not listed in
15714 &_/etc/hosts_&. Different operating systems give different results in this
15715 case. That is why the default tries a DNS lookup first.
15716
15717
15718
15719 .option host_reject_connection main "host list&!!" unset
15720 .cindex "host" "rejecting connections from"
15721 If this option is set, incoming SMTP calls from the hosts listed are rejected
15722 as soon as the connection is made.
15723 This option is obsolete, and retained only for backward compatibility, because
15724 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15725 connections immediately.
15726
15727 The ability to give an immediate rejection (either by this option or using an
15728 ACL) is provided for use in unusual cases. Many hosts will just try again,
15729 sometimes without much delay. Normally, it is better to use an ACL to reject
15730 incoming messages at a later stage, such as after RCPT commands. See
15731 chapter &<<CHAPACL>>&.
15732
15733
15734 .option hosts_connection_nolog main "host list&!!" unset
15735 .cindex "host" "not logging connections from"
15736 This option defines a list of hosts for which connection logging does not
15737 happen, even though the &%smtp_connection%& log selector is set. For example,
15738 you might want not to log SMTP connections from local processes, or from
15739 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15740 the daemon; you should therefore strive to restrict its value to a short inline
15741 list of IP addresses and networks. To disable logging SMTP connections from
15742 local processes, you must create a host list with an empty item. For example:
15743 .code
15744 hosts_connection_nolog = :
15745 .endd
15746 If the &%smtp_connection%& log selector is not set, this option has no effect.
15747
15748
15749
15750 .option hosts_proxy main "host list&!!" unset
15751 .cindex proxy "proxy protocol"
15752 This option enables use of Proxy Protocol proxies for incoming
15753 connections.  For details see section &<<SECTproxyInbound>>&.
15754
15755
15756 .option hosts_treat_as_local main "domain list&!!" unset
15757 .cindex "local host" "domains treated as"
15758 .cindex "host" "treated as local"
15759 If this option is set, any host names that match the domain list are treated as
15760 if they were the local host when Exim is scanning host lists obtained from MX
15761 records
15762 or other sources. Note that the value of this option is a domain list, not a
15763 host list, because it is always used to check host names, not IP addresses.
15764
15765 This option also applies when Exim is matching the special items
15766 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15767 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15768 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15769 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15770 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15771 interfaces and recognizing the local host.
15772
15773
15774 .option ibase_servers main "string list" unset
15775 .cindex "InterBase" "server list"
15776 This option provides a list of InterBase servers and associated connection data,
15777 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15778 The option is available only if Exim has been built with InterBase support.
15779
15780
15781
15782 .option ignore_bounce_errors_after main time 10w
15783 .cindex "bounce message" "discarding"
15784 .cindex "discarding bounce message"
15785 This option affects the processing of bounce messages that cannot be delivered,
15786 that is, those that suffer a permanent delivery failure. (Bounce messages that
15787 suffer temporary delivery failures are of course retried in the usual way.)
15788
15789 After a permanent delivery failure, bounce messages are frozen,
15790 because there is no sender to whom they can be returned. When a frozen bounce
15791 message has been in the queue for more than the given time, it is unfrozen at
15792 the next queue run, and a further delivery is attempted. If delivery fails
15793 again, the bounce message is discarded. This makes it possible to keep failed
15794 bounce messages around for a shorter time than the normal maximum retry time
15795 for frozen messages. For example,
15796 .code
15797 ignore_bounce_errors_after = 12h
15798 .endd
15799 retries failed bounce message deliveries after 12 hours, discarding any further
15800 failures. If the value of this option is set to a zero time period, bounce
15801 failures are discarded immediately. Setting a very long time (as in the default
15802 value) has the effect of disabling this option. For ways of automatically
15803 dealing with other kinds of frozen message, see &%auto_thaw%& and
15804 &%timeout_frozen_after%&.
15805
15806
15807 .option ignore_fromline_hosts main "host list&!!" unset
15808 .cindex "&""From""& line"
15809 .cindex "UUCP" "&""From""& line"
15810 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15811 the headers of a message. By default this is treated as the start of the
15812 message's body, which means that any following headers are not recognized as
15813 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15814 match those hosts that insist on sending it. If the sender is actually a local
15815 process rather than a remote host, and is using &%-bs%& to inject the messages,
15816 &%ignore_fromline_local%& must be set to achieve this effect.
15817
15818
15819 .option ignore_fromline_local main boolean false
15820 See &%ignore_fromline_hosts%& above.
15821
15822 .option keep_environment main "string list" unset
15823 .cindex "environment" "values from"
15824 This option contains a string list of environment variables to keep.
15825 You have to trust these variables or you have to be sure that
15826 these variables do not impose any security risk. Keep in mind that
15827 during the startup phase Exim is running with an effective UID 0 in most
15828 installations. As the default value is an empty list, the default
15829 environment for using libraries, running embedded Perl code, or running
15830 external binaries is empty, and does not not even contain PATH or HOME.
15831
15832 Actually the list is interpreted as a list of patterns
15833 (&<<SECTlistexpand>>&), except that it is not expanded first.
15834
15835 WARNING: Macro substitution is still done first, so having a macro
15836 FOO and having FOO_HOME in your &%keep_environment%& option may have
15837 unexpected results. You may work around this using a regular expression
15838 that does not match the macro name: ^[F]OO_HOME$.
15839
15840 Current versions of Exim issue a warning during startup if you do not mention
15841 &%keep_environment%& in your runtime configuration file and if your
15842 current environment is not empty. Future versions may not issue that warning
15843 anymore.
15844
15845 See the &%add_environment%& main config option for a way to set
15846 environment variables to a fixed value.  The environment for &(pipe)&
15847 transports is handled separately, see section &<<SECTpipeenv>>& for
15848 details.
15849
15850
15851 .option keep_malformed main time 4d
15852 This option specifies the length of time to keep messages whose spool files
15853 have been corrupted in some way. This should, of course, never happen. At the
15854 next attempt to deliver such a message, it gets removed. The incident is
15855 logged.
15856
15857
15858 .option ldap_ca_cert_dir main string unset
15859 .cindex "LDAP", "TLS CA certificate directory"
15860 .cindex certificate "directory for LDAP"
15861 This option indicates which directory contains CA certificates for verifying
15862 a TLS certificate presented by an LDAP server.
15863 While Exim does not provide a default value, your SSL library may.
15864 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15865 and constrained to be a directory.
15866
15867
15868 .option ldap_ca_cert_file main string unset
15869 .cindex "LDAP", "TLS CA certificate file"
15870 .cindex certificate "file for LDAP"
15871 This option indicates which file contains CA certificates for verifying
15872 a TLS certificate presented by an LDAP server.
15873 While Exim does not provide a default value, your SSL library may.
15874 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15875 and constrained to be a file.
15876
15877
15878 .option ldap_cert_file main string unset
15879 .cindex "LDAP" "TLS client certificate file"
15880 .cindex certificate "file for LDAP"
15881 This option indicates which file contains an TLS client certificate which
15882 Exim should present to the LDAP server during TLS negotiation.
15883 Should be used together with &%ldap_cert_key%&.
15884
15885
15886 .option ldap_cert_key main string unset
15887 .cindex "LDAP" "TLS client key file"
15888 .cindex certificate "key for LDAP"
15889 This option indicates which file contains the secret/private key to use
15890 to prove identity to the LDAP server during TLS negotiation.
15891 Should be used together with &%ldap_cert_file%&, which contains the
15892 identity to be proven.
15893
15894
15895 .option ldap_cipher_suite main string unset
15896 .cindex "LDAP" "TLS cipher suite"
15897 This controls the TLS cipher-suite negotiation during TLS negotiation with
15898 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15899 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15900
15901
15902 .option ldap_default_servers main "string list" unset
15903 .cindex "LDAP" "default servers"
15904 This option provides a list of LDAP servers which are tried in turn when an
15905 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15906 details of LDAP queries. This option is available only when Exim has been built
15907 with LDAP support.
15908
15909
15910 .option ldap_require_cert main string unset.
15911 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15912 This should be one of the values "hard", "demand", "allow", "try" or "never".
15913 A value other than one of these is interpreted as "never".
15914 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15915 Although Exim does not set a default, the LDAP library probably defaults
15916 to hard/demand.
15917
15918
15919 .option ldap_start_tls main boolean false
15920 .cindex "LDAP" "whether or not to negotiate TLS"
15921 If set, Exim will attempt to negotiate TLS with the LDAP server when
15922 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15923 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15924 of SSL-on-connect.
15925 In the event of failure to negotiate TLS, the action taken is controlled
15926 by &%ldap_require_cert%&.
15927 This option is ignored for &`ldapi`& connections.
15928
15929
15930 .option ldap_version main integer unset
15931 .cindex "LDAP" "protocol version, forcing"
15932 This option can be used to force Exim to set a specific protocol version for
15933 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15934 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15935 the LDAP headers; otherwise it is 2. This option is available only when Exim
15936 has been built with LDAP support.
15937
15938
15939
15940 .option local_from_check main boolean true
15941 .cindex "&'Sender:'& header line" "disabling addition of"
15942 .cindex "&'From:'& header line" "disabling checking of"
15943 When a message is submitted locally (that is, not over a TCP/IP connection) by
15944 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15945 checks that the &'From:'& header line matches the login of the calling user and
15946 the domain specified by &%qualify_domain%&.
15947
15948 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15949 locally submitted message is automatically qualified by Exim, unless the
15950 &%-bnq%& command line option is used.
15951
15952 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15953 on the local part. If the &'From:'& header line does not match, Exim adds a
15954 &'Sender:'& header with an address constructed from the calling user's login
15955 and the default qualify domain.
15956
15957 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15958 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15959 &'Sender:'& header lines supplied by untrusted users, you must also set
15960 &%local_sender_retain%& to be true.
15961
15962 .cindex "envelope from"
15963 .cindex "envelope sender"
15964 These options affect only the header lines in the message. The envelope sender
15965 is still forced to be the login id at the qualify domain unless
15966 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15967
15968 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15969 request similar header line checking. See section &<<SECTthesenhea>>&, which
15970 has more details about &'Sender:'& processing.
15971
15972
15973
15974
15975 .option local_from_prefix main string unset
15976 When Exim checks the &'From:'& header line of locally submitted messages for
15977 matching the login id (see &%local_from_check%& above), it can be configured to
15978 ignore certain prefixes and suffixes in the local part of the address. This is
15979 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15980 appropriate lists, in the same form as the &%local_part_prefix%& and
15981 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15982 example, if
15983 .code
15984 local_from_prefix = *-
15985 .endd
15986 is set, a &'From:'& line containing
15987 .code
15988 From: anything-user@your.domain.example
15989 .endd
15990 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15991 matches the actual sender address that is constructed from the login name and
15992 qualify domain.
15993
15994
15995 .option local_from_suffix main string unset
15996 See &%local_from_prefix%& above.
15997
15998
15999 .option local_interfaces main "string list" "see below"
16000 This option controls which network interfaces are used by the daemon for
16001 listening; they are also used to identify the local host when routing. Chapter
16002 &<<CHAPinterfaces>>& contains a full description of this option and the related
16003 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16004 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16005 &%local_interfaces%& is
16006 .code
16007 local_interfaces = 0.0.0.0
16008 .endd
16009 when Exim is built without IPv6 support; otherwise it is
16010 .code
16011 local_interfaces = <; ::0 ; 0.0.0.0
16012 .endd
16013
16014 .option local_scan_timeout main time 5m
16015 .cindex "timeout" "for &[local_scan()]& function"
16016 .cindex "&[local_scan()]& function" "timeout"
16017 This timeout applies to the &[local_scan()]& function (see chapter
16018 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16019 the incoming message is rejected with a temporary error if it is an SMTP
16020 message. For a non-SMTP message, the message is dropped and Exim ends with a
16021 non-zero code. The incident is logged on the main and reject logs.
16022
16023
16024
16025 .option local_sender_retain main boolean false
16026 .cindex "&'Sender:'& header line" "retaining from local submission"
16027 When a message is submitted locally (that is, not over a TCP/IP connection) by
16028 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16029 do not want this to happen, you must set &%local_sender_retain%&, and you must
16030 also set &%local_from_check%& to be false (Exim will complain if you do not).
16031 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16032 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16033
16034
16035
16036
16037 .option localhost_number main string&!! unset
16038 .cindex "host" "locally unique number for"
16039 .cindex "message ids" "with multiple hosts"
16040 .vindex "&$localhost_number$&"
16041 Exim's message ids are normally unique only within the local host. If
16042 uniqueness among a set of hosts is required, each host must set a different
16043 value for the &%localhost_number%& option. The string is expanded immediately
16044 after reading the configuration file (so that a number can be computed from the
16045 host name, for example) and the result of the expansion must be a number in the
16046 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16047 systems). This is available in subsequent string expansions via the variable
16048 &$localhost_number$&. When &%localhost_number is set%&, the final two
16049 characters of the message id, instead of just being a fractional part of the
16050 time, are computed from the time and the local host number as described in
16051 section &<<SECTmessiden>>&.
16052
16053
16054
16055 .option log_file_path main "string list&!!" "set at compile time"
16056 .cindex "log" "file path for"
16057 This option sets the path which is used to determine the names of Exim's log
16058 files, or indicates that logging is to be to syslog, or both. It is expanded
16059 when Exim is entered, so it can, for example, contain a reference to the host
16060 name. If no specific path is set for the log files at compile or runtime,
16061 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16062 they are written in a sub-directory called &_log_& in Exim's spool directory.
16063 .new
16064 A path must start with a slash.
16065 To send to syslog, use the word &"syslog"&.
16066 .wen
16067 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16068 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16069 used. If this string is fixed at your installation (contains no expansion
16070 variables) it is recommended that you do not set this option in the
16071 configuration file, but instead supply the path using LOG_FILE_PATH in
16072 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16073 early on &-- in particular, failure to read the configuration file.
16074
16075
16076 .option log_selector main string unset
16077 .cindex "log" "selectors"
16078 This option can be used to reduce or increase the number of things that Exim
16079 writes to its log files. Its argument is made up of names preceded by plus or
16080 minus characters. For example:
16081 .code
16082 log_selector = +arguments -retry_defer
16083 .endd
16084 A list of possible names and what they control is given in the chapter on
16085 logging, in section &<<SECTlogselector>>&.
16086
16087
16088 .option log_timezone main boolean false
16089 .cindex "log" "timezone for entries"
16090 .vindex "&$tod_log$&"
16091 .vindex "&$tod_zone$&"
16092 By default, the timestamps on log lines are in local time without the
16093 timezone. This means that if your timezone changes twice a year, the timestamps
16094 in log lines are ambiguous for an hour when the clocks go back. One way of
16095 avoiding this problem is to set the timezone to UTC. An alternative is to set
16096 &%log_timezone%& true. This turns on the addition of the timezone offset to
16097 timestamps in log lines. Turning on this option can add quite a lot to the size
16098 of log files because each line is extended by 6 characters. Note that the
16099 &$tod_log$& variable contains the log timestamp without the zone, but there is
16100 another variable called &$tod_zone$& that contains just the timezone offset.
16101
16102
16103 .option lookup_open_max main integer 25
16104 .cindex "too many open files"
16105 .cindex "open files, too many"
16106 .cindex "file" "too many open"
16107 .cindex "lookup" "maximum open files"
16108 .cindex "limit" "open files for lookups"
16109 This option limits the number of simultaneously open files for single-key
16110 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16111 Exim normally keeps these files open during routing, because often the same
16112 file is required several times. If the limit is reached, Exim closes the least
16113 recently used file. Note that if you are using the &'ndbm'& library, it
16114 actually opens two files for each logical DBM database, though it still counts
16115 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16116 open files"& errors with NDBM, you need to reduce the value of
16117 &%lookup_open_max%&.
16118
16119
16120 .option max_username_length main integer 0
16121 .cindex "length of login name"
16122 .cindex "user name" "maximum length"
16123 .cindex "limit" "user name length"
16124 Some operating systems are broken in that they truncate long arguments to
16125 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16126 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16127 an argument that is longer behaves as if &[getpwnam()]& failed.
16128
16129
16130 .option message_body_newlines main bool false
16131 .cindex "message body" "newlines in variables"
16132 .cindex "newline" "in message body variables"
16133 .vindex "&$message_body$&"
16134 .vindex "&$message_body_end$&"
16135 By default, newlines in the message body are replaced by spaces when setting
16136 the &$message_body$& and &$message_body_end$& expansion variables. If this
16137 option is set true, this no longer happens.
16138
16139
16140 .option message_body_visible main integer 500
16141 .cindex "body of message" "visible size"
16142 .cindex "message body" "visible size"
16143 .vindex "&$message_body$&"
16144 .vindex "&$message_body_end$&"
16145 This option specifies how much of a message's body is to be included in the
16146 &$message_body$& and &$message_body_end$& expansion variables.
16147
16148
16149 .option message_id_header_domain main string&!! unset
16150 .cindex "&'Message-ID:'& header line"
16151 If this option is set, the string is expanded and used as the right hand side
16152 (domain) of the &'Message-ID:'& header that Exim creates if a
16153 locally-originated incoming message does not have one. &"Locally-originated"&
16154 means &"not received over TCP/IP."&
16155 Otherwise, the primary host name is used.
16156 Only letters, digits, dot and hyphen are accepted; any other characters are
16157 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16158 empty string, the option is ignored.
16159
16160
16161 .option message_id_header_text main string&!! unset
16162 If this variable is set, the string is expanded and used to augment the text of
16163 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16164 message does not have one. The text of this header is required by RFC 2822 to
16165 take the form of an address. By default, Exim uses its internal message id as
16166 the local part, and the primary host name as the domain. If this option is set,
16167 it is expanded, and provided the expansion is not forced to fail, and does not
16168 yield an empty string, the result is inserted into the header immediately
16169 before the @, separated from the internal message id by a dot. Any characters
16170 that are illegal in an address are automatically converted into hyphens. This
16171 means that variables such as &$tod_log$& can be used, because the spaces and
16172 colons will become hyphens.
16173
16174
16175 .option message_logs main boolean true
16176 .cindex "message logs" "disabling"
16177 .cindex "log" "message log; disabling"
16178 If this option is turned off, per-message log files are not created in the
16179 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16180 Exim, by reducing the number of files involved in handling a message from a
16181 minimum of four (header spool file, body spool file, delivery journal, and
16182 per-message log) to three. The other major I/O activity is Exim's main log,
16183 which is not affected by this option.
16184
16185
16186 .option message_size_limit main string&!! 50M
16187 .cindex "message" "size limit"
16188 .cindex "limit" "message size"
16189 .cindex "size" "of message, limit"
16190 This option limits the maximum size of message that Exim will process. The
16191 value is expanded for each incoming connection so, for example, it can be made
16192 to depend on the IP address of the remote host for messages arriving via
16193 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16194 optionally followed by K or M.
16195
16196 &*Note*&: This limit cannot be made to depend on a message's sender or any
16197 other properties of an individual message, because it has to be advertised in
16198 the server's response to EHLO. String expansion failure causes a temporary
16199 error. A value of zero means no limit, but its use is not recommended. See also
16200 &%bounce_return_size_limit%&.
16201
16202 Incoming SMTP messages are failed with a 552 error if the limit is
16203 exceeded; locally-generated messages either get a stderr message or a delivery
16204 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16205 an oversized message is logged in both the main and the reject logs. See also
16206 the generic transport option &%message_size_limit%&, which limits the size of
16207 message that an individual transport can process.
16208
16209 If you use a virus-scanner and set this option to to a value larger than the
16210 maximum size that your virus-scanner is configured to support, you may get
16211 failures triggered by large mails.  The right size to configure for the
16212 virus-scanner depends upon what data is passed and the options in use but it's
16213 probably safest to just set it to a little larger than this value.  E.g., with a
16214 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16215 some problems may result.
16216
16217 A value of 0 will disable size limit checking; Exim will still advertise the
16218 SIZE extension in an EHLO response, but without a limit, so as to permit
16219 SMTP clients to still indicate the message size along with the MAIL verb.
16220
16221
16222 .option move_frozen_messages main boolean false
16223 .cindex "frozen messages" "moving"
16224 This option, which is available only if Exim has been built with the setting
16225 .code
16226 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16227 .endd
16228 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16229 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16230 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16231 standard utilities for handling such moved messages, and they do not show up in
16232 lists generated by &%-bp%& or by the Exim monitor.
16233
16234
16235 .option mua_wrapper main boolean false
16236 Setting this option true causes Exim to run in a very restrictive mode in which
16237 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16238 contains a full description of this facility.
16239
16240
16241
16242 .option mysql_servers main "string list" unset
16243 .cindex "MySQL" "server list"
16244 This option provides a list of MySQL servers and associated connection data, to
16245 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16246 option is available only if Exim has been built with MySQL support.
16247
16248
16249 .option never_users main "string list&!!" unset
16250 This option is expanded just once, at the start of Exim's processing. Local
16251 message deliveries are normally run in processes that are setuid to the
16252 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16253 It is usually desirable to prevent any deliveries from running as root, as a
16254 safety precaution.
16255
16256 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16257 list of users that must not be used for local deliveries. This list is fixed in
16258 the binary and cannot be overridden by the configuration file. By default, it
16259 contains just the single user name &"root"&. The &%never_users%& runtime option
16260 can be used to add more users to the fixed list.
16261
16262 If a message is to be delivered as one of the users on the fixed list or the
16263 &%never_users%& list, an error occurs, and delivery is deferred. A common
16264 example is
16265 .code
16266 never_users = root:daemon:bin
16267 .endd
16268 Including root is redundant if it is also on the fixed list, but it does no
16269 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16270 transport driver.
16271
16272
16273 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket"
16274 .cindex "OpenSSL "compatibility options"
16275 This option allows an administrator to adjust the SSL options applied
16276 by OpenSSL to connections.  It is given as a space-separated list of items,
16277 each one to be +added or -subtracted from the current value.
16278
16279 This option is only available if Exim is built against OpenSSL.  The values
16280 available for this option vary according to the age of your OpenSSL install.
16281 The &"all"& value controls a subset of flags which are available, typically
16282 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16283 list the values known on your system and Exim should support all the
16284 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16285 names lose the leading &"SSL_OP_"& and are lower-cased.
16286
16287 Note that adjusting the options can have severe impact upon the security of
16288 SSL as used by Exim.  It is possible to disable safety checks and shoot
16289 yourself in the foot in various unpleasant ways.  This option should not be
16290 adjusted lightly.  An unrecognised item will be detected at startup, by
16291 invoking Exim with the &%-bV%& flag.
16292
16293 The option affects Exim operating both as a server and as a client.
16294
16295 Historical note: prior to release 4.80, Exim defaulted this value to
16296 "+dont_insert_empty_fragments", which may still be needed for compatibility
16297 with some clients, but which lowers security by increasing exposure to
16298 some now infamous attacks.
16299
16300 Examples:
16301 .code
16302 # Make both old MS and old Eudora happy:
16303 openssl_options = -all +microsoft_big_sslv3_buffer \
16304                        +dont_insert_empty_fragments
16305
16306 # Disable older protocol versions:
16307 openssl_options = +no_sslv2 +no_sslv3
16308 .endd
16309
16310 Possible options may include:
16311 .ilist
16312 &`all`&
16313 .next
16314 &`allow_unsafe_legacy_renegotiation`&
16315 .next
16316 &`cipher_server_preference`&
16317 .next
16318 &`dont_insert_empty_fragments`&
16319 .next
16320 &`ephemeral_rsa`&
16321 .next
16322 &`legacy_server_connect`&
16323 .next
16324 &`microsoft_big_sslv3_buffer`&
16325 .next
16326 &`microsoft_sess_id_bug`&
16327 .next
16328 &`msie_sslv2_rsa_padding`&
16329 .next
16330 &`netscape_challenge_bug`&
16331 .next
16332 &`netscape_reuse_cipher_change_bug`&
16333 .next
16334 &`no_compression`&
16335 .next
16336 &`no_session_resumption_on_renegotiation`&
16337 .next
16338 &`no_sslv2`&
16339 .next
16340 &`no_sslv3`&
16341 .next
16342 &`no_ticket`&
16343 .next
16344 &`no_tlsv1`&
16345 .next
16346 &`no_tlsv1_1`&
16347 .next
16348 &`no_tlsv1_2`&
16349 .next
16350 &`safari_ecdhe_ecdsa_bug`&
16351 .next
16352 &`single_dh_use`&
16353 .next
16354 &`single_ecdh_use`&
16355 .next
16356 &`ssleay_080_client_dh_bug`&
16357 .next
16358 &`sslref2_reuse_cert_type_bug`&
16359 .next
16360 &`tls_block_padding_bug`&
16361 .next
16362 &`tls_d5_bug`&
16363 .next
16364 &`tls_rollback_bug`&
16365 .endlist
16366
16367 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16368 all clients connecting using the MacOS SecureTransport TLS facility prior
16369 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16370 to negotiate TLS then this option value might help, provided that your OpenSSL
16371 release is new enough to contain this work-around.  This may be a situation
16372 where you have to upgrade OpenSSL to get buggy clients working.
16373
16374
16375 .option oracle_servers main "string list" unset
16376 .cindex "Oracle" "server list"
16377 This option provides a list of Oracle servers and associated connection data,
16378 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16379 The option is available only if Exim has been built with Oracle support.
16380
16381
16382 .option percent_hack_domains main "domain list&!!" unset
16383 .cindex "&""percent hack""&"
16384 .cindex "source routing" "in email address"
16385 .cindex "address" "source-routed"
16386 The &"percent hack"& is the convention whereby a local part containing a
16387 percent sign is re-interpreted as a new email address, with the percent
16388 replaced by @. This is sometimes called &"source routing"&, though that term is
16389 also applied to RFC 2822 addresses that begin with an @ character. If this
16390 option is set, Exim implements the percent facility for those domains listed,
16391 but no others. This happens before an incoming SMTP address is tested against
16392 an ACL.
16393
16394 &*Warning*&: The &"percent hack"& has often been abused by people who are
16395 trying to get round relaying restrictions. For this reason, it is best avoided
16396 if at all possible. Unfortunately, a number of less security-conscious MTAs
16397 implement it unconditionally. If you are running Exim on a gateway host, and
16398 routing mail through to internal MTAs without processing the local parts, it is
16399 a good idea to reject recipient addresses with percent characters in their
16400 local parts. Exim's default configuration does this.
16401
16402
16403 .option perl_at_start main boolean false
16404 .cindex "Perl"
16405 This option is available only when Exim is built with an embedded Perl
16406 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16407
16408
16409 .option perl_startup main string unset
16410 .cindex "Perl"
16411 This option is available only when Exim is built with an embedded Perl
16412 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16413
16414 .option perl_startup main boolean false
16415 .cindex "Perl"
16416 This Option enables the taint mode of the embedded Perl interpreter.
16417
16418
16419 .option pgsql_servers main "string list" unset
16420 .cindex "PostgreSQL lookup type" "server list"
16421 This option provides a list of PostgreSQL servers and associated connection
16422 data, to be used in conjunction with &(pgsql)& lookups (see section
16423 &<<SECID72>>&). The option is available only if Exim has been built with
16424 PostgreSQL support.
16425
16426
16427 .option pid_file_path main string&!! "set at compile time"
16428 .cindex "daemon" "pid file path"
16429 .cindex "pid file, path for"
16430 This option sets the name of the file to which the Exim daemon writes its
16431 process id. The string is expanded, so it can contain, for example, references
16432 to the host name:
16433 .code
16434 pid_file_path = /var/log/$primary_hostname/exim.pid
16435 .endd
16436 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16437 spool directory.
16438 The value set by the option can be overridden by the &%-oP%& command line
16439 option. A pid file is not written if a &"non-standard"& daemon is run by means
16440 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16441
16442
16443 .option pipelining_advertise_hosts main "host list&!!" *
16444 .cindex "PIPELINING" "suppressing advertising"
16445 This option can be used to suppress the advertisement of the SMTP
16446 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16447 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16448 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16449 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16450 that clients will use it; &"out of order"& commands that are &"expected"& do
16451 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16452
16453 .new
16454 .option pipelining_connect_advertise_hosts main "host list&!!" *
16455 .cindex "pipelining" "early connection"
16456 .cindex "pipelining" PIPE_CONNECT
16457 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16458 this option controls which hosts the facility is advertised to
16459 and from which pipeline early-connection (before MAIL) SMTP
16460 commands are acceptable.
16461 When used, the pipelining saves on roundtrip times.
16462
16463 See also the &%hosts_pipe_connect%& smtp transport option.
16464
16465 Currently the option name &"X_PIPE_CONNECT"& is used.
16466 .wen
16467
16468
16469 .option prdr_enable main boolean false
16470 .cindex "PRDR" "enabling on server"
16471 This option can be used to enable the Per-Recipient Data Response extension
16472 to SMTP, defined by Eric Hall.
16473 If the option is set, PRDR is advertised by Exim when operating as a server.
16474 If the client requests PRDR, and more than one recipient, for a message
16475 an additional ACL is called for each recipient after the message content
16476 is received.  See section &<<SECTPRDRACL>>&.
16477
16478 .option preserve_message_logs main boolean false
16479 .cindex "message logs" "preserving"
16480 If this option is set, message log files are not deleted when messages are
16481 completed. Instead, they are moved to a sub-directory of the spool directory
16482 called &_msglog.OLD_&, where they remain available for statistical or debugging
16483 purposes. This is a dangerous option to set on systems with any appreciable
16484 volume of mail. Use with care!
16485
16486
16487 .option primary_hostname main string "see below"
16488 .cindex "name" "of local host"
16489 .cindex "host" "name of local"
16490 .cindex "local host" "name of"
16491 .vindex "&$primary_hostname$&"
16492 This specifies the name of the current host. It is used in the default EHLO or
16493 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16494 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16495 The value is also used by default in some SMTP response messages from an Exim
16496 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16497
16498 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16499 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16500 contains only one component, Exim passes it to &[gethostbyname()]& (or
16501 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16502 version. The variable &$primary_hostname$& contains the host name, whether set
16503 explicitly by this option, or defaulted.
16504
16505
16506 .option print_topbitchars main boolean false
16507 .cindex "printing characters"
16508 .cindex "8-bit characters"
16509 By default, Exim considers only those characters whose codes lie in the range
16510 32&--126 to be printing characters. In a number of circumstances (for example,
16511 when writing log entries) non-printing characters are converted into escape
16512 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16513 is set, code values of 128 and above are also considered to be printing
16514 characters.
16515
16516 This option also affects the header syntax checks performed by the
16517 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16518 the user's full name when constructing From: and Sender: addresses (as
16519 described in section &<<SECTconstr>>&). Setting this option can cause
16520 Exim to generate eight bit message headers that do not conform to the
16521 standards.
16522
16523
16524 .option process_log_path main string unset
16525 .cindex "process log path"
16526 .cindex "log" "process log"
16527 .cindex "&'exiwhat'&"
16528 This option sets the name of the file to which an Exim process writes its
16529 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16530 utility script. If this option is unset, the file called &_exim-process.info_&
16531 in Exim's spool directory is used. The ability to specify the name explicitly
16532 can be useful in environments where two different Exims are running, using
16533 different spool directories.
16534
16535
16536 .option prod_requires_admin main boolean true
16537 .cindex "restricting access to features"
16538 .oindex "&%-M%&"
16539 .oindex "&%-R%&"
16540 .oindex "&%-q%&"
16541 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16542 admin user unless &%prod_requires_admin%& is set false. See also
16543 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16544
16545
16546 .option qualify_domain main string "see below"
16547 .cindex "domain" "for qualifying addresses"
16548 .cindex "address" "qualification"
16549 This option specifies the domain name that is added to any envelope sender
16550 addresses that do not have a domain qualification. It also applies to
16551 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16552 are accepted by default only for locally-generated messages. Qualification is
16553 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16554 locally-generated messages, unless the &%-bnq%& command line option is used.
16555
16556 Messages from external sources must always contain fully qualified addresses,
16557 unless the sending host matches &%sender_unqualified_hosts%& or
16558 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16559 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16560 necessary. Internally, Exim always works with fully qualified envelope
16561 addresses. If &%qualify_domain%& is not set, it defaults to the
16562 &%primary_hostname%& value.
16563
16564
16565 .option qualify_recipient main string "see below"
16566 This option allows you to specify a different domain for qualifying recipient
16567 addresses to the one that is used for senders. See &%qualify_domain%& above.
16568
16569
16570
16571 .option queue_domains main "domain list&!!" unset
16572 .cindex "domain" "specifying non-immediate delivery"
16573 .cindex "queueing incoming messages"
16574 .cindex "message" "queueing certain domains"
16575 This option lists domains for which immediate delivery is not required.
16576 A delivery process is started whenever a message is received, but only those
16577 domains that do not match are processed. All other deliveries wait until the
16578 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16579
16580
16581 .option queue_list_requires_admin main boolean true
16582 .cindex "restricting access to features"
16583 .oindex "&%-bp%&"
16584 The &%-bp%& command-line option, which lists the messages that are on the
16585 queue, requires the caller to be an admin user unless
16586 &%queue_list_requires_admin%& is set false.
16587 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16588
16589
16590 .option queue_only main boolean false
16591 .cindex "queueing incoming messages"
16592 .cindex "message" "queueing unconditionally"
16593 If &%queue_only%& is set, a delivery process is not automatically started
16594 whenever a message is received. Instead, the message waits in the queue for the
16595 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16596 delivered immediately when certain conditions (such as heavy load) occur.
16597
16598 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16599 and &%-odi%& command line options override &%queue_only%& unless
16600 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16601 &%queue_only_load%&, and &%smtp_accept_queue%&.
16602
16603
16604 .option queue_only_file main string unset
16605 .cindex "queueing incoming messages"
16606 .cindex "message" "queueing by file existence"
16607 This option can be set to a colon-separated list of absolute path names, each
16608 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16609 it tests for the existence of each listed path using a call to &[stat()]&. For
16610 each path that exists, the corresponding queueing option is set.
16611 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16612 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16613 .code
16614 queue_only_file = smtp/some/file
16615 .endd
16616 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16617 &_/some/file_& exists.
16618
16619
16620 .option queue_only_load main fixed-point unset
16621 .cindex "load average"
16622 .cindex "queueing incoming messages"
16623 .cindex "message" "queueing by load"
16624 If the system load average is higher than this value, incoming messages from
16625 all sources are queued, and no automatic deliveries are started. If this
16626 happens during local or remote SMTP input, all subsequent messages received on
16627 the same SMTP connection are queued by default, whatever happens to the load in
16628 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16629 false.
16630
16631 Deliveries will subsequently be performed by queue runner processes. This
16632 option has no effect on ancient operating systems on which Exim cannot
16633 determine the load average. See also &%deliver_queue_load_max%& and
16634 &%smtp_load_reserve%&.
16635
16636
16637 .option queue_only_load_latch main boolean true
16638 .cindex "load average" "re-evaluating per message"
16639 When this option is true (the default), once one message has been queued
16640 because the load average is higher than the value set by &%queue_only_load%&,
16641 all subsequent messages received on the same SMTP connection are also queued.
16642 This is a deliberate choice; even though the load average may fall below the
16643 threshold, it doesn't seem right to deliver later messages on the same
16644 connection when not delivering earlier ones. However, there are special
16645 circumstances such as very long-lived connections from scanning appliances
16646 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16647 should be set false. This causes the value of the load average to be
16648 re-evaluated for each message.
16649
16650
16651 .option queue_only_override main boolean true
16652 .cindex "queueing incoming messages"
16653 When this option is true, the &%-od%&&'x'& command line options override the
16654 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16655 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16656 to override; they are accepted, but ignored.
16657
16658
16659 .option queue_run_in_order main boolean false
16660 .cindex "queue runner" "processing messages in order"
16661 If this option is set, queue runs happen in order of message arrival instead of
16662 in an arbitrary order. For this to happen, a complete list of the entire queue
16663 must be set up before the deliveries start. When the queue is all held in a
16664 single directory (the default), a single list is created for both the ordered
16665 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16666 single list is not created when &%queue_run_in_order%& is false. In this case,
16667 the sub-directories are processed one at a time (in a random order), and this
16668 avoids setting up one huge list for the whole queue. Thus, setting
16669 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16670 when the queue is large, because of the extra work in setting up the single,
16671 large list. In most situations, &%queue_run_in_order%& should not be set.
16672
16673
16674
16675 .option queue_run_max main integer&!! 5
16676 .cindex "queue runner" "maximum number of"
16677 This controls the maximum number of queue runner processes that an Exim daemon
16678 can run simultaneously. This does not mean that it starts them all at once,
16679 but rather that if the maximum number are still running when the time comes to
16680 start another one, it refrains from starting another one. This can happen with
16681 very large queues and/or very sluggish deliveries. This option does not,
16682 however, interlock with other processes, so additional queue runners can be
16683 started by other means, or by killing and restarting the daemon.
16684
16685 Setting this option to zero does not suppress queue runs; rather, it disables
16686 the limit, allowing any number of simultaneous queue runner processes to be
16687 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16688 the daemon's command line.
16689
16690 .cindex queues named
16691 .cindex "named queues"
16692 To set limits for different named queues use
16693 an expansion depending on the &$queue_name$& variable.
16694
16695 .option queue_smtp_domains main "domain list&!!" unset
16696 .cindex "queueing incoming messages"
16697 .cindex "message" "queueing remote deliveries"
16698 When this option is set, a delivery process is started whenever a message is
16699 received, routing is performed, and local deliveries take place.
16700 However, if any SMTP deliveries are required for domains that match
16701 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16702 message waits in the queue for the next queue run. Since routing of the message
16703 has taken place, Exim knows to which remote hosts it must be delivered, and so
16704 when the queue run happens, multiple messages for the same host are delivered
16705 over a single SMTP connection. The &%-odqs%& command line option causes all
16706 SMTP deliveries to be queued in this way, and is equivalent to setting
16707 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16708 &%queue_domains%&.
16709
16710
16711 .option receive_timeout main time 0s
16712 .cindex "timeout" "for non-SMTP input"
16713 This option sets the timeout for accepting a non-SMTP message, that is, the
16714 maximum time that Exim waits when reading a message on the standard input. If
16715 the value is zero, it will wait forever. This setting is overridden by the
16716 &%-or%& command line option. The timeout for incoming SMTP messages is
16717 controlled by &%smtp_receive_timeout%&.
16718
16719 .option received_header_text main string&!! "see below"
16720 .cindex "customizing" "&'Received:'& header"
16721 .cindex "&'Received:'& header line" "customizing"
16722 This string defines the contents of the &'Received:'& message header that is
16723 added to each message, except for the timestamp, which is automatically added
16724 on at the end (preceded by a semicolon). The string is expanded each time it is
16725 used. If the expansion yields an empty string, no &'Received:'& header line is
16726 added to the message. Otherwise, the string should start with the text
16727 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16728 header lines.
16729 .new
16730 The default setting is:
16731
16732 .code
16733 received_header_text = Received: \
16734   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16735     {${if def:sender_ident \
16736       {from ${quote_local_part:$sender_ident} }}\
16737         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16738   by $primary_hostname \
16739   ${if def:received_protocol {with $received_protocol }}\
16740   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16741   (Exim $version_number)\n\t\
16742   ${if def:sender_address \
16743   {(envelope-from <$sender_address>)\n\t}}\
16744   id $message_exim_id\
16745   ${if def:received_for {\n\tfor $received_for}}
16746 .endd
16747 .wen
16748
16749 The reference to the TLS cipher is omitted when Exim is built without TLS
16750 support. The use of conditional expansions ensures that this works for both
16751 locally generated messages and messages received from remote hosts, giving
16752 header lines such as the following:
16753 .code
16754 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16755 by marley.carol.example with esmtp (Exim 4.00)
16756 (envelope-from <bob@carol.example>)
16757 id 16IOWa-00019l-00
16758 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16759 Received: by scrooge.carol.example with local (Exim 4.00)
16760 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16761 .endd
16762 Until the body of the message has been received, the timestamp is the time when
16763 the message started to be received. Once the body has arrived, and all policy
16764 checks have taken place, the timestamp is updated to the time at which the
16765 message was accepted.
16766
16767
16768 .option received_headers_max main integer 30
16769 .cindex "loop" "prevention"
16770 .cindex "mail loop prevention"
16771 .cindex "&'Received:'& header line" "counting"
16772 When a message is to be delivered, the number of &'Received:'& headers is
16773 counted, and if it is greater than this parameter, a mail loop is assumed to
16774 have occurred, the delivery is abandoned, and an error message is generated.
16775 This applies to both local and remote deliveries.
16776
16777
16778 .option recipient_unqualified_hosts main "host list&!!" unset
16779 .cindex "unqualified addresses"
16780 .cindex "host" "unqualified addresses from"
16781 This option lists those hosts from which Exim is prepared to accept unqualified
16782 recipient addresses in message envelopes. The addresses are made fully
16783 qualified by the addition of the &%qualify_recipient%& value. This option also
16784 affects message header lines. Exim does not reject unqualified recipient
16785 addresses in headers, but it qualifies them only if the message came from a
16786 host that matches &%recipient_unqualified_hosts%&,
16787 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16788 option was not set.
16789
16790
16791 .option recipients_max main integer 0
16792 .cindex "limit" "number of recipients"
16793 .cindex "recipient" "maximum number"
16794 If this option is set greater than zero, it specifies the maximum number of
16795 original recipients for any message. Additional recipients that are generated
16796 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16797 all recipients over the limit; earlier recipients are delivered as normal.
16798 Non-SMTP messages with too many recipients are failed, and no deliveries are
16799 done.
16800
16801 .cindex "RCPT" "maximum number of incoming"
16802 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16803 RCPT commands in a single message.
16804
16805
16806 .option recipients_max_reject main boolean false
16807 If this option is set true, Exim rejects SMTP messages containing too many
16808 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16809 error to the eventual DATA command. Otherwise (the default) it gives a 452
16810 error to the surplus RCPT commands and accepts the message on behalf of the
16811 initial set of recipients. The remote server should then re-send the message
16812 for the remaining recipients at a later time.
16813
16814
16815 .option remote_max_parallel main integer 2
16816 .cindex "delivery" "parallelism for remote"
16817 This option controls parallel delivery of one message to a number of remote
16818 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16819 does all the remote deliveries for a message one by one. Otherwise, if a single
16820 message has to be delivered to more than one remote host, or if several copies
16821 have to be sent to the same remote host, up to &%remote_max_parallel%&
16822 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16823 deliveries are required, the maximum number of processes are started, and as
16824 each one finishes, another is begun. The order of starting processes is the
16825 same as if sequential delivery were being done, and can be controlled by the
16826 &%remote_sort_domains%& option. If parallel delivery takes place while running
16827 with debugging turned on, the debugging output from each delivery process is
16828 tagged with its process id.
16829
16830 This option controls only the maximum number of parallel deliveries for one
16831 message in one Exim delivery process. Because Exim has no central queue
16832 manager, there is no way of controlling the total number of simultaneous
16833 deliveries if the configuration allows a delivery attempt as soon as a message
16834 is received.
16835
16836 .cindex "number of deliveries"
16837 .cindex "delivery" "maximum number of"
16838 If you want to control the total number of deliveries on the system, you
16839 need to set the &%queue_only%& option. This ensures that all incoming messages
16840 are added to the queue without starting a delivery process. Then set up an Exim
16841 daemon to start queue runner processes at appropriate intervals (probably
16842 fairly often, for example, every minute), and limit the total number of queue
16843 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16844 delivers only one message at a time, the maximum number of deliveries that can
16845 then take place at once is &%queue_run_max%& multiplied by
16846 &%remote_max_parallel%&.
16847
16848 If it is purely remote deliveries you want to control, use
16849 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16850 doing the SMTP routing before queueing, so that several messages for the same
16851 host will eventually get delivered down the same connection.
16852
16853
16854 .option remote_sort_domains main "domain list&!!" unset
16855 .cindex "sorting remote deliveries"
16856 .cindex "delivery" "sorting remote"
16857 When there are a number of remote deliveries for a message, they are sorted by
16858 domain into the order given by this list. For example,
16859 .code
16860 remote_sort_domains = *.cam.ac.uk:*.uk
16861 .endd
16862 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16863 then to those in the &%uk%& domain, then to any others.
16864
16865
16866 .option retry_data_expire main time 7d
16867 .cindex "hints database" "data expiry"
16868 This option sets a &"use before"& time on retry information in Exim's hints
16869 database. Any older retry data is ignored. This means that, for example, once a
16870 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16871 past failures.
16872
16873
16874 .option retry_interval_max main time 24h
16875 .cindex "retry" "limit on interval"
16876 .cindex "limit" "on retry interval"
16877 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16878 intervals between delivery attempts for messages that cannot be delivered
16879 straight away. This option sets an overall limit to the length of time between
16880 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16881 the default value.
16882
16883
16884 .option return_path_remove main boolean true
16885 .cindex "&'Return-path:'& header line" "removing"
16886 RFC 2821, section 4.4, states that an SMTP server must insert a
16887 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16888 The &'Return-path:'& header preserves the sender address as received in the
16889 MAIL command. This description implies that this header should not be present
16890 in an incoming message. If &%return_path_remove%& is true, any existing
16891 &'Return-path:'& headers are removed from messages at the time they are
16892 received. Exim's transports have options for adding &'Return-path:'& headers at
16893 the time of delivery. They are normally used only for final local deliveries.
16894
16895
16896 .option return_size_limit main integer 100K
16897 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16898
16899
16900 .option rfc1413_hosts main "host list&!!" @[]
16901 .cindex "RFC 1413"
16902 .cindex "host" "for RFC 1413 calls"
16903 RFC 1413 identification calls are made to any client host which matches
16904 an item in the list.
16905 The default value specifies just this host, being any local interface
16906 for the system.
16907
16908 .option rfc1413_query_timeout main time 0s
16909 .cindex "RFC 1413" "query timeout"
16910 .cindex "timeout" "for RFC 1413 call"
16911 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16912 no RFC 1413 calls are ever made.
16913
16914
16915 .option sender_unqualified_hosts main "host list&!!" unset
16916 .cindex "unqualified addresses"
16917 .cindex "host" "unqualified addresses from"
16918 This option lists those hosts from which Exim is prepared to accept unqualified
16919 sender addresses. The addresses are made fully qualified by the addition of
16920 &%qualify_domain%&. This option also affects message header lines. Exim does
16921 not reject unqualified addresses in headers that contain sender addresses, but
16922 it qualifies them only if the message came from a host that matches
16923 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16924 using TCP/IP), and the &%-bnq%& option was not set.
16925
16926 .option add_environment main "string list" empty
16927 .cindex "environment"
16928 This option allows to add individual environment variables that the
16929 currently linked libraries and programs in child processes use. The
16930 default list is empty.
16931
16932
16933 .option slow_lookup_log main integer 0
16934 .cindex "logging" "slow lookups"
16935 .cindex "dns" "logging slow lookups"
16936 This option controls logging of slow lookups.
16937 If the value is nonzero it is taken as a number of milliseconds
16938 and lookups taking longer than this are logged.
16939 Currently this applies only to DNS lookups.
16940
16941
16942
16943 .option smtp_accept_keepalive main boolean true
16944 .cindex "keepalive" "on incoming connection"
16945 This option controls the setting of the SO_KEEPALIVE option on incoming
16946 TCP/IP socket connections. When set, it causes the kernel to probe idle
16947 connections periodically, by sending packets with &"old"& sequence numbers. The
16948 other end of the connection should send an acknowledgment if the connection is
16949 still okay or a reset if the connection has been aborted. The reason for doing
16950 this is that it has the beneficial effect of freeing up certain types of
16951 connection that can get stuck when the remote host is disconnected without
16952 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16953 hours to detect unreachable hosts.
16954
16955
16956
16957 .option smtp_accept_max main integer 20
16958 .cindex "limit" "incoming SMTP connections"
16959 .cindex "SMTP" "incoming connection count"
16960 .cindex "inetd"
16961 This option specifies the maximum number of simultaneous incoming SMTP calls
16962 that Exim will accept. It applies only to the listening daemon; there is no
16963 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16964 value is set to zero, no limit is applied. However, it is required to be
16965 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16966 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16967
16968 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16969 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16970 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16971 and &%smtp_load_reserve%& are then checked before accepting the connection.
16972
16973
16974 .option smtp_accept_max_nonmail main integer 10
16975 .cindex "limit" "non-mail SMTP commands"
16976 .cindex "SMTP" "limiting non-mail commands"
16977 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16978 the connection if there are too many. This option defines &"too many"&. The
16979 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16980 client looping sending EHLO, for example. The check is applied only if the
16981 client host matches &%smtp_accept_max_nonmail_hosts%&.
16982
16983 When a new message is expected, one occurrence of RSET is not counted. This
16984 allows a client to send one RSET between messages (this is not necessary,
16985 but some clients do it). Exim also allows one uncounted occurrence of HELO
16986 or EHLO, and one occurrence of STARTTLS between messages. After
16987 starting up a TLS session, another EHLO is expected, and so it too is not
16988 counted. The first occurrence of AUTH in a connection, or immediately
16989 following STARTTLS is not counted. Otherwise, all commands other than
16990 MAIL, RCPT, DATA, and QUIT are counted.
16991
16992
16993 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16994 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16995 check by setting this option. The default value makes it apply to all hosts. By
16996 changing the value, you can exclude any badly-behaved hosts that you have to
16997 live with.
16998
16999
17000 . Allow this long option name to split; give it unsplit as a fifth argument
17001 . for the automatic .oindex that is generated by .option.
17002 . We insert " &~&~" which is both pretty nasty visually and results in
17003 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17004 . zero-width-space, which would be nicer visually and results in (at least)
17005 . html that Firefox will split on when it's forced to reflow (rather than
17006 . inserting a horizontal scrollbar).  However, the text is still not
17007 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17008 . the option name to split.
17009
17010 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17011          smtp_accept_max_per_connection
17012 .cindex "SMTP" "limiting incoming message count"
17013 .cindex "limit" "messages per SMTP connection"
17014 The value of this option limits the number of MAIL commands that Exim is
17015 prepared to accept over a single SMTP connection, whether or not each command
17016 results in the transfer of a message. After the limit is reached, a 421
17017 response is given to subsequent MAIL commands. This limit is a safety
17018 precaution against a client that goes mad (incidents of this type have been
17019 seen).
17020
17021
17022 .option smtp_accept_max_per_host main string&!! unset
17023 .cindex "limit" "SMTP connections from one host"
17024 .cindex "host" "limiting SMTP connections from"
17025 This option restricts the number of simultaneous IP connections from a single
17026 host (strictly, from a single IP address) to the Exim daemon. The option is
17027 expanded, to enable different limits to be applied to different hosts by
17028 reference to &$sender_host_address$&. Once the limit is reached, additional
17029 connection attempts from the same host are rejected with error code 421. This
17030 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17031 of zero imposes no limit. If this option is set greater than zero, it is
17032 required that &%smtp_accept_max%& be non-zero.
17033
17034 &*Warning*&: When setting this option you should not use any expansion
17035 constructions that take an appreciable amount of time. The expansion and test
17036 happen in the main daemon loop, in order to reject additional connections
17037 without forking additional processes (otherwise a denial-of-service attack
17038 could cause a vast number or processes to be created). While the daemon is
17039 doing this processing, it cannot accept any other incoming connections.
17040
17041
17042
17043 .option smtp_accept_queue main integer 0
17044 .cindex "SMTP" "incoming connection count"
17045 .cindex "queueing incoming messages"
17046 .cindex "message" "queueing by SMTP connection count"
17047 If the number of simultaneous incoming SMTP connections being handled via the
17048 listening daemon exceeds this value, messages received by SMTP are just placed
17049 in the queue; no delivery processes are started automatically. The count is
17050 fixed at the start of an SMTP connection. It cannot be updated in the
17051 subprocess that receives messages, and so the queueing or not queueing applies
17052 to all messages received in the same connection.
17053
17054 A value of zero implies no limit, and clearly any non-zero value is useful only
17055 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17056 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17057 various &%-od%&&'x'& command line options.
17058
17059
17060 . See the comment on smtp_accept_max_per_connection
17061
17062 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17063          smtp_accept_queue_per_connection
17064 .cindex "queueing incoming messages"
17065 .cindex "message" "queueing by message count"
17066 This option limits the number of delivery processes that Exim starts
17067 automatically when receiving messages via SMTP, whether via the daemon or by
17068 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17069 and the number of messages received in a single SMTP session exceeds this
17070 number, subsequent messages are placed in the queue, but no delivery processes
17071 are started. This helps to limit the number of Exim processes when a server
17072 restarts after downtime and there is a lot of mail waiting for it on other
17073 systems. On large systems, the default should probably be increased, and on
17074 dial-in client systems it should probably be set to zero (that is, disabled).
17075
17076
17077 .option smtp_accept_reserve main integer 0
17078 .cindex "SMTP" "incoming call count"
17079 .cindex "host" "reserved"
17080 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17081 number of SMTP connections that are reserved for connections from the hosts
17082 that are specified in &%smtp_reserve_hosts%&. The value set in
17083 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17084 restricted to this number of connections; the option specifies a minimum number
17085 of connection slots for them, not a maximum. It is a guarantee that this group
17086 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17087 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17088 individual host.
17089
17090 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17091 set to 5, once there are 45 active connections (from any hosts), new
17092 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17093 provided the other criteria for acceptance are met.
17094
17095
17096 .option smtp_active_hostname main string&!! unset
17097 .cindex "host" "name in SMTP responses"
17098 .cindex "SMTP" "host name in responses"
17099 .vindex "&$primary_hostname$&"
17100 This option is provided for multi-homed servers that want to masquerade as
17101 several different hosts. At the start of an incoming SMTP connection, its value
17102 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17103 responses. For example, it is used as domain name in the response to an
17104 incoming HELO or EHLO command.
17105
17106 .vindex "&$smtp_active_hostname$&"
17107 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17108 is saved with any messages that are received. It is therefore available for use
17109 in routers and transports when the message is later delivered.
17110
17111 If this option is unset, or if its expansion is forced to fail, or if the
17112 expansion results in an empty string, the value of &$primary_hostname$& is
17113 used. Other expansion failures cause a message to be written to the main and
17114 panic logs, and the SMTP command receives a temporary error. Typically, the
17115 value of &%smtp_active_hostname%& depends on the incoming interface address.
17116 For example:
17117 .code
17118 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17119   {cox.mydomain}{box.mydomain}}
17120 .endd
17121
17122 Although &$smtp_active_hostname$& is primarily concerned with incoming
17123 messages, it is also used as the default for HELO commands in callout
17124 verification if there is no remote transport from which to obtain a
17125 &%helo_data%& value.
17126
17127 .option smtp_banner main string&!! "see below"
17128 .cindex "SMTP" "welcome banner"
17129 .cindex "banner for SMTP"
17130 .cindex "welcome banner for SMTP"
17131 .cindex "customizing" "SMTP banner"
17132 This string, which is expanded every time it is used, is output as the initial
17133 positive response to an SMTP connection. The default setting is:
17134 .code
17135 smtp_banner = $smtp_active_hostname ESMTP Exim \
17136   $version_number $tod_full
17137 .endd
17138 Failure to expand the string causes a panic error. If you want to create a
17139 multiline response to the initial SMTP connection, use &"\n"& in the string at
17140 appropriate points, but not at the end. Note that the 220 code is not included
17141 in this string. Exim adds it automatically (several times in the case of a
17142 multiline response).
17143
17144
17145 .option smtp_check_spool_space main boolean true
17146 .cindex "checking disk space"
17147 .cindex "disk space, checking"
17148 .cindex "spool directory" "checking space"
17149 When this option is set, if an incoming SMTP session encounters the SIZE
17150 option on a MAIL command, it checks that there is enough space in the
17151 spool directory's partition to accept a message of that size, while still
17152 leaving free the amount specified by &%check_spool_space%& (even if that value
17153 is zero). If there isn't enough space, a temporary error code is returned.
17154
17155
17156 .option smtp_connect_backlog main integer 20
17157 .cindex "connection backlog"
17158 .cindex "SMTP" "connection backlog"
17159 .cindex "backlog of connections"
17160 This option specifies a maximum number of waiting SMTP connections. Exim passes
17161 this value to the TCP/IP system when it sets up its listener. Once this number
17162 of connections are waiting for the daemon's attention, subsequent connection
17163 attempts are refused at the TCP/IP level. At least, that is what the manuals
17164 say; in some circumstances such connection attempts have been observed to time
17165 out instead. For large systems it is probably a good idea to increase the
17166 value (to 50, say). It also gives some protection against denial-of-service
17167 attacks by SYN flooding.
17168
17169
17170 .option smtp_enforce_sync main boolean true
17171 .cindex "SMTP" "synchronization checking"
17172 .cindex "synchronization checking in SMTP"
17173 The SMTP protocol specification requires the client to wait for a response from
17174 the server at certain points in the dialogue. Without PIPELINING these
17175 synchronization points are after every command; with PIPELINING they are
17176 fewer, but they still exist.
17177
17178 Some spamming sites send out a complete set of SMTP commands without waiting
17179 for any response. Exim protects against this by rejecting a message if the
17180 client has sent further input when it should not have. The error response &"554
17181 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17182 for this error cannot be perfect because of transmission delays (unexpected
17183 input may be on its way but not yet received when Exim checks). However, it
17184 does detect many instances.
17185
17186 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17187 If you want to disable the check selectively (for example, only for certain
17188 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17189 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17190
17191
17192
17193 .option smtp_etrn_command main string&!! unset
17194 .cindex "ETRN" "command to be run"
17195 .vindex "&$domain$&"
17196 If this option is set, the given command is run whenever an SMTP ETRN
17197 command is received from a host that is permitted to issue such commands (see
17198 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17199 are independently expanded. The expansion variable &$domain$& is set to the
17200 argument of the ETRN command, and no syntax checking is done on it. For
17201 example:
17202 .code
17203 smtp_etrn_command = /etc/etrn_command $domain \
17204                     $sender_host_address
17205 .endd
17206 A new process is created to run the command, but Exim does not wait for it to
17207 complete. Consequently, its status cannot be checked. If the command cannot be
17208 run, a line is written to the panic log, but the ETRN caller still receives
17209 a 250 success response. Exim is normally running under its own uid when
17210 receiving SMTP, so it is not possible for it to change the uid before running
17211 the command.
17212
17213
17214 .option smtp_etrn_serialize main boolean true
17215 .cindex "ETRN" "serializing"
17216 When this option is set, it prevents the simultaneous execution of more than
17217 one identical command as a result of ETRN in an SMTP connection. See
17218 section &<<SECTETRN>>& for details.
17219
17220
17221 .option smtp_load_reserve main fixed-point unset
17222 .cindex "load average"
17223 If the system load average ever gets higher than this, incoming SMTP calls are
17224 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17225 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17226 the load is over the limit. The option has no effect on ancient operating
17227 systems on which Exim cannot determine the load average. See also
17228 &%deliver_queue_load_max%& and &%queue_only_load%&.
17229
17230
17231
17232 .option smtp_max_synprot_errors main integer 3
17233 .cindex "SMTP" "limiting syntax and protocol errors"
17234 .cindex "limit" "SMTP syntax and protocol errors"
17235 Exim rejects SMTP commands that contain syntax or protocol errors. In
17236 particular, a syntactically invalid email address, as in this command:
17237 .code
17238 RCPT TO:<abc xyz@a.b.c>
17239 .endd
17240 causes immediate rejection of the command, before any other tests are done.
17241 (The ACL cannot be run if there is no valid address to set up for it.) An
17242 example of a protocol error is receiving RCPT before MAIL. If there are
17243 too many syntax or protocol errors in one SMTP session, the connection is
17244 dropped. The limit is set by this option.
17245
17246 .cindex "PIPELINING" "expected errors"
17247 When the PIPELINING extension to SMTP is in use, some protocol errors are
17248 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17249 Exim assumes that PIPELINING will be used if it advertises it (see
17250 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17251 not count towards the limit.
17252
17253
17254
17255 .option smtp_max_unknown_commands main integer 3
17256 .cindex "SMTP" "limiting unknown commands"
17257 .cindex "limit" "unknown SMTP commands"
17258 If there are too many unrecognized commands in an incoming SMTP session, an
17259 Exim server drops the connection. This is a defence against some kinds of abuse
17260 that subvert web
17261 clients
17262 into making connections to SMTP ports; in these circumstances, a number of
17263 non-SMTP command lines are sent first.
17264
17265
17266
17267 .option smtp_ratelimit_hosts main "host list&!!" unset
17268 .cindex "SMTP" "rate limiting"
17269 .cindex "limit" "rate of message arrival"
17270 .cindex "RCPT" "rate limiting"
17271 Some sites find it helpful to be able to limit the rate at which certain hosts
17272 can send them messages, and the rate at which an individual message can specify
17273 recipients.
17274
17275 Exim has two rate-limiting facilities. This section describes the older
17276 facility, which can limit rates within a single connection. The newer
17277 &%ratelimit%& ACL condition can limit rates across all connections. See section
17278 &<<SECTratelimiting>>& for details of the newer facility.
17279
17280 When a host matches &%smtp_ratelimit_hosts%&, the values of
17281 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17282 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17283 respectively. Each option, if set, must contain a set of four comma-separated
17284 values:
17285
17286 .ilist
17287 A threshold, before which there is no rate limiting.
17288 .next
17289 An initial time delay. Unlike other times in Exim, numbers with decimal
17290 fractional parts are allowed here.
17291 .next
17292 A factor by which to increase the delay each time.
17293 .next
17294 A maximum value for the delay. This should normally be less than 5 minutes,
17295 because after that time, the client is liable to timeout the SMTP command.
17296 .endlist
17297
17298 For example, these settings have been used successfully at the site which
17299 first suggested this feature, for controlling mail from their customers:
17300 .code
17301 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17302 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17303 .endd
17304 The first setting specifies delays that are applied to MAIL commands after
17305 two have been received over a single connection. The initial delay is 0.5
17306 seconds, increasing by a factor of 1.05 each time. The second setting applies
17307 delays to RCPT commands when more than four occur in a single message.
17308
17309
17310 .option smtp_ratelimit_mail main string unset
17311 See &%smtp_ratelimit_hosts%& above.
17312
17313
17314 .option smtp_ratelimit_rcpt main string unset
17315 See &%smtp_ratelimit_hosts%& above.
17316
17317
17318 .option smtp_receive_timeout main time&!! 5m
17319 .cindex "timeout" "for SMTP input"
17320 .cindex "SMTP" "input timeout"
17321 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17322 input, including batch SMTP. If a line of input (either an SMTP command or a
17323 data line) is not received within this time, the SMTP connection is dropped and
17324 the message is abandoned.
17325 A line is written to the log containing one of the following messages:
17326 .code
17327 SMTP command timeout on connection from...
17328 SMTP data timeout on connection from...
17329 .endd
17330 The former means that Exim was expecting to read an SMTP command; the latter
17331 means that it was in the DATA phase, reading the contents of a message.
17332
17333 If the first character of the option is a &"$"& the option is
17334 expanded before use and may depend on
17335 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17336
17337
17338 .oindex "&%-os%&"
17339 The value set by this option can be overridden by the
17340 &%-os%& command-line option. A setting of zero time disables the timeout, but
17341 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17342 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17343 timeout is controlled by &%receive_timeout%& and &%-or%&.
17344
17345
17346 .option smtp_reserve_hosts main "host list&!!" unset
17347 This option defines hosts for which SMTP connections are reserved; see
17348 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17349
17350
17351 .option smtp_return_error_details main boolean false
17352 .cindex "SMTP" "details policy failures"
17353 .cindex "policy control" "rejection, returning details"
17354 In the default state, Exim uses bland messages such as
17355 &"Administrative prohibition"& when it rejects SMTP commands for policy
17356 reasons. Many sysadmins like this because it gives away little information
17357 to spammers. However, some other sysadmins who are applying strict checking
17358 policies want to give out much fuller information about failures. Setting
17359 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17360 example, instead of &"Administrative prohibition"&, it might give:
17361 .code
17362 550-Rejected after DATA: '>' missing at end of address:
17363 550 failing address in "From" header is: <user@dom.ain
17364 .endd
17365
17366
17367 .option smtputf8_advertise_hosts main "host list&!!" *
17368 .cindex "SMTPUTF8" "advertising"
17369 When Exim is built with support for internationalised mail names,
17370 the availability thereof is advertised in
17371 response to EHLO only to those client hosts that match this option. See
17372 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17373
17374
17375 .option spamd_address main string "127.0.0.1 783"
17376 This option is available when Exim is compiled with the content-scanning
17377 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17378 See section &<<SECTscanspamass>>& for more details.
17379
17380
17381
17382 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17383 This option is available when Exim is compiled with SPF support.
17384 See section &<<SECSPF>>& for more details.
17385
17386
17387
17388 .option split_spool_directory main boolean false
17389 .cindex "multiple spool directories"
17390 .cindex "spool directory" "split"
17391 .cindex "directories, multiple"
17392 If this option is set, it causes Exim to split its input directory into 62
17393 subdirectories, each with a single alphanumeric character as its name. The
17394 sixth character of the message id is used to allocate messages to
17395 subdirectories; this is the least significant base-62 digit of the time of
17396 arrival of the message.
17397
17398 Splitting up the spool in this way may provide better performance on systems
17399 where there are long mail queues, by reducing the number of files in any one
17400 directory. The msglog directory is also split up in a similar way to the input
17401 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17402 are still placed in the single directory &_msglog.OLD_&.
17403
17404 It is not necessary to take any special action for existing messages when
17405 changing &%split_spool_directory%&. Exim notices messages that are in the
17406 &"wrong"& place, and continues to process them. If the option is turned off
17407 after a period of being on, the subdirectories will eventually empty and be
17408 automatically deleted.
17409
17410 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17411 changes. Instead of creating a list of all messages in the queue, and then
17412 trying to deliver each one, in turn, it constructs a list of those in one
17413 sub-directory and tries to deliver them, before moving on to the next
17414 sub-directory. The sub-directories are processed in a random order. This
17415 spreads out the scanning of the input directories, and uses less memory. It is
17416 particularly beneficial when there are lots of messages in the queue. However,
17417 if &%queue_run_in_order%& is set, none of this new processing happens. The
17418 entire queue has to be scanned and sorted before any deliveries can start.
17419
17420
17421 .option spool_directory main string&!! "set at compile time"
17422 .cindex "spool directory" "path to"
17423 This defines the directory in which Exim keeps its spool, that is, the messages
17424 it is waiting to deliver. The default value is taken from the compile-time
17425 configuration setting, if there is one. If not, this option must be set. The
17426 string is expanded, so it can contain, for example, a reference to
17427 &$primary_hostname$&.
17428
17429 If the spool directory name is fixed on your installation, it is recommended
17430 that you set it at build time rather than from this option, particularly if the
17431 log files are being written to the spool directory (see &%log_file_path%&).
17432 Otherwise log files cannot be used for errors that are detected early on, such
17433 as failures in the configuration file.
17434
17435 By using this option to override the compiled-in path, it is possible to run
17436 tests of Exim without using the standard spool.
17437
17438 .option spool_wireformat main boolean false
17439 .cindex "spool directory" "file formats"
17440 If this option is set, Exim may for some messages use an alternative format
17441 for data-files in the spool which matches the wire format.
17442 Doing this permits more efficient message reception and transmission.
17443 Currently it is only done for messages received using the ESMTP CHUNKING
17444 option.
17445
17446 The following variables will not have useful values:
17447 .code
17448 $max_received_linelength
17449 $body_linecount
17450 $body_zerocount
17451 .endd
17452
17453 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17454 and any external programs which are passed a reference to a message data file
17455 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17456 will need to be aware of the different formats potentially available.
17457
17458 Using any of the ACL conditions noted will negate the reception benefit
17459 (as a Unix-mbox-format file is constructed for them).
17460 The transmission benefit is maintained.
17461
17462 .option sqlite_lock_timeout main time 5s
17463 .cindex "sqlite lookup type" "lock timeout"
17464 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17465 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17466
17467 .option strict_acl_vars main boolean false
17468 .cindex "&ACL;" "variables, handling unset"
17469 This option controls what happens if a syntactically valid but undefined ACL
17470 variable is referenced. If it is false (the default), an empty string
17471 is substituted; if it is true, an error is generated. See section
17472 &<<SECTaclvariables>>& for details of ACL variables.
17473
17474 .option strip_excess_angle_brackets main boolean false
17475 .cindex "angle brackets, excess"
17476 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17477 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17478 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17479 passed on to another MTA, the excess angle brackets are not passed on. If this
17480 option is not set, multiple pairs of angle brackets cause a syntax error.
17481
17482
17483 .option strip_trailing_dot main boolean false
17484 .cindex "trailing dot on domain"
17485 .cindex "dot" "trailing on domain"
17486 If this option is set, a trailing dot at the end of a domain in an address is
17487 ignored. If this is in the envelope and the message is passed on to another
17488 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17489 domain causes a syntax error.
17490 However, addresses in header lines are checked only when an ACL requests header
17491 syntax checking.
17492
17493
17494 .option syslog_duplication main boolean true
17495 .cindex "syslog" "duplicate log lines; suppressing"
17496 When Exim is logging to syslog, it writes the log lines for its three
17497 separate logs at different syslog priorities so that they can in principle
17498 be separated on the logging hosts. Some installations do not require this
17499 separation, and in those cases, the duplication of certain log lines is a
17500 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17501 particular log line is written to syslog. For lines that normally go to
17502 both the main log and the reject log, the reject log version (possibly
17503 containing message header lines) is written, at LOG_NOTICE priority.
17504 Lines that normally go to both the main and the panic log are written at
17505 the LOG_ALERT priority.
17506
17507
17508 .option syslog_facility main string unset
17509 .cindex "syslog" "facility; setting"
17510 This option sets the syslog &"facility"& name, used when Exim is logging to
17511 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17512 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17513 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17514 details of Exim's logging.
17515
17516
17517 .option syslog_pid main boolean true
17518 .cindex "syslog" "pid"
17519 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17520 omitted when these lines are sent to syslog. (Syslog normally prefixes
17521 the log lines with the PID of the logging process automatically.) You need
17522 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17523 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17524
17525
17526
17527 .option syslog_processname main string &`exim`&
17528 .cindex "syslog" "process name; setting"
17529 This option sets the syslog &"ident"& name, used when Exim is logging to
17530 syslog. The value must be no longer than 32 characters. See chapter
17531 &<<CHAPlog>>& for details of Exim's logging.
17532
17533
17534
17535 .option syslog_timestamp main boolean true
17536 .cindex "syslog" "timestamps"
17537 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17538 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17539 details of Exim's logging.
17540
17541
17542 .option system_filter main string&!! unset
17543 .cindex "filter" "system filter"
17544 .cindex "system filter" "specifying"
17545 .cindex "Sieve filter" "not available for system filter"
17546 This option specifies an Exim filter file that is applied to all messages at
17547 the start of each delivery attempt, before any routing is done. System filters
17548 must be Exim filters; they cannot be Sieve filters. If the system filter
17549 generates any deliveries to files or pipes, or any new mail messages, the
17550 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17551 which transports are to be used. Details of this facility are given in chapter
17552 &<<CHAPsystemfilter>>&.
17553 A forced expansion failure results in no filter operation.
17554
17555
17556 .option system_filter_directory_transport main string&!! unset
17557 .vindex "&$address_file$&"
17558 This sets the name of the transport driver that is to be used when the
17559 &%save%& command in a system message filter specifies a path ending in &"/"&,
17560 implying delivery of each message into a separate file in some directory.
17561 During the delivery, the variable &$address_file$& contains the path name.
17562
17563
17564 .option system_filter_file_transport main string&!! unset
17565 .cindex "file" "transport for system filter"
17566 This sets the name of the transport driver that is to be used when the &%save%&
17567 command in a system message filter specifies a path not ending in &"/"&. During
17568 the delivery, the variable &$address_file$& contains the path name.
17569
17570 .option system_filter_group main string unset
17571 .cindex "gid (group id)" "system filter"
17572 This option is used only when &%system_filter_user%& is also set. It sets the
17573 gid under which the system filter is run, overriding any gid that is associated
17574 with the user. The value may be numerical or symbolic.
17575
17576 .option system_filter_pipe_transport main string&!! unset
17577 .cindex "&(pipe)& transport" "for system filter"
17578 .vindex "&$address_pipe$&"
17579 This specifies the transport driver that is to be used when a &%pipe%& command
17580 is used in a system filter. During the delivery, the variable &$address_pipe$&
17581 contains the pipe command.
17582
17583
17584 .option system_filter_reply_transport main string&!! unset
17585 .cindex "&(autoreply)& transport" "for system filter"
17586 This specifies the transport driver that is to be used when a &%mail%& command
17587 is used in a system filter.
17588
17589
17590 .option system_filter_user main string unset
17591 .cindex "uid (user id)" "system filter"
17592 If this option is set to root, the system filter is run in the main Exim
17593 delivery process, as root.  Otherwise, the system filter runs in a separate
17594 process, as the given user, defaulting to the Exim run-time user.
17595 Unless the string consists entirely of digits, it
17596 is looked up in the password data. Failure to find the named user causes a
17597 configuration error. The gid is either taken from the password data, or
17598 specified by &%system_filter_group%&. When the uid is specified numerically,
17599 &%system_filter_group%& is required to be set.
17600
17601 If the system filter generates any pipe, file, or reply deliveries, the uid
17602 under which the filter is run is used when transporting them, unless a
17603 transport option overrides.
17604
17605
17606 .option tcp_nodelay main boolean true
17607 .cindex "daemon" "TCP_NODELAY on sockets"
17608 .cindex "Nagle algorithm"
17609 .cindex "TCP_NODELAY on listening sockets"
17610 If this option is set false, it stops the Exim daemon setting the
17611 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17612 turns off the &"Nagle algorithm"&, which is a way of improving network
17613 performance in interactive (character-by-character) situations. Turning it off
17614 should improve Exim's performance a bit, so that is what happens by default.
17615 However, it appears that some broken clients cannot cope, and time out. Hence
17616 this option. It affects only those sockets that are set up for listening by the
17617 daemon. Sockets created by the smtp transport for delivering mail always set
17618 TCP_NODELAY.
17619
17620
17621 .option timeout_frozen_after main time 0s
17622 .cindex "frozen messages" "timing out"
17623 .cindex "timeout" "frozen messages"
17624 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17625 message of any kind that has been in the queue for longer than the given time
17626 is automatically cancelled at the next queue run. If the frozen message is a
17627 bounce message, it is just discarded; otherwise, a bounce is sent to the
17628 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17629 If you want to timeout frozen bounce messages earlier than other kinds of
17630 frozen message, see &%ignore_bounce_errors_after%&.
17631
17632 &*Note:*& the default value of zero means no timeouts; with this setting,
17633 frozen messages remain in the queue forever (except for any frozen bounce
17634 messages that are released by &%ignore_bounce_errors_after%&).
17635
17636
17637 .option timezone main string unset
17638 .cindex "timezone, setting"
17639 .cindex "environment" "values from"
17640 The value of &%timezone%& is used to set the environment variable TZ while
17641 running Exim (if it is different on entry). This ensures that all timestamps
17642 created by Exim are in the required timezone. If you want all your timestamps
17643 to be in UTC (aka GMT) you should set
17644 .code
17645 timezone = UTC
17646 .endd
17647 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17648 or, if that is not set, from the value of the TZ environment variable when Exim
17649 is built. If &%timezone%& is set to the empty string, either at build or run
17650 time, any existing TZ variable is removed from the environment when Exim
17651 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17652 unfortunately not all, operating systems.
17653
17654
17655 .option tls_advertise_hosts main "host list&!!" *
17656 .cindex "TLS" "advertising"
17657 .cindex "encryption" "on SMTP connection"
17658 .cindex "SMTP" "encrypted connection"
17659 When Exim is built with support for TLS encrypted connections, the availability
17660 of the STARTTLS command to set up an encrypted session is advertised in
17661 response to EHLO only to those client hosts that match this option. See
17662 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17663 Note that the default value requires that a certificate be supplied
17664 using the &%tls_certificate%& option.  If TLS support for incoming connections
17665 is not required the &%tls_advertise_hosts%& option should be set empty.
17666
17667
17668 .option tls_certificate main string list&!! unset
17669 .cindex "TLS" "server certificate; location of"
17670 .cindex "certificate" "server, location of"
17671 The value of this option is expanded, and must then be a list of absolute paths to
17672 files which contain the server's certificates (in PEM format).
17673 Commonly only one file is needed.
17674 The server's private key is also
17675 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17676 &<<CHAPTLS>>& for further details.
17677
17678 &*Note*&: The certificates defined by this option are used only when Exim is
17679 receiving incoming messages as a server. If you want to supply certificates for
17680 use when sending messages as a client, you must set the &%tls_certificate%&
17681 option in the relevant &(smtp)& transport.
17682
17683 &*Note*&: If you use filenames based on IP addresses, change the list
17684 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17685
17686 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17687 when a list of more than one
17688 file is used, the &$tls_in_ourcert$& variable is unreliable.
17689 .new
17690 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17691 .wen
17692
17693 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17694 if the OpenSSL build supports TLS extensions and the TLS client sends the
17695 Server Name Indication extension, then this option and others documented in
17696 &<<SECTtlssni>>& will be re-expanded.
17697
17698 If this option is unset or empty a fresh self-signed certificate will be
17699 generated for every connection.
17700
17701 .option tls_crl main string&!! unset
17702 .cindex "TLS" "server certificate revocation list"
17703 .cindex "certificate" "revocation list for server"
17704 This option specifies a certificate revocation list. The expanded value must
17705 be the name of a file that contains CRLs in PEM format.
17706
17707 Under OpenSSL the option can specify a directory with CRL files.
17708
17709 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17710 for each signing element of the certificate chain (i.e. all but the leaf).
17711 For the file variant this can be multiple PEM blocks in the one file.
17712
17713 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17714
17715
17716 .option tls_dh_max_bits main integer 2236
17717 .cindex "TLS" "D-H bit count"
17718 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17719 the chosen TLS library.  That value might prove to be too high for
17720 interoperability.  This option provides a maximum clamp on the value
17721 suggested, trading off security for interoperability.
17722
17723 The value must be at least 1024.
17724
17725 The value 2236 was chosen because, at time of adding the option, it was the
17726 hard-coded maximum value supported by the NSS cryptographic library, as used
17727 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17728
17729 If you prefer more security and are willing to break some clients, raise this
17730 number.
17731
17732 Note that the value passed to GnuTLS for *generating* a new prime may be a
17733 little less than this figure, because GnuTLS is inexact and may produce a
17734 larger prime than requested.
17735
17736
17737 .option tls_dhparam main string&!! unset
17738 .cindex "TLS" "D-H parameters for server"
17739 The value of this option is expanded and indicates the source of DH parameters
17740 to be used by Exim.
17741
17742 .new
17743 This option is ignored for GnuTLS version 3.6.0 and later.
17744 The library manages parameter negotiation internally.
17745 .wen
17746
17747 &*Note: The Exim Maintainers strongly recommend,
17748 for other TLS library versions,
17749 using a filename with site-generated
17750 local DH parameters*&, which has been supported across all versions of Exim.  The
17751 other specific constants available are a fallback so that even when
17752 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17753
17754 If &%tls_dhparam%& is a filename starting with a &`/`&,
17755 then it names a file from which DH
17756 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17757 PKCS#3 representation of the DH prime.  If the file does not exist, for
17758 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17759 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17760 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17761 and treated as though the &%tls_dhparam%& were set to "none".
17762
17763 If this option expands to the string "none", then no DH parameters will be
17764 loaded by Exim.
17765
17766 If this option expands to the string "historic" and Exim is using GnuTLS, then
17767 Exim will attempt to load a file from inside the spool directory.  If the file
17768 does not exist, Exim will attempt to create it.
17769 See section &<<SECTgnutlsparam>>& for further details.
17770
17771 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17772 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17773
17774 In older versions of Exim the default was the 2048 bit prime described in section
17775 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17776 in IKE is assigned number 23.
17777
17778 Otherwise, the option must expand to the name used by Exim for any of a number
17779 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17780 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17781 the number used by IKE, or "default" which corresponds to
17782 &`exim.dev.20160529.3`&.
17783
17784 The available standard primes are:
17785 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17786 &`ike1`&, &`ike2`&, &`ike5`&,
17787 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17788 &`ike22`&, &`ike23`& and &`ike24`&.
17789
17790 The available additional primes are:
17791 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17792
17793 Some of these will be too small to be accepted by clients.
17794 Some may be too large to be accepted by clients.
17795 The open cryptographic community has suspicions about the integrity of some
17796 of the later IKE values, which led into RFC7919 providing new fixed constants
17797 (the "ffdhe" identifiers).
17798
17799 At this point, all of the "ike" values should be considered obsolete;
17800 they're still in Exim to avoid breaking unusual configurations, but are
17801 candidates for removal the next time we have backwards-incompatible changes.
17802
17803 The TLS protocol does not negotiate an acceptable size for this; clients tend
17804 to hard-drop connections if what is offered by the server is unacceptable,
17805 whether too large or too small, and there's no provision for the client to
17806 tell the server what these constraints are.  Thus, as a server operator, you
17807 need to make an educated guess as to what is most likely to work for your
17808 userbase.
17809
17810 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17811 is most likely to maximise interoperability.  The upper bound comes from
17812 applications using the Mozilla Network Security Services (NSS) library, which
17813 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17814 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17815 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17816 acceptable bound from 1024 to 2048.
17817
17818
17819 .option tls_eccurve main string&!! &`auto`&
17820 .cindex TLS "EC cryptography"
17821 This option selects a EC curve for use by Exim when used with OpenSSL.
17822 It has no effect when Exim is used with GnuTLS.
17823
17824 After expansion it must contain a valid EC curve parameter, such as
17825 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17826 for valid selections.
17827
17828 For OpenSSL versions before (and not including) 1.0.2, the string
17829 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17830 &`auto`& tells the library to choose.
17831
17832 If the option expands to an empty string, no EC curves will be enabled.
17833
17834
17835 .option tls_ocsp_file main string&!! unset
17836 .cindex TLS "certificate status"
17837 .cindex TLS "OCSP proof file"
17838 This option
17839 must if set expand to the absolute path to a file which contains a current
17840 status proof for the server's certificate, as obtained from the
17841 Certificate Authority.
17842
17843 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17844 .new
17845 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17846 .wen
17847
17848 .new
17849 For OpenSSL 1.1.0 or later, and
17850 .wen
17851 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17852 of files, to match a list given for the &%tls_certificate%& option.
17853 The ordering of the two lists must match.
17854 .new
17855 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17856 .wen
17857
17858 .new
17859 The file(s) should be in DER format,
17860 except for GnuTLS 3.6.3 or later
17861 or for OpenSSL,
17862 when an optional filetype prefix can be used.
17863 The prefix must be one of "DER" or "PEM", followed by
17864 a single space.  If one is used it sets the format for subsequent
17865 files in the list; the initial format is DER.
17866 If multiple proofs are wanted, for multiple chain elements
17867 (this only works under TLS1.3)
17868 they must be coded as a combined OCSP response.
17869
17870 Although GnuTLS will accept PEM files with multiple separate
17871 PEM blobs (ie. separate OCSP responses), it sends them in the
17872 TLS Certificate record interleaved with the certificates of the chain;
17873 although a GnuTLS client is happy with that, an OpenSSL client is not.
17874 .wen
17875
17876 .option tls_on_connect_ports main "string list" unset
17877 .cindex SSMTP
17878 .cindex SMTPS
17879 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17880 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17881 set up without waiting for the client to issue a STARTTLS command. For
17882 further details, see section &<<SECTsupobssmt>>&.
17883
17884
17885
17886 .option tls_privatekey main string list&!! unset
17887 .cindex "TLS" "server private key; location of"
17888 The value of this option is expanded, and must then be a list of absolute paths to
17889 files which contains the server's private keys.
17890 If this option is unset, or if
17891 the expansion is forced to fail, or the result is an empty string, the private
17892 key is assumed to be in the same file as the server's certificates. See chapter
17893 &<<CHAPTLS>>& for further details.
17894
17895 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17896
17897
17898 .option tls_remember_esmtp main boolean false
17899 .cindex "TLS" "esmtp state; remembering"
17900 .cindex "TLS" "broken clients"
17901 If this option is set true, Exim violates the RFCs by remembering that it is in
17902 &"esmtp"& state after successfully negotiating a TLS session. This provides
17903 support for broken clients that fail to send a new EHLO after starting a
17904 TLS session.
17905
17906
17907 .option tls_require_ciphers main string&!! unset
17908 .cindex "TLS" "requiring specific ciphers"
17909 .cindex "cipher" "requiring specific"
17910 This option controls which ciphers can be used for incoming TLS connections.
17911 The &(smtp)& transport has an option of the same name for controlling outgoing
17912 connections. This option is expanded for each connection, so can be varied for
17913 different clients if required. The value of this option must be a list of
17914 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17915 in somewhat different ways. If GnuTLS is being used, the client controls the
17916 preference order of the available ciphers. Details are given in sections
17917 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17918
17919
17920 .option tls_try_verify_hosts main "host list&!!" unset
17921 .cindex "TLS" "client certificate verification"
17922 .cindex "certificate" "verification of client"
17923 See &%tls_verify_hosts%& below.
17924
17925
17926 .option tls_verify_certificates main string&!! system
17927 .cindex "TLS" "client certificate verification"
17928 .cindex "certificate" "verification of client"
17929 The value of this option is expanded, and must then be either the
17930 word "system"
17931 or the absolute path to
17932 a file or directory containing permitted certificates for clients that
17933 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17934
17935 The "system" value for the option will use a
17936 system default location compiled into the SSL library.
17937 This is not available for GnuTLS versions preceding 3.0.20,
17938 and will be taken as empty; an explicit location
17939 must be specified.
17940
17941 The use of a directory for the option value is not available for GnuTLS versions
17942 preceding 3.3.6 and a single file must be used.
17943
17944 With OpenSSL the certificates specified
17945 explicitly
17946 either by file or directory
17947 are added to those given by the system default location.
17948
17949 These certificates should be for the certificate authorities trusted, rather
17950 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17951 the value is a file then the certificates are sent by Exim as a server to
17952 connecting clients, defining the list of accepted certificate authorities.
17953 Thus the values defined should be considered public data.  To avoid this,
17954 use the explicit directory version.
17955
17956 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17957
17958 A forced expansion failure or setting to an empty string is equivalent to
17959 being unset.
17960
17961
17962 .option tls_verify_hosts main "host list&!!" unset
17963 .cindex "TLS" "client certificate verification"
17964 .cindex "certificate" "verification of client"
17965 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17966 certificates from clients. The expected certificates are defined by
17967 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17968 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17969 &%tls_verify_certificates%& is not set.
17970
17971 Any client that matches &%tls_verify_hosts%& is constrained by
17972 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17973 present one of the listed certificates. If it does not, the connection is
17974 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17975 the host to use TLS. It can still send SMTP commands through unencrypted
17976 connections. Forcing a client to use TLS has to be done separately using an
17977 ACL to reject inappropriate commands when the connection is not encrypted.
17978
17979 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17980 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17981 certificate and checks it against &%tls_verify_certificates%&, but does not
17982 abort the connection if there is no certificate or if it does not match. This
17983 state can be detected in an ACL, which makes it possible to implement policies
17984 such as &"accept for relay only if a verified certificate has been received,
17985 but accept for local delivery if encrypted, even without a verified
17986 certificate"&.
17987
17988 Client hosts that match neither of these lists are not asked to present
17989 certificates.
17990
17991
17992 .option trusted_groups main "string list&!!" unset
17993 .cindex "trusted groups"
17994 .cindex "groups" "trusted"
17995 This option is expanded just once, at the start of Exim's processing. If this
17996 option is set, any process that is running in one of the listed groups, or
17997 which has one of them as a supplementary group, is trusted. The groups can be
17998 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17999 details of what trusted callers are permitted to do. If neither
18000 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18001 are trusted.
18002
18003 .option trusted_users main "string list&!!" unset
18004 .cindex "trusted users"
18005 .cindex "user" "trusted"
18006 This option is expanded just once, at the start of Exim's processing. If this
18007 option is set, any process that is running as one of the listed users is
18008 trusted. The users can be specified numerically or by name. See section
18009 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18010 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18011 Exim user are trusted.
18012
18013 .option unknown_login main string&!! unset
18014 .cindex "uid (user id)" "unknown caller"
18015 .vindex "&$caller_uid$&"
18016 This is a specialized feature for use in unusual configurations. By default, if
18017 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18018 gives up. The &%unknown_login%& option can be used to set a login name to be
18019 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18020 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18021 is used for the user's real name (gecos field), unless this has been set by the
18022 &%-F%& option.
18023
18024 .option unknown_username main string unset
18025 See &%unknown_login%&.
18026
18027 .option untrusted_set_sender main "address list&!!" unset
18028 .cindex "trusted users"
18029 .cindex "sender" "setting by untrusted user"
18030 .cindex "untrusted user setting sender"
18031 .cindex "user" "untrusted setting sender"
18032 .cindex "envelope from"
18033 .cindex "envelope sender"
18034 When an untrusted user submits a message to Exim using the standard input, Exim
18035 normally creates an envelope sender address from the user's login and the
18036 default qualification domain. Data from the &%-f%& option (for setting envelope
18037 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18038 is used) is ignored.
18039
18040 However, untrusted users are permitted to set an empty envelope sender address,
18041 to declare that a message should never generate any bounces. For example:
18042 .code
18043 exim -f '<>' user@domain.example
18044 .endd
18045 .vindex "&$sender_ident$&"
18046 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18047 other envelope sender addresses in a controlled way. When it is set, untrusted
18048 users are allowed to set envelope sender addresses that match any of the
18049 patterns in the list. Like all address lists, the string is expanded. The
18050 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18051 users to setting senders that start with their login ids
18052 followed by a hyphen
18053 by a setting like this:
18054 .code
18055 untrusted_set_sender = ^$sender_ident-
18056 .endd
18057 If you want to allow untrusted users to set envelope sender addresses without
18058 restriction, you can use
18059 .code
18060 untrusted_set_sender = *
18061 .endd
18062 The &%untrusted_set_sender%& option applies to all forms of local input, but
18063 only to the setting of the envelope sender. It does not permit untrusted users
18064 to use the other options which trusted user can use to override message
18065 parameters. Furthermore, it does not stop Exim from removing an existing
18066 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18067 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18068 overriding these actions. The handling of the &'Sender:'& header is also
18069 described in section &<<SECTthesenhea>>&.
18070
18071 The log line for a message's arrival shows the envelope sender following
18072 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18073 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18074 envelope sender address, the user's login is shown in parentheses after the
18075 sender address.
18076
18077
18078 .option uucp_from_pattern main string "see below"
18079 .cindex "&""From""& line"
18080 .cindex "UUCP" "&""From""& line"
18081 Some applications that pass messages to an MTA via a command line interface use
18082 an initial line starting with &"From&~"& to pass the envelope sender. In
18083 particular, this is used by UUCP software. Exim recognizes such a line by means
18084 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18085 matches, the sender address is constructed by expanding the contents of
18086 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18087 default pattern recognizes lines in the following two forms:
18088 .code
18089 From ph10 Fri Jan  5 12:35 GMT 1996
18090 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18091 .endd
18092 The pattern can be seen by running
18093 .code
18094 exim -bP uucp_from_pattern
18095 .endd
18096 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18097 year in the second case. The first word after &"From&~"& is matched in the
18098 regular expression by a parenthesized subpattern. The default value for
18099 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18100 (&"ph10"& in the example above) as the message's sender. See also
18101 &%ignore_fromline_hosts%&.
18102
18103
18104 .option uucp_from_sender main string&!! &`$1`&
18105 See &%uucp_from_pattern%& above.
18106
18107
18108 .option warn_message_file main string unset
18109 .cindex "warning of delay" "customizing the message"
18110 .cindex "customizing" "warning message"
18111 This option defines a template file containing paragraphs of text to be used
18112 for constructing the warning message which is sent by Exim when a message has
18113 been in the queue for a specified amount of time, as specified by
18114 &%delay_warning%&. Details of the file's contents are given in chapter
18115 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18116
18117
18118 .option write_rejectlog main boolean true
18119 .cindex "reject log" "disabling"
18120 If this option is set false, Exim no longer writes anything to the reject log.
18121 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18122 .ecindex IIDconfima
18123 .ecindex IIDmaiconf
18124
18125
18126
18127
18128 . ////////////////////////////////////////////////////////////////////////////
18129 . ////////////////////////////////////////////////////////////////////////////
18130
18131 .chapter "Generic options for routers" "CHAProutergeneric"
18132 .scindex IIDgenoprou1 "options" "generic; for routers"
18133 .scindex IIDgenoprou2 "generic options" "router"
18134 This chapter describes the generic options that apply to all routers.
18135 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18136
18137 For a general description of how a router operates, see sections
18138 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18139 which the preconditions are tested. The order of expansion of the options that
18140 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18141 &%headers_remove%&, &%transport%&.
18142
18143
18144
18145 .option address_data routers string&!! unset
18146 .cindex "router" "data attached to address"
18147 The string is expanded just before the router is run, that is, after all the
18148 precondition tests have succeeded. If the expansion is forced to fail, the
18149 router declines, the value of &%address_data%& remains unchanged, and the
18150 &%more%& option controls what happens next. Other expansion failures cause
18151 delivery of the address to be deferred.
18152
18153 .vindex "&$address_data$&"
18154 When the expansion succeeds, the value is retained with the address, and can be
18155 accessed using the variable &$address_data$& in the current router, subsequent
18156 routers, and the eventual transport.
18157
18158 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18159 that runs a user's filter file, the contents of &$address_data$& are accessible
18160 in the filter. This is not normally a problem, because such data is usually
18161 either not confidential or it &"belongs"& to the current user, but if you do
18162 put confidential data into &$address_data$& you need to remember this point.
18163
18164 Even if the router declines or passes, the value of &$address_data$& remains
18165 with the address, though it can be changed by another &%address_data%& setting
18166 on a subsequent router. If a router generates child addresses, the value of
18167 &$address_data$& propagates to them. This also applies to the special kind of
18168 &"child"& that is generated by a router with the &%unseen%& option.
18169
18170 The idea of &%address_data%& is that you can use it to look up a lot of data
18171 for the address once, and then pick out parts of the data later. For example,
18172 you could use a single LDAP lookup to return a string of the form
18173 .code
18174 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18175 .endd
18176 In the transport you could pick out the mailbox by a setting such as
18177 .code
18178 file = ${extract{mailbox}{$address_data}}
18179 .endd
18180 This makes the configuration file less messy, and also reduces the number of
18181 lookups (though Exim does cache lookups).
18182
18183 .new
18184 See also the &%set%& option below.
18185 .wen
18186
18187 .vindex "&$sender_address_data$&"
18188 .vindex "&$address_data$&"
18189 The &%address_data%& facility is also useful as a means of passing information
18190 from one router to another, and from a router to a transport. In addition, if
18191 &$address_data$& is set by a router when verifying a recipient address from an
18192 ACL, it remains available for use in the rest of the ACL statement. After
18193 verifying a sender, the value is transferred to &$sender_address_data$&.
18194
18195
18196
18197 .option address_test routers&!? boolean true
18198 .oindex "&%-bt%&"
18199 .cindex "router" "skipping when address testing"
18200 If this option is set false, the router is skipped when routing is being tested
18201 by means of the &%-bt%& command line option. This can be a convenience when
18202 your first router sends messages to an external scanner, because it saves you
18203 having to set the &"already scanned"& indicator when testing real address
18204 routing.
18205
18206
18207
18208 .option cannot_route_message routers string&!! unset
18209 .cindex "router" "customizing &""cannot route""& message"
18210 .cindex "customizing" "&""cannot route""& message"
18211 This option specifies a text message that is used when an address cannot be
18212 routed because Exim has run out of routers. The default message is
18213 &"Unrouteable address"&. This option is useful only on routers that have
18214 &%more%& set false, or on the very last router in a configuration, because the
18215 value that is used is taken from the last router that is considered. This
18216 includes a router that is skipped because its preconditions are not met, as
18217 well as a router that declines. For example, using the default configuration,
18218 you could put:
18219 .code
18220 cannot_route_message = Remote domain not found in DNS
18221 .endd
18222 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18223 and
18224 .code
18225 cannot_route_message = Unknown local user
18226 .endd
18227 on the final router that checks for local users. If string expansion fails for
18228 this option, the default message is used. Unless the expansion failure was
18229 explicitly forced, a message about the failure is written to the main and panic
18230 logs, in addition to the normal message about the routing failure.
18231
18232
18233 .option caseful_local_part routers boolean false
18234 .cindex "case of local parts"
18235 .cindex "router" "case of local parts"
18236 By default, routers handle the local parts of addresses in a case-insensitive
18237 manner, though the actual case is preserved for transmission with the message.
18238 If you want the case of letters to be significant in a router, you must set
18239 this option true. For individual router options that contain address or local
18240 part lists (for example, &%local_parts%&), case-sensitive matching can be
18241 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18242 more details.
18243
18244 .vindex "&$local_part$&"
18245 .vindex "&$original_local_part$&"
18246 .vindex "&$parent_local_part$&"
18247 The value of the &$local_part$& variable is forced to lower case while a
18248 router is running unless &%caseful_local_part%& is set. When a router assigns
18249 an address to a transport, the value of &$local_part$& when the transport runs
18250 is the same as it was in the router. Similarly, when a router generates child
18251 addresses by aliasing or forwarding, the values of &$original_local_part$&
18252 and &$parent_local_part$& are those that were used by the redirecting router.
18253
18254 This option applies to the processing of an address by a router. When a
18255 recipient address is being processed in an ACL, there is a separate &%control%&
18256 modifier that can be used to specify case-sensitive processing within the ACL
18257 (see section &<<SECTcontrols>>&).
18258
18259
18260
18261 .option check_local_user routers&!? boolean false
18262 .cindex "local user, checking in router"
18263 .cindex "router" "checking for local user"
18264 .cindex "&_/etc/passwd_&"
18265 .vindex "&$home$&"
18266 When this option is true, Exim checks that the local part of the recipient
18267 address (with affixes removed if relevant) is the name of an account on the
18268 local system. The check is done by calling the &[getpwnam()]& function rather
18269 than trying to read &_/etc/passwd_& directly. This means that other methods of
18270 holding password data (such as NIS) are supported. If the local part is a local
18271 user, &$home$& is set from the password data, and can be tested in other
18272 preconditions that are evaluated after this one (the order of evaluation is
18273 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18274 overridden by &%router_home_directory%&. If the local part is not a local user,
18275 the router is skipped.
18276
18277 If you want to check that the local part is either the name of a local user
18278 or matches something else, you cannot combine &%check_local_user%& with a
18279 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18280 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18281 setting to achieve this. For example:
18282 .code
18283 local_parts = passwd;$local_part : lsearch;/etc/other/users
18284 .endd
18285 Note, however, that the side effects of &%check_local_user%& (such as setting
18286 up a home directory) do not occur when a &(passwd)& lookup is used in a
18287 &%local_parts%& (or any other) precondition.
18288
18289
18290
18291 .option condition routers&!? string&!! unset
18292 .cindex "router" "customized precondition"
18293 This option specifies a general precondition test that has to succeed for the
18294 router to be called. The &%condition%& option is the last precondition to be
18295 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18296 result is a forced failure, or an empty string, or one of the strings &"0"& or
18297 &"no"& or &"false"& (checked without regard to the case of the letters), the
18298 router is skipped, and the address is offered to the next one.
18299
18300 If the result is any other value, the router is run (as this is the last
18301 precondition to be evaluated, all the other preconditions must be true).
18302
18303 This option is unusual in that multiple &%condition%& options may be present.
18304 All &%condition%& options must succeed.
18305
18306 The &%condition%& option provides a means of applying custom conditions to the
18307 running of routers. Note that in the case of a simple conditional expansion,
18308 the default expansion values are exactly what is wanted. For example:
18309 .code
18310 condition = ${if >{$message_age}{600}}
18311 .endd
18312 Because of the default behaviour of the string expansion, this is equivalent to
18313 .code
18314 condition = ${if >{$message_age}{600}{true}{}}
18315 .endd
18316
18317 A multiple condition example, which succeeds:
18318 .code
18319 condition = ${if >{$message_age}{600}}
18320 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18321 condition = foobar
18322 .endd
18323
18324 If the expansion fails (other than forced failure) delivery is deferred. Some
18325 of the other precondition options are common special cases that could in fact
18326 be specified using &%condition%&.
18327
18328 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18329 are far older, and use one set of semantics.  ACLs are newer and when
18330 they were created, the ACL &%condition%& process was given far stricter
18331 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18332 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18333 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18334 Router rules processing behavior.
18335
18336 This is best illustrated in an example:
18337 .code
18338 # If used in an ACL condition will fail with a syntax error, but
18339 # in a router condition any extra characters are treated as a string
18340
18341 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18342 true {yes} {no}}
18343
18344 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18345  {yes} {no}}
18346 .endd
18347 In each example above, the &%if%& statement actually ends after
18348 &"{google.com}}"&.  Since no true or false braces were defined, the
18349 default &%if%& behavior is to return a boolean true or a null answer
18350 (which evaluates to false). The rest of the line is then treated as a
18351 string. So the first example resulted in the boolean answer &"true"&
18352 with the string &" {yes} {no}}"& appended to it. The second example
18353 resulted in the null output (indicating false) with the string
18354 &" {yes} {no}}"& appended to it.
18355
18356 In fact you can put excess forward braces in too.  In the router
18357 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18358 mean something, like after a &"$"& or when required as part of a
18359 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18360 string characters.
18361
18362 Thus, in a Router, the above expansion strings will both always evaluate
18363 true, as the result of expansion is a non-empty string which doesn't
18364 match an explicit false value.  This can be tricky to debug.  By
18365 contrast, in an ACL either of those strings will always result in an
18366 expansion error because the result doesn't look sufficiently boolean.
18367
18368
18369 .option debug_print routers string&!! unset
18370 .cindex "testing" "variables in drivers"
18371 If this option is set and debugging is enabled (see the &%-d%& command line
18372 option) or in address-testing mode (see the &%-bt%& command line option),
18373 the string is expanded and included in the debugging output.
18374 If expansion of the string fails, the error message is written to the debugging
18375 output, and Exim carries on processing.
18376 This option is provided to help with checking out the values of variables and
18377 so on when debugging router configurations. For example, if a &%condition%&
18378 option appears not to be working, &%debug_print%& can be used to output the
18379 variables it references. The output happens after checks for &%domains%&,
18380 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18381 are tested. A newline is added to the text if it does not end with one.
18382 The variable &$router_name$& contains the name of the router.
18383
18384
18385
18386 .option disable_logging routers boolean false
18387 If this option is set true, nothing is logged for any routing errors
18388 or for any deliveries caused by this router. You should not set this option
18389 unless you really, really know what you are doing. See also the generic
18390 transport option of the same name.
18391
18392 .option dnssec_request_domains routers "domain list&!!" *
18393 .cindex "MX record" "security"
18394 .cindex "DNSSEC" "MX lookup"
18395 .cindex "security" "MX lookup"
18396 .cindex "DNS" "DNSSEC"
18397 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18398 the dnssec request bit set.
18399 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18400
18401 .option dnssec_require_domains routers "domain list&!!" unset
18402 .cindex "MX record" "security"
18403 .cindex "DNSSEC" "MX lookup"
18404 .cindex "security" "MX lookup"
18405 .cindex "DNS" "DNSSEC"
18406 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18407 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18408 (AD bit) set will be ignored and logged as a host-lookup failure.
18409 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18410
18411
18412 .option domains routers&!? "domain list&!!" unset
18413 .cindex "router" "restricting to specific domains"
18414 .vindex "&$domain_data$&"
18415 If this option is set, the router is skipped unless the current domain matches
18416 the list. If the match is achieved by means of a file lookup, the data that the
18417 lookup returned for the domain is placed in &$domain_data$& for use in string
18418 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18419 a list of the order in which preconditions are evaluated.
18420
18421
18422
18423 .option driver routers string unset
18424 This option must always be set. It specifies which of the available routers is
18425 to be used.
18426
18427
18428 .option dsn_lasthop routers boolean false
18429 .cindex "DSN" "success"
18430 .cindex "Delivery Status Notification" "success"
18431 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18432 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18433 instead send a success DSN as if the next hop does not support DSN.
18434 Not effective on redirect routers.
18435
18436
18437
18438 .option errors_to routers string&!! unset
18439 .cindex "envelope from"
18440 .cindex "envelope sender"
18441 .cindex "router" "changing address for errors"
18442 If a router successfully handles an address, it may assign the address to a
18443 transport for delivery or it may generate child addresses. In both cases, if
18444 there is a delivery problem during later processing, the resulting bounce
18445 message is sent to the address that results from expanding this string,
18446 provided that the address verifies successfully. The &%errors_to%& option is
18447 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18448
18449 The &%errors_to%& setting associated with an address can be overridden if it
18450 subsequently passes through other routers that have their own &%errors_to%&
18451 settings, or if the message is delivered by a transport with a &%return_path%&
18452 setting.
18453
18454 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18455 the expansion fails to verify, the errors address associated with the incoming
18456 address is used. At top level, this is the envelope sender. A non-forced
18457 expansion failure causes delivery to be deferred.
18458
18459 If an address for which &%errors_to%& has been set ends up being delivered over
18460 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18461 any bounces that are generated by other MTAs on the delivery route are also
18462 sent there. You can set &%errors_to%& to the empty string by either of these
18463 settings:
18464 .code
18465 errors_to =
18466 errors_to = ""
18467 .endd
18468 An expansion item that yields an empty string has the same effect. If you do
18469 this, a locally detected delivery error for addresses processed by this router
18470 no longer gives rise to a bounce message; the error is discarded. If the
18471 address is delivered to a remote host, the return path is set to &`<>`&, unless
18472 overridden by the &%return_path%& option on the transport.
18473
18474 .vindex "&$address_data$&"
18475 If for some reason you want to discard local errors, but use a non-empty
18476 MAIL command for remote delivery, you can preserve the original return
18477 path in &$address_data$& in the router, and reinstate it in the transport by
18478 setting &%return_path%&.
18479
18480 The most common use of &%errors_to%& is to direct mailing list bounces to the
18481 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18482 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18483
18484
18485
18486 .option expn routers&!? boolean true
18487 .cindex "address" "testing"
18488 .cindex "testing" "addresses"
18489 .cindex "EXPN" "router skipping"
18490 .cindex "router" "skipping for EXPN"
18491 If this option is turned off, the router is skipped when testing an address
18492 as a result of processing an SMTP EXPN command. You might, for example,
18493 want to turn it off on a router for users' &_.forward_& files, while leaving it
18494 on for the system alias file.
18495 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18496 are evaluated.
18497
18498 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18499 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18500 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18501
18502
18503
18504 .option fail_verify routers boolean false
18505 .cindex "router" "forcing verification failure"
18506 Setting this option has the effect of setting both &%fail_verify_sender%& and
18507 &%fail_verify_recipient%& to the same value.
18508
18509
18510
18511 .option fail_verify_recipient routers boolean false
18512 If this option is true and an address is accepted by this router when
18513 verifying a recipient, verification fails.
18514
18515
18516
18517 .option fail_verify_sender routers boolean false
18518 If this option is true and an address is accepted by this router when
18519 verifying a sender, verification fails.
18520
18521
18522
18523 .option fallback_hosts routers "string list" unset
18524 .cindex "router" "fallback hosts"
18525 .cindex "fallback" "hosts specified on router"
18526 String expansion is not applied to this option. The argument must be a
18527 colon-separated list of host names or IP addresses. The list separator can be
18528 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18529 each name or address. In fact, the format of each item is exactly the same as
18530 defined for the list of hosts in a &(manualroute)& router (see section
18531 &<<SECTformatonehostitem>>&).
18532
18533 If a router queues an address for a remote transport, this host list is
18534 associated with the address, and used instead of the transport's fallback host
18535 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18536 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18537 transport for further details.
18538
18539
18540 .option group routers string&!! "see below"
18541 .cindex "gid (group id)" "local delivery"
18542 .cindex "local transports" "uid and gid"
18543 .cindex "transport" "local"
18544 .cindex "router" "setting group"
18545 When a router queues an address for a transport, and the transport does not
18546 specify a group, the group given here is used when running the delivery
18547 process.
18548 The group may be specified numerically or by name. If expansion fails, the
18549 error is logged and delivery is deferred.
18550 The default is unset, unless &%check_local_user%& is set, when the default
18551 is taken from the password information. See also &%initgroups%& and &%user%&
18552 and the discussion in chapter &<<CHAPenvironment>>&.
18553
18554
18555
18556 .option headers_add routers list&!! unset
18557 .cindex "header lines" "adding"
18558 .cindex "router" "adding header lines"
18559 This option specifies a list of text headers,
18560 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18561 that is associated with any addresses that are accepted by the router.
18562 Each item is separately expanded, at routing time.  However, this
18563 option has no effect when an address is just being verified. The way in which
18564 the text is used to add header lines at transport time is described in section
18565 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18566 message is in the process of being transported. This means that references to
18567 header lines in string expansions in the transport's configuration do not
18568 &"see"& the added header lines.
18569
18570 The &%headers_add%& option is expanded after &%errors_to%&, but before
18571 &%headers_remove%& and &%transport%&. If an item is empty, or if
18572 an item expansion is forced to fail, the item has no effect. Other expansion
18573 failures are treated as configuration errors.
18574
18575 Unlike most options, &%headers_add%& can be specified multiple times
18576 for a router; all listed headers are added.
18577
18578 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18579 router that has the &%one_time%& option set.
18580
18581 .cindex "duplicate addresses"
18582 .oindex "&%unseen%&"
18583 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18584 additions are deleted when the address is passed on to subsequent routers.
18585 For a &%redirect%& router, if a generated address is the same as the incoming
18586 address, this can lead to duplicate addresses with different header
18587 modifications. Exim does not do duplicate deliveries (except, in certain
18588 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18589 which of the duplicates is discarded, so this ambiguous situation should be
18590 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18591
18592
18593
18594 .option headers_remove routers list&!! unset
18595 .cindex "header lines" "removing"
18596 .cindex "router" "removing header lines"
18597 This option specifies a list of text headers,
18598 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18599 that is associated with any addresses that are accepted by the router.
18600 Each item is separately expanded, at routing time.  However, this
18601 option has no effect when an address is just being verified. The way in which
18602 the text is used to remove header lines at transport time is described in
18603 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18604 the message is in the process of being transported. This means that references
18605 to header lines in string expansions in the transport's configuration still
18606 &"see"& the original header lines.
18607
18608 The &%headers_remove%& option is expanded after &%errors_to%& and
18609 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18610 the item has no effect. Other expansion failures are treated as configuration
18611 errors.
18612
18613 Unlike most options, &%headers_remove%& can be specified multiple times
18614 for a router; all listed headers are removed.
18615
18616 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18617 router that has the &%one_time%& option set.
18618
18619 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18620 removal requests are deleted when the address is passed on to subsequent
18621 routers, and this can lead to problems with duplicates -- see the similar
18622 warning for &%headers_add%& above.
18623
18624 &*Warning 3*&: Because of the separate expansion of the list items,
18625 items that contain a list separator must have it doubled.
18626 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18627
18628
18629
18630 .option ignore_target_hosts routers "host list&!!" unset
18631 .cindex "IP address" "discarding"
18632 .cindex "router" "discarding IP addresses"
18633 Although this option is a host list, it should normally contain IP address
18634 entries rather than names. If any host that is looked up by the router has an
18635 IP address that matches an item in this list, Exim behaves as if that IP
18636 address did not exist. This option allows you to cope with rogue DNS entries
18637 like
18638 .code
18639 remote.domain.example.  A  127.0.0.1
18640 .endd
18641 by setting
18642 .code
18643 ignore_target_hosts = 127.0.0.1
18644 .endd
18645 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18646 discarded in this way, the router declines. In a conventional configuration, an
18647 attempt to mail to such a domain would normally provoke the &"unrouteable
18648 domain"& error, and an attempt to verify an address in the domain would fail.
18649 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18650 router declines if presented with one of the listed addresses.
18651
18652 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18653 means of the first or the second of the following settings, respectively:
18654 .code
18655 ignore_target_hosts = 0.0.0.0/0
18656 ignore_target_hosts = <; 0::0/0
18657 .endd
18658 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18659 in the second line matches all IPv6 addresses.
18660
18661 This option may also be useful for ignoring link-local and site-local IPv6
18662 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18663 is expanded before use as a list, it is possible to make it dependent on the
18664 domain that is being routed.
18665
18666 .vindex "&$host_address$&"
18667 During its expansion, &$host_address$& is set to the IP address that is being
18668 checked.
18669
18670 .option initgroups routers boolean false
18671 .cindex "additional groups"
18672 .cindex "groups" "additional"
18673 .cindex "local transports" "uid and gid"
18674 .cindex "transport" "local"
18675 If the router queues an address for a transport, and this option is true, and
18676 the uid supplied by the router is not overridden by the transport, the
18677 &[initgroups()]& function is called when running the transport to ensure that
18678 any additional groups associated with the uid are set up. See also &%group%&
18679 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18680
18681
18682
18683 .option local_part_prefix routers&!? "string list" unset
18684 .cindex affix "router precondition"
18685 .cindex "router" "prefix for local part"
18686 .cindex "prefix" "for local part, used in router"
18687 If this option is set, the router is skipped unless the local part starts with
18688 one of the given strings, or &%local_part_prefix_optional%& is true. See
18689 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18690 evaluated.
18691
18692 The list is scanned from left to right, and the first prefix that matches is
18693 used. A limited form of wildcard is available; if the prefix begins with an
18694 asterisk, it matches the longest possible sequence of arbitrary characters at
18695 the start of the local part. An asterisk should therefore always be followed by
18696 some character that does not occur in normal local parts.
18697 .cindex "multiple mailboxes"
18698 .cindex "mailbox" "multiple"
18699 Wildcarding can be used to set up multiple user mailboxes, as described in
18700 section &<<SECTmulbox>>&.
18701
18702 .vindex "&$local_part$&"
18703 .vindex "&$local_part_prefix$&"
18704 During the testing of the &%local_parts%& option, and while the router is
18705 running, the prefix is removed from the local part, and is available in the
18706 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18707 the router accepts the address, this remains true during subsequent delivery by
18708 a transport. In particular, the local part that is transmitted in the RCPT
18709 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18710 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18711 the relevant transport.
18712
18713 When an address is being verified, &%local_part_prefix%& affects only the
18714 behaviour of the router. If the callout feature of verification is in use, this
18715 means that the full address, including the prefix, will be used during the
18716 callout.
18717
18718 The prefix facility is commonly used to handle local parts of the form
18719 &%owner-something%&. Another common use is to support local parts of the form
18720 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18721 to tell a user their forwarding is broken &-- by placing a router like this one
18722 immediately before the router that handles &_.forward_& files:
18723 .code
18724 real_localuser:
18725   driver = accept
18726   local_part_prefix = real-
18727   check_local_user
18728   transport = local_delivery
18729 .endd
18730 For security, it would probably be a good idea to restrict the use of this
18731 router to locally-generated messages, using a condition such as this:
18732 .code
18733   condition = ${if match {$sender_host_address}\
18734                          {\N^(|127\.0\.0\.1)$\N}}
18735 .endd
18736
18737 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18738 both conditions must be met if not optional. Care must be taken if wildcards
18739 are used in both a prefix and a suffix on the same router. Different
18740 separator characters must be used to avoid ambiguity.
18741
18742
18743 .option local_part_prefix_optional routers boolean false
18744 See &%local_part_prefix%& above.
18745
18746
18747
18748 .option local_part_suffix routers&!? "string list" unset
18749 .cindex "router" "suffix for local part"
18750 .cindex "suffix for local part" "used in router"
18751 This option operates in the same way as &%local_part_prefix%&, except that the
18752 local part must end (rather than start) with the given string, the
18753 &%local_part_suffix_optional%& option determines whether the suffix is
18754 mandatory, and the wildcard * character, if present, must be the last
18755 character of the suffix. This option facility is commonly used to handle local
18756 parts of the form &%something-request%& and multiple user mailboxes of the form
18757 &%username-foo%&.
18758
18759
18760 .option local_part_suffix_optional routers boolean false
18761 See &%local_part_suffix%& above.
18762
18763
18764
18765 .option local_parts routers&!? "local part list&!!" unset
18766 .cindex "router" "restricting to specific local parts"
18767 .cindex "local part" "checking in router"
18768 The router is run only if the local part of the address matches the list.
18769 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18770 are evaluated, and
18771 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18772 string is expanded, it is possible to make it depend on the domain, for
18773 example:
18774 .code
18775 local_parts = dbm;/usr/local/specials/$domain
18776 .endd
18777 .vindex "&$local_part_data$&"
18778 If the match is achieved by a lookup, the data that the lookup returned
18779 for the local part is placed in the variable &$local_part_data$& for use in
18780 expansions of the router's private options. You might use this option, for
18781 example, if you have a large number of local virtual domains, and you want to
18782 send all postmaster mail to the same place without having to set up an alias in
18783 each virtual domain:
18784 .code
18785 postmaster:
18786   driver = redirect
18787   local_parts = postmaster
18788   data = postmaster@real.domain.example
18789 .endd
18790
18791
18792 .option log_as_local routers boolean "see below"
18793 .cindex "log" "delivery line"
18794 .cindex "delivery" "log line format"
18795 Exim has two logging styles for delivery, the idea being to make local
18796 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18797 recipient address is given just as the local part, without a domain. The use of
18798 this style is controlled by this option. It defaults to true for the &(accept)&
18799 router, and false for all the others. This option applies only when a
18800 router assigns an address to a transport. It has no effect on routers that
18801 redirect addresses.
18802
18803
18804
18805 .option more routers boolean&!! true
18806 The result of string expansion for this option must be a valid boolean value,
18807 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18808 result causes an error, and delivery is deferred. If the expansion is forced to
18809 fail, the default value for the option (true) is used. Other failures cause
18810 delivery to be deferred.
18811
18812 If this option is set false, and the router declines to handle the address, no
18813 further routers are tried, routing fails, and the address is bounced.
18814 .oindex "&%self%&"
18815 However, if the router explicitly passes an address to the following router by
18816 means of the setting
18817 .code
18818 self = pass
18819 .endd
18820 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18821 does not affect the behaviour if one of the precondition tests fails. In that
18822 case, the address is always passed to the next router.
18823
18824 Note that &%address_data%& is not considered to be a precondition. If its
18825 expansion is forced to fail, the router declines, and the value of &%more%&
18826 controls what happens next.
18827
18828
18829 .option pass_on_timeout routers boolean false
18830 .cindex "timeout" "of router"
18831 .cindex "router" "timeout"
18832 If a router times out during a host lookup, it normally causes deferral of the
18833 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18834 router, overriding &%no_more%&. This may be helpful for systems that are
18835 intermittently connected to the Internet, or those that want to pass to a smart
18836 host any messages that cannot immediately be delivered.
18837
18838 There are occasional other temporary errors that can occur while doing DNS
18839 lookups. They are treated in the same way as a timeout, and this option
18840 applies to all of them.
18841
18842
18843
18844 .option pass_router routers string unset
18845 .cindex "router" "go to after &""pass""&"
18846 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18847 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18848 routing to continue, and overriding a false setting of &%more%&. When one of
18849 these routers returns &"pass"&, the address is normally handed on to the next
18850 router in sequence. This can be changed by setting &%pass_router%& to the name
18851 of another router. However (unlike &%redirect_router%&) the named router must
18852 be below the current router, to avoid loops. Note that this option applies only
18853 to the special case of &"pass"&. It does not apply when a router returns
18854 &"decline"& because it cannot handle an address.
18855
18856
18857
18858 .option redirect_router routers string unset
18859 .cindex "router" "start at after redirection"
18860 Sometimes an administrator knows that it is pointless to reprocess addresses
18861 generated from alias or forward files with the same router again. For
18862 example, if an alias file translates real names into login ids there is no
18863 point searching the alias file a second time, especially if it is a large file.
18864
18865 The &%redirect_router%& option can be set to the name of any router instance.
18866 It causes the routing of any generated addresses to start at the named router
18867 instead of at the first router. This option has no effect if the router in
18868 which it is set does not generate new addresses.
18869
18870
18871
18872 .option require_files routers&!? "string list&!!" unset
18873 .cindex "file" "requiring for router"
18874 .cindex "router" "requiring file existence"
18875 This option provides a general mechanism for predicating the running of a
18876 router on the existence or non-existence of certain files or directories.
18877 Before running a router, as one of its precondition tests, Exim works its way
18878 through the &%require_files%& list, expanding each item separately.
18879
18880 Because the list is split before expansion, any colons in expansion items must
18881 be doubled, or the facility for using a different list separator must be used
18882 (&<<SECTlistsepchange>>&).
18883 If any expansion is forced to fail, the item is ignored. Other expansion
18884 failures cause routing of the address to be deferred.
18885
18886 If any expanded string is empty, it is ignored. Otherwise, except as described
18887 below, each string must be a fully qualified file path, optionally preceded by
18888 &"!"&. The paths are passed to the &[stat()]& function to test for the
18889 existence of the files or directories. The router is skipped if any paths not
18890 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18891
18892 .cindex "NFS"
18893 If &[stat()]& cannot determine whether a file exists or not, delivery of
18894 the message is deferred. This can happen when NFS-mounted filesystems are
18895 unavailable.
18896
18897 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18898 options, so you cannot use it to check for the existence of a file in which to
18899 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18900 full list of the order in which preconditions are evaluated.) However, as
18901 these options are all expanded, you can use the &%exists%& expansion condition
18902 to make such tests. The &%require_files%& option is intended for checking files
18903 that the router may be going to use internally, or which are needed by a
18904 transport (e.g., &_.procmailrc_&).
18905
18906 During delivery, the &[stat()]& function is run as root, but there is a
18907 facility for some checking of the accessibility of a file by another user.
18908 This is not a proper permissions check, but just a &"rough"& check that
18909 operates as follows:
18910
18911 If an item in a &%require_files%& list does not contain any forward slash
18912 characters, it is taken to be the user (and optional group, separated by a
18913 comma) to be checked for subsequent files in the list. If no group is specified
18914 but the user is specified symbolically, the gid associated with the uid is
18915 used. For example:
18916 .code
18917 require_files = mail:/some/file
18918 require_files = $local_part:$home/.procmailrc
18919 .endd
18920 If a user or group name in a &%require_files%& list does not exist, the
18921 &%require_files%& condition fails.
18922
18923 Exim performs the check by scanning along the components of the file path, and
18924 checking the access for the given uid and gid. It checks for &"x"& access on
18925 directories, and &"r"& access on the final file. Note that this means that file
18926 access control lists, if the operating system has them, are ignored.
18927
18928 &*Warning 1*&: When the router is being run to verify addresses for an
18929 incoming SMTP message, Exim is not running as root, but under its own uid. This
18930 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18931 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18932 user is not permitted to read one of the directories on the file's path.
18933
18934 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18935 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18936 without root access. In this case, if a check for access by a particular user
18937 is requested, Exim creates a subprocess that runs as that user, and tries the
18938 check again in that process.
18939
18940 The default action for handling an unresolved EACCES is to consider it to
18941 be caused by a configuration error, and routing is deferred because the
18942 existence or non-existence of the file cannot be determined. However, in some
18943 circumstances it may be desirable to treat this condition as if the file did
18944 not exist. If the filename (or the exclamation mark that precedes the filename
18945 for non-existence) is preceded by a plus sign, the EACCES error is treated
18946 as if the file did not exist. For example:
18947 .code
18948 require_files = +/some/file
18949 .endd
18950 If the router is not an essential part of verification (for example, it
18951 handles users' &_.forward_& files), another solution is to set the &%verify%&
18952 option false so that the router is skipped when verifying.
18953
18954
18955
18956 .option retry_use_local_part routers boolean "see below"
18957 .cindex "hints database" "retry keys"
18958 .cindex "local part" "in retry keys"
18959 When a delivery suffers a temporary routing failure, a retry record is created
18960 in Exim's hints database. For addresses whose routing depends only on the
18961 domain, the key for the retry record should not involve the local part, but for
18962 other addresses, both the domain and the local part should be included.
18963 Usually, remote routing is of the former kind, and local routing is of the
18964 latter kind.
18965
18966 This option controls whether the local part is used to form the key for retry
18967 hints for addresses that suffer temporary errors while being handled by this
18968 .new
18969 router. The default value is true for any router that has any of
18970 &%check_local_user%&,
18971 &%local_parts%&,
18972 &%condition%&,
18973 &%local_part_prefix%&,
18974 &%local_part_suffix%&,
18975 &%senders%& or
18976 &%require_files%&
18977 .wen
18978 set, and false otherwise. Note that this option does not apply to hints keys
18979 for transport delays; they are controlled by a generic transport option of the
18980 same name.
18981
18982 Failing to set this option when it is needed
18983 (because a remote router handles only some of the local-parts for a domain)
18984 can result in incorrect error messages being generated.
18985
18986 The setting of &%retry_use_local_part%& applies only to the router on which it
18987 appears. If the router generates child addresses, they are routed
18988 independently; this setting does not become attached to them.
18989
18990
18991
18992 .option router_home_directory routers string&!! unset
18993 .cindex "router" "home directory for"
18994 .cindex "home directory" "for router"
18995 .vindex "&$home$&"
18996 This option sets a home directory for use while the router is running. (Compare
18997 &%transport_home_directory%&, which sets a home directory for later
18998 transporting.) In particular, if used on a &(redirect)& router, this option
18999 sets a value for &$home$& while a filter is running. The value is expanded;
19000 forced expansion failure causes the option to be ignored &-- other failures
19001 cause the router to defer.
19002
19003 Expansion of &%router_home_directory%& happens immediately after the
19004 &%check_local_user%& test (if configured), before any further expansions take
19005 place.
19006 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19007 are evaluated.)
19008 While the router is running, &%router_home_directory%& overrides the value of
19009 &$home$& that came from &%check_local_user%&.
19010
19011 When a router accepts an address and assigns it to a local transport (including
19012 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19013 delivery), the home directory setting for the transport is taken from the first
19014 of these values that is set:
19015
19016 .ilist
19017 The &%home_directory%& option on the transport;
19018 .next
19019 The &%transport_home_directory%& option on the router;
19020 .next
19021 The password data if &%check_local_user%& is set on the router;
19022 .next
19023 The &%router_home_directory%& option on the router.
19024 .endlist
19025
19026 In other words, &%router_home_directory%& overrides the password data for the
19027 router, but not for the transport.
19028
19029
19030
19031 .option self routers string freeze
19032 .cindex "MX record" "pointing to local host"
19033 .cindex "local host" "MX pointing to"
19034 This option applies to those routers that use a recipient address to find a
19035 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19036 and &(manualroute)& routers.
19037 Certain configurations of the &(queryprogram)& router can also specify a list
19038 of remote hosts.
19039 Usually such routers are configured to send the message to a remote host via an
19040 &(smtp)& transport. The &%self%& option specifies what happens when the first
19041 host on the list turns out to be the local host.
19042 The way in which Exim checks for the local host is described in section
19043 &<<SECTreclocipadd>>&.
19044
19045 Normally this situation indicates either an error in Exim's configuration (for
19046 example, the router should be configured not to process this domain), or an
19047 error in the DNS (for example, the MX should not point to this host). For this
19048 reason, the default action is to log the incident, defer the address, and
19049 freeze the message. The following alternatives are provided for use in special
19050 cases:
19051
19052 .vlist
19053 .vitem &%defer%&
19054 Delivery of the message is tried again later, but the message is not frozen.
19055
19056 .vitem "&%reroute%&: <&'domain'&>"
19057 The domain is changed to the given domain, and the address is passed back to
19058 be reprocessed by the routers. No rewriting of headers takes place. This
19059 behaviour is essentially a redirection.
19060
19061 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19062 The domain is changed to the given domain, and the address is passed back to be
19063 reprocessed by the routers. Any headers that contain the original domain are
19064 rewritten.
19065
19066 .vitem &%pass%&
19067 .oindex "&%more%&"
19068 .vindex "&$self_hostname$&"
19069 The router passes the address to the next router, or to the router named in the
19070 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19071 subsequent routing and delivery, the variable &$self_hostname$& contains the
19072 name of the local host that the router encountered. This can be used to
19073 distinguish between different cases for hosts with multiple names. The
19074 combination
19075 .code
19076 self = pass
19077 no_more
19078 .endd
19079 ensures that only those addresses that routed to the local host are passed on.
19080 Without &%no_more%&, addresses that were declined for other reasons would also
19081 be passed to the next router.
19082
19083 .vitem &%fail%&
19084 Delivery fails and an error report is generated.
19085
19086 .vitem &%send%&
19087 .cindex "local host" "sending to"
19088 The anomaly is ignored and the address is queued for the transport. This
19089 setting should be used with extreme caution. For an &(smtp)& transport, it
19090 makes sense only in cases where the program that is listening on the SMTP port
19091 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19092 different configuration file that handles the domain in another way.
19093 .endlist
19094
19095
19096
19097 .option senders routers&!? "address list&!!" unset
19098 .cindex "router" "checking senders"
19099 If this option is set, the router is skipped unless the message's sender
19100 address matches something on the list.
19101 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19102 are evaluated.
19103
19104 There are issues concerning verification when the running of routers is
19105 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19106 setting, it sets the sender to the null string. When using the &%-bt%& option
19107 to check a configuration file, it is necessary also to use the &%-f%& option to
19108 set an appropriate sender. For incoming mail, the sender is unset when
19109 verifying the sender, but is available when verifying any recipients. If the
19110 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19111 matters.
19112
19113
19114 .new
19115 .option set routers "string list" unset
19116 .cindex router variables
19117 This option may be used multiple times on a router;
19118 because of this the list aspect is mostly irrelevant.
19119 The list separator is a semicolon but can be changed in the
19120 usual way.
19121
19122 Each list-element given must be of the form $"name = value"$
19123 and the names used must start with the string &"r_"&.
19124 Values containing a list-separator should have them doubled.
19125 When a router runs, the strings are evaluated in order,
19126 to create variables which are added to the set associated with
19127 the address.
19128 The variable is set with the expansion of the value.
19129 The variables can be used by the router options
19130 (not including any preconditions)
19131 and by the transport.
19132 Later definitions of a given named variable will override former ones.
19133 Varible use is via the usual &$r_...$& syntax.
19134
19135 This is similar to the &%address_data%& option, except that
19136 many independent variables can be used, with choice of naming.
19137 .wen
19138
19139
19140 .option translate_ip_address routers string&!! unset
19141 .cindex "IP address" "translating"
19142 .cindex "packet radio"
19143 .cindex "router" "IP address translation"
19144 There exist some rare networking situations (for example, packet radio) where
19145 it is helpful to be able to translate IP addresses generated by normal routing
19146 mechanisms into other IP addresses, thus performing a kind of manual IP
19147 routing. This should be done only if the normal IP routing of the TCP/IP stack
19148 is inadequate or broken. Because this is an extremely uncommon requirement, the
19149 code to support this option is not included in the Exim binary unless
19150 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19151
19152 .vindex "&$host_address$&"
19153 The &%translate_ip_address%& string is expanded for every IP address generated
19154 by the router, with the generated address set in &$host_address$&. If the
19155 expansion is forced to fail, no action is taken.
19156 For any other expansion error, delivery of the message is deferred.
19157 If the result of the expansion is an IP address, that replaces the original
19158 address; otherwise the result is assumed to be a host name &-- this is looked
19159 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19160 produce one or more replacement IP addresses. For example, to subvert all IP
19161 addresses in some specific networks, this could be added to a router:
19162 .code
19163 translate_ip_address = \
19164   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19165     {$value}fail}}
19166 .endd
19167 The file would contain lines like
19168 .code
19169 10.2.3.128/26    some.host
19170 10.8.4.34/26     10.44.8.15
19171 .endd
19172 You should not make use of this facility unless you really understand what you
19173 are doing.
19174
19175
19176
19177 .option transport routers string&!! unset
19178 This option specifies the transport to be used when a router accepts an address
19179 and sets it up for delivery. A transport is never needed if a router is used
19180 only for verification. The value of the option is expanded at routing time,
19181 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19182 and result must be the name of one of the configured transports. If it is not,
19183 delivery is deferred.
19184
19185 The &%transport%& option is not used by the &(redirect)& router, but it does
19186 have some private options that set up transports for pipe and file deliveries
19187 (see chapter &<<CHAPredirect>>&).
19188
19189
19190
19191 .option transport_current_directory routers string&!! unset
19192 .cindex "current directory for local transport"
19193 This option associates a current directory with any address that is routed
19194 to a local transport. This can happen either because a transport is
19195 explicitly configured for the router, or because it generates a delivery to a
19196 file or a pipe. During the delivery process (that is, at transport time), this
19197 option string is expanded and is set as the current directory, unless
19198 overridden by a setting on the transport.
19199 If the expansion fails for any reason, including forced failure, an error is
19200 logged, and delivery is deferred.
19201 See chapter &<<CHAPenvironment>>& for details of the local delivery
19202 environment.
19203
19204
19205
19206
19207 .option transport_home_directory routers string&!! "see below"
19208 .cindex "home directory" "for local transport"
19209 This option associates a home directory with any address that is routed to a
19210 local transport. This can happen either because a transport is explicitly
19211 configured for the router, or because it generates a delivery to a file or a
19212 pipe. During the delivery process (that is, at transport time), the option
19213 string is expanded and is set as the home directory, unless overridden by a
19214 setting of &%home_directory%& on the transport.
19215 If the expansion fails for any reason, including forced failure, an error is
19216 logged, and delivery is deferred.
19217
19218 If the transport does not specify a home directory, and
19219 &%transport_home_directory%& is not set for the router, the home directory for
19220 the transport is taken from the password data if &%check_local_user%& is set for
19221 the router. Otherwise it is taken from &%router_home_directory%& if that option
19222 is set; if not, no home directory is set for the transport.
19223
19224 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19225 environment.
19226
19227
19228
19229
19230 .option unseen routers boolean&!! false
19231 .cindex "router" "carrying on after success"
19232 The result of string expansion for this option must be a valid boolean value,
19233 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19234 result causes an error, and delivery is deferred. If the expansion is forced to
19235 fail, the default value for the option (false) is used. Other failures cause
19236 delivery to be deferred.
19237
19238 When this option is set true, routing does not cease if the router accepts the
19239 address. Instead, a copy of the incoming address is passed to the next router,
19240 overriding a false setting of &%more%&. There is little point in setting
19241 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19242 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19243 sometimes true and sometimes false).
19244
19245 .cindex "copy of message (&%unseen%& option)"
19246 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19247 qualifier in filter files. It can be used to cause copies of messages to be
19248 delivered to some other destination, while also carrying out a normal delivery.
19249 In effect, the current address is made into a &"parent"& that has two children
19250 &-- one that is delivered as specified by this router, and a clone that goes on
19251 to be routed further. For this reason, &%unseen%& may not be combined with the
19252 &%one_time%& option in a &(redirect)& router.
19253
19254 &*Warning*&: Header lines added to the address (or specified for removal) by
19255 this router or by previous routers affect the &"unseen"& copy of the message
19256 only. The clone that continues to be processed by further routers starts with
19257 no added headers and none specified for removal. For a &%redirect%& router, if
19258 a generated address is the same as the incoming address, this can lead to
19259 duplicate addresses with different header modifications. Exim does not do
19260 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19261 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19262 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19263 &%redirect%& router may be of help.
19264
19265 Unlike the handling of header modifications, any data that was set by the
19266 &%address_data%& option in the current or previous routers &'is'& passed on to
19267 subsequent routers.
19268
19269
19270 .option user routers string&!! "see below"
19271 .cindex "uid (user id)" "local delivery"
19272 .cindex "local transports" "uid and gid"
19273 .cindex "transport" "local"
19274 .cindex "router" "user for filter processing"
19275 .cindex "filter" "user for processing"
19276 When a router queues an address for a transport, and the transport does not
19277 specify a user, the user given here is used when running the delivery process.
19278 The user may be specified numerically or by name. If expansion fails, the
19279 error is logged and delivery is deferred.
19280 This user is also used by the &(redirect)& router when running a filter file.
19281 The default is unset, except when &%check_local_user%& is set. In this case,
19282 the default is taken from the password information. If the user is specified as
19283 a name, and &%group%& is not set, the group associated with the user is used.
19284 See also &%initgroups%& and &%group%& and the discussion in chapter
19285 &<<CHAPenvironment>>&.
19286
19287
19288
19289 .option verify routers&!? boolean true
19290 Setting this option has the effect of setting &%verify_sender%& and
19291 &%verify_recipient%& to the same value.
19292
19293
19294 .option verify_only routers&!? boolean false
19295 .cindex "EXPN" "with &%verify_only%&"
19296 .oindex "&%-bv%&"
19297 .cindex "router" "used only when verifying"
19298 If this option is set, the router is used only when verifying an address,
19299 delivering in cutthrough mode or
19300 testing with the &%-bv%& option, not when actually doing a delivery, testing
19301 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19302 restricted to verifying only senders or recipients by means of
19303 &%verify_sender%& and &%verify_recipient%&.
19304
19305 &*Warning*&: When the router is being run to verify addresses for an incoming
19306 SMTP message, Exim is not running as root, but under its own uid. If the router
19307 accesses any files, you need to make sure that they are accessible to the Exim
19308 user or group.
19309
19310
19311 .option verify_recipient routers&!? boolean true
19312 If this option is false, the router is skipped when verifying recipient
19313 addresses,
19314 delivering in cutthrough mode
19315 or testing recipient verification using &%-bv%&.
19316 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19317 are evaluated.
19318 See also the &$verify_mode$& variable.
19319
19320
19321 .option verify_sender routers&!? boolean true
19322 If this option is false, the router is skipped when verifying sender addresses
19323 or testing sender verification using &%-bvs%&.
19324 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19325 are evaluated.
19326 See also the &$verify_mode$& variable.
19327 .ecindex IIDgenoprou1
19328 .ecindex IIDgenoprou2
19329
19330
19331
19332
19333
19334
19335 . ////////////////////////////////////////////////////////////////////////////
19336 . ////////////////////////////////////////////////////////////////////////////
19337
19338 .chapter "The accept router" "CHID4"
19339 .cindex "&(accept)& router"
19340 .cindex "routers" "&(accept)&"
19341 The &(accept)& router has no private options of its own. Unless it is being
19342 used purely for verification (see &%verify_only%&) a transport is required to
19343 be defined by the generic &%transport%& option. If the preconditions that are
19344 specified by generic options are met, the router accepts the address and queues
19345 it for the given transport. The most common use of this router is for setting
19346 up deliveries to local mailboxes. For example:
19347 .code
19348 localusers:
19349   driver = accept
19350   domains = mydomain.example
19351   check_local_user
19352   transport = local_delivery
19353 .endd
19354 The &%domains%& condition in this example checks the domain of the address, and
19355 &%check_local_user%& checks that the local part is the login of a local user.
19356 When both preconditions are met, the &(accept)& router runs, and queues the
19357 address for the &(local_delivery)& transport.
19358
19359
19360
19361
19362
19363
19364 . ////////////////////////////////////////////////////////////////////////////
19365 . ////////////////////////////////////////////////////////////////////////////
19366
19367 .chapter "The dnslookup router" "CHAPdnslookup"
19368 .scindex IIDdnsrou1 "&(dnslookup)& router"
19369 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19370 The &(dnslookup)& router looks up the hosts that handle mail for the
19371 recipient's domain in the DNS. A transport must always be set for this router,
19372 unless &%verify_only%& is set.
19373
19374 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19375 SRV records. If none are found, or if SRV support is not configured,
19376 MX records are looked up. If no MX records exist, address records are sought.
19377 However, &%mx_domains%& can be set to disable the direct use of address
19378 records.
19379
19380 MX records of equal priority are sorted by Exim into a random order. Exim then
19381 looks for address records for the host names obtained from MX or SRV records.
19382 When a host has more than one IP address, they are sorted into a random order,
19383 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19384 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19385 generic option, the router declines.
19386
19387 Unless they have the highest priority (lowest MX value), MX records that point
19388 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19389 are discarded, together with any other MX records of equal or lower priority.
19390
19391 .cindex "MX record" "pointing to local host"
19392 .cindex "local host" "MX pointing to"
19393 .oindex "&%self%&" "in &(dnslookup)& router"
19394 If the host pointed to by the highest priority MX record, or looked up as an
19395 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19396 happens is controlled by the generic &%self%& option.
19397
19398
19399 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19400 There have been problems with DNS servers when SRV records are looked up.
19401 Some misbehaving servers return a DNS error or timeout when a non-existent
19402 SRV record is sought. Similar problems have in the past been reported for
19403 MX records. The global &%dns_again_means_nonexist%& option can help with this
19404 problem, but it is heavy-handed because it is a global option.
19405
19406 For this reason, there are two options, &%srv_fail_domains%& and
19407 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19408 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19409 an attempt to look up an SRV or MX record causes one of these results, and the
19410 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19411 such record"&. In the case of an SRV lookup, this means that the router
19412 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19413 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19414 case routing fails.
19415
19416
19417 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19418 .cindex "&(dnslookup)& router" "declines"
19419 There are a few cases where a &(dnslookup)& router will decline to accept
19420 an address; if such a router is expected to handle "all remaining non-local
19421 domains", then it is important to set &%no_more%&.
19422
19423 The router will defer rather than decline if the domain
19424 is found in the &%fail_defer_domains%& router option.
19425
19426 Reasons for a &(dnslookup)& router to decline currently include:
19427 .ilist
19428 The domain does not exist in DNS
19429 .next
19430 The domain exists but the MX record's host part is just "."; this is a common
19431 convention (borrowed from SRV) used to indicate that there is no such service
19432 for this domain and to not fall back to trying A/AAAA records.
19433 .next
19434 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19435 .next
19436 MX record points to a non-existent host.
19437 .next
19438 MX record points to an IP address and the main section option
19439 &%allow_mx_to_ip%& is not set.
19440 .next
19441 MX records exist and point to valid hosts, but all hosts resolve only to
19442 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19443 .next
19444 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19445 &%dns_check_names_pattern%& for handling one variant of this)
19446 .next
19447 &%check_secondary_mx%& is set on this router but the local host can
19448 not be found in the MX records (see below)
19449 .endlist
19450
19451
19452
19453
19454 .section "Private options for dnslookup" "SECID118"
19455 .cindex "options" "&(dnslookup)& router"
19456 The private options for the &(dnslookup)& router are as follows:
19457
19458 .option check_secondary_mx dnslookup boolean false
19459 .cindex "MX record" "checking for secondary"
19460 If this option is set, the router declines unless the local host is found in
19461 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19462 process domains for which the local host is a secondary mail exchanger
19463 differently to other domains. The way in which Exim decides whether a host is
19464 the local host is described in section &<<SECTreclocipadd>>&.
19465
19466
19467 .option check_srv dnslookup string&!! unset
19468 .cindex "SRV record" "enabling use of"
19469 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19470 addition to MX and address records. The support is disabled by default. To
19471 enable SRV support, set the &%check_srv%& option to the name of the service
19472 required. For example,
19473 .code
19474 check_srv = smtp
19475 .endd
19476 looks for SRV records that refer to the normal smtp service. The option is
19477 expanded, so the service name can vary from message to message or address
19478 to address. This might be helpful if SRV records are being used for a
19479 submission service. If the expansion is forced to fail, the &%check_srv%&
19480 option is ignored, and the router proceeds to look for MX records in the
19481 normal way.
19482
19483 When the expansion succeeds, the router searches first for SRV records for
19484 the given service (it assumes TCP protocol). A single SRV record with a
19485 host name that consists of just a single dot indicates &"no such service for
19486 this domain"&; if this is encountered, the router declines. If other kinds of
19487 SRV record are found, they are used to construct a host list for delivery
19488 according to the rules of RFC 2782. MX records are not sought in this case.
19489
19490 When no SRV records are found, MX records (and address records) are sought in
19491 the traditional way. In other words, SRV records take precedence over MX
19492 records, just as MX records take precedence over address records. Note that
19493 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19494 defined it. It is apparently believed that MX records are sufficient for email
19495 and that SRV records should not be used for this purpose. However, SRV records
19496 have an additional &"weight"& feature which some people might find useful when
19497 trying to split an SMTP load between hosts of different power.
19498
19499 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19500 when there is a DNS lookup error.
19501
19502
19503
19504
19505 .option fail_defer_domains dnslookup "domain list&!!" unset
19506 .cindex "MX record" "not found"
19507 DNS lookups for domains matching &%fail_defer_domains%&
19508 which find no matching record will cause the router to defer
19509 rather than the default behaviour of decline.
19510 This maybe be useful for queueing messages for a newly created
19511 domain while the DNS configuration is not ready.
19512 However, it will result in any message with mistyped domains
19513 also being queued.
19514
19515
19516 .option ipv4_only "string&!!" unset
19517 .cindex IPv6 disabling
19518 .cindex DNS "IPv6 disabling"
19519 The string is expanded, and if the result is anything but a forced failure,
19520 or an empty string, or one of the strings “0” or “no” or “false”
19521 (checked without regard to the case of the letters),
19522 only A records are used.
19523
19524 .option ipv4_prefer "string&!!" unset
19525 .cindex IPv4 preference
19526 .cindex DNS "IPv4 preference"
19527 The string is expanded, and if the result is anything but a forced failure,
19528 or an empty string, or one of the strings “0” or “no” or “false”
19529 (checked without regard to the case of the letters),
19530 A records are sorted before AAAA records (inverting the default).
19531
19532 .option mx_domains dnslookup "domain list&!!" unset
19533 .cindex "MX record" "required to exist"
19534 .cindex "SRV record" "required to exist"
19535 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19536 record in order to be recognized. (The name of this option could be improved.)
19537 For example, if all the mail hosts in &'fict.example'& are known to have MX
19538 records, except for those in &'discworld.fict.example'&, you could use this
19539 setting:
19540 .code
19541 mx_domains = ! *.discworld.fict.example : *.fict.example
19542 .endd
19543 This specifies that messages addressed to a domain that matches the list but
19544 has no MX record should be bounced immediately instead of being routed using
19545 the address record.
19546
19547
19548 .option mx_fail_domains dnslookup "domain list&!!" unset
19549 If the DNS lookup for MX records for one of the domains in this list causes a
19550 DNS lookup error, Exim behaves as if no MX records were found. See section
19551 &<<SECTprowitdnsloo>>& for more discussion.
19552
19553
19554
19555
19556 .option qualify_single dnslookup boolean true
19557 .cindex "DNS" "resolver options"
19558 .cindex "DNS" "qualifying single-component names"
19559 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19560 lookups. Typically, but not standardly, this causes the resolver to qualify
19561 single-component names with the default domain. For example, on a machine
19562 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19563 &'thesaurus.ref.example'& inside the resolver. For details of what your
19564 resolver actually does, consult your man pages for &'resolver'& and
19565 &'resolv.conf'&.
19566
19567
19568
19569 .option rewrite_headers dnslookup boolean true
19570 .cindex "rewriting" "header lines"
19571 .cindex "header lines" "rewriting"
19572 If the domain name in the address that is being processed is not fully
19573 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19574 an address is specified as &'dormouse@teaparty'&, the domain might be
19575 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19576 occur as a result of setting the &%widen_domains%& option. If
19577 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19578 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19579 header lines of the message are rewritten with the full domain name.
19580
19581 This option should be turned off only when it is known that no message is
19582 ever going to be sent outside an environment where the abbreviation makes
19583 sense.
19584
19585 When an MX record is looked up in the DNS and matches a wildcard record, name
19586 servers normally return a record containing the name that has been looked up,
19587 making it impossible to detect whether a wildcard was present or not. However,
19588 some name servers have recently been seen to return the wildcard entry. If the
19589 name returned by a DNS lookup begins with an asterisk, it is not used for
19590 header rewriting.
19591
19592
19593 .option same_domain_copy_routing dnslookup boolean false
19594 .cindex "address" "copying routing"
19595 Addresses with the same domain are normally routed by the &(dnslookup)& router
19596 to the same list of hosts. However, this cannot be presumed, because the router
19597 options and preconditions may refer to the local part of the address. By
19598 default, therefore, Exim routes each address in a message independently. DNS
19599 servers run caches, so repeated DNS lookups are not normally expensive, and in
19600 any case, personal messages rarely have more than a few recipients.
19601
19602 If you are running mailing lists with large numbers of subscribers at the same
19603 domain, and you are using a &(dnslookup)& router which is independent of the
19604 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19605 lookups for identical domains in one message. In this case, when &(dnslookup)&
19606 routes an address to a remote transport, any other unrouted addresses in the
19607 message that have the same domain are automatically given the same routing
19608 without processing them independently,
19609 provided the following conditions are met:
19610
19611 .ilist
19612 No router that processed the address specified &%headers_add%& or
19613 &%headers_remove%&.
19614 .next
19615 The router did not change the address in any way, for example, by &"widening"&
19616 the domain.
19617 .endlist
19618
19619
19620
19621
19622 .option search_parents dnslookup boolean false
19623 .cindex "DNS" "resolver options"
19624 When this option is true, the resolver option RES_DNSRCH is set for DNS
19625 lookups. This is different from the &%qualify_single%& option in that it
19626 applies to domains containing dots. Typically, but not standardly, it causes
19627 the resolver to search for the name in the current domain and in parent
19628 domains. For example, on a machine in the &'fict.example'& domain, if looking
19629 up &'teaparty.wonderland'& failed, the resolver would try
19630 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19631 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19632
19633 Setting this option true can cause problems in domains that have a wildcard MX
19634 record, because any domain that does not have its own MX record matches the
19635 local wildcard.
19636
19637
19638
19639 .option srv_fail_domains dnslookup "domain list&!!" unset
19640 If the DNS lookup for SRV records for one of the domains in this list causes a
19641 DNS lookup error, Exim behaves as if no SRV records were found. See section
19642 &<<SECTprowitdnsloo>>& for more discussion.
19643
19644
19645
19646
19647 .option widen_domains dnslookup "string list" unset
19648 .cindex "domain" "partial; widening"
19649 If a DNS lookup fails and this option is set, each of its strings in turn is
19650 added onto the end of the domain, and the lookup is tried again. For example,
19651 if
19652 .code
19653 widen_domains = fict.example:ref.example
19654 .endd
19655 is set and a lookup of &'klingon.dictionary'& fails,
19656 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19657 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19658 and &%search_parents%& options can cause some widening to be undertaken inside
19659 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19660 when verifying, unless &%rewrite_headers%& is false (not the default).
19661
19662
19663 .section "Effect of qualify_single and search_parents" "SECID119"
19664 When a domain from an envelope recipient is changed by the resolver as a result
19665 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19666 corresponding address in the message's header lines unless &%rewrite_headers%&
19667 is set false. Exim then re-routes the address, using the full domain.
19668
19669 These two options affect only the DNS lookup that takes place inside the router
19670 for the domain of the address that is being routed. They do not affect lookups
19671 such as that implied by
19672 .code
19673 domains = @mx_any
19674 .endd
19675 that may happen while processing a router precondition before the router is
19676 entered. No widening ever takes place for these lookups.
19677 .ecindex IIDdnsrou1
19678 .ecindex IIDdnsrou2
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688 . ////////////////////////////////////////////////////////////////////////////
19689 . ////////////////////////////////////////////////////////////////////////////
19690
19691 .chapter "The ipliteral router" "CHID5"
19692 .cindex "&(ipliteral)& router"
19693 .cindex "domain literal" "routing"
19694 .cindex "routers" "&(ipliteral)&"
19695 This router has no private options. Unless it is being used purely for
19696 verification (see &%verify_only%&) a transport is required to be defined by the
19697 generic &%transport%& option. The router accepts the address if its domain part
19698 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19699 router handles the address
19700 .code
19701 root@[192.168.1.1]
19702 .endd
19703 by setting up delivery to the host with that IP address. IPv4 domain literals
19704 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19705 are similar, but the address is preceded by &`ipv6:`&. For example:
19706 .code
19707 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19708 .endd
19709 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19710 grounds that sooner or later somebody will try it.
19711
19712 .oindex "&%self%&" "in &(ipliteral)& router"
19713 If the IP address matches something in &%ignore_target_hosts%&, the router
19714 declines. If an IP literal turns out to refer to the local host, the generic
19715 &%self%& option determines what happens.
19716
19717 The RFCs require support for domain literals; however, their use is
19718 controversial in today's Internet. If you want to use this router, you must
19719 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19720 Exim will not recognize the domain literal syntax in addresses.
19721
19722
19723
19724 . ////////////////////////////////////////////////////////////////////////////
19725 . ////////////////////////////////////////////////////////////////////////////
19726
19727 .chapter "The iplookup router" "CHID6"
19728 .cindex "&(iplookup)& router"
19729 .cindex "routers" "&(iplookup)&"
19730 The &(iplookup)& router was written to fulfil a specific requirement in
19731 Cambridge University (which in fact no longer exists). For this reason, it is
19732 not included in the binary of Exim by default. If you want to include it, you
19733 must set
19734 .code
19735 ROUTER_IPLOOKUP=yes
19736 .endd
19737 in your &_Local/Makefile_& configuration file.
19738
19739 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19740 connection to one or more specific hosts. The host can then return the same or
19741 a different address &-- in effect rewriting the recipient address in the
19742 message's envelope. The new address is then passed on to subsequent routers. If
19743 this process fails, the address can be passed on to other routers, or delivery
19744 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19745 must not be specified for it.
19746
19747 .cindex "options" "&(iplookup)& router"
19748 .option hosts iplookup string unset
19749 This option must be supplied. Its value is a colon-separated list of host
19750 names. The hosts are looked up using &[gethostbyname()]&
19751 (or &[getipnodebyname()]& when available)
19752 and are tried in order until one responds to the query. If none respond, what
19753 happens is controlled by &%optional%&.
19754
19755
19756 .option optional iplookup boolean false
19757 If &%optional%& is true, if no response is obtained from any host, the address
19758 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19759 delivery to the address is deferred.
19760
19761
19762 .option port iplookup integer 0
19763 .cindex "port" "&(iplookup)& router"
19764 This option must be supplied. It specifies the port number for the TCP or UDP
19765 call.
19766
19767
19768 .option protocol iplookup string udp
19769 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19770 protocols is to be used.
19771
19772
19773 .option query iplookup string&!! "see below"
19774 This defines the content of the query that is sent to the remote hosts. The
19775 default value is:
19776 .code
19777 $local_part@$domain $local_part@$domain
19778 .endd
19779 The repetition serves as a way of checking that a response is to the correct
19780 query in the default case (see &%response_pattern%& below).
19781
19782
19783 .option reroute iplookup string&!! unset
19784 If this option is not set, the rerouted address is precisely the byte string
19785 returned by the remote host, up to the first white space, if any. If set, the
19786 string is expanded to form the rerouted address. It can include parts matched
19787 in the response by &%response_pattern%& by means of numeric variables such as
19788 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19789 whether or not a pattern is in use. In all cases, the rerouted address must end
19790 up in the form &'local_part@domain'&.
19791
19792
19793 .option response_pattern iplookup string unset
19794 This option can be set to a regular expression that is applied to the string
19795 returned from the remote host. If the pattern does not match the response, the
19796 router declines. If &%response_pattern%& is not set, no checking of the
19797 response is done, unless the query was defaulted, in which case there is a
19798 check that the text returned after the first white space is the original
19799 address. This checks that the answer that has been received is in response to
19800 the correct question. For example, if the response is just a new domain, the
19801 following could be used:
19802 .code
19803 response_pattern = ^([^@]+)$
19804 reroute = $local_part@$1
19805 .endd
19806
19807 .option timeout iplookup time 5s
19808 This specifies the amount of time to wait for a response from the remote
19809 machine. The same timeout is used for the &[connect()]& function for a TCP
19810 call. It does not apply to UDP.
19811
19812
19813
19814
19815 . ////////////////////////////////////////////////////////////////////////////
19816 . ////////////////////////////////////////////////////////////////////////////
19817
19818 .chapter "The manualroute router" "CHID7"
19819 .scindex IIDmanrou1 "&(manualroute)& router"
19820 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19821 .cindex "domain" "manually routing"
19822 The &(manualroute)& router is so-called because it provides a way of manually
19823 routing an address according to its domain. It is mainly used when you want to
19824 route addresses to remote hosts according to your own rules, bypassing the
19825 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19826 route to local transports, a facility that may be useful if you want to save
19827 messages for dial-in hosts in local files.
19828
19829 The &(manualroute)& router compares a list of domain patterns with the domain
19830 it is trying to route. If there is no match, the router declines. Each pattern
19831 has associated with it a list of hosts and some other optional data, which may
19832 include a transport. The combination of a pattern and its data is called a
19833 &"routing rule"&. For patterns that do not have an associated transport, the
19834 generic &%transport%& option must specify a transport, unless the router is
19835 being used purely for verification (see &%verify_only%&).
19836
19837 .vindex "&$host$&"
19838 In the case of verification, matching the domain pattern is sufficient for the
19839 router to accept the address. When actually routing an address for delivery,
19840 an address that matches a domain pattern is queued for the associated
19841 transport. If the transport is not a local one, a host list must be associated
19842 with the pattern; IP addresses are looked up for the hosts, and these are
19843 passed to the transport along with the mail address. For local transports, a
19844 host list is optional. If it is present, it is passed in &$host$& as a single
19845 text string.
19846
19847 The list of routing rules can be provided as an inline string in
19848 &%route_list%&, or the data can be obtained by looking up the domain in a file
19849 or database by setting &%route_data%&. Only one of these settings may appear in
19850 any one instance of &(manualroute)&. The format of routing rules is described
19851 below, following the list of private options.
19852
19853
19854 .section "Private options for manualroute" "SECTprioptman"
19855
19856 .cindex "options" "&(manualroute)& router"
19857 The private options for the &(manualroute)& router are as follows:
19858
19859 .option host_all_ignored manualroute string defer
19860 See &%host_find_failed%&.
19861
19862 .option host_find_failed manualroute string freeze
19863 This option controls what happens when &(manualroute)& tries to find an IP
19864 address for a host, and the host does not exist. The option can be set to one
19865 of the following values:
19866 .code
19867 decline
19868 defer
19869 fail
19870 freeze
19871 ignore
19872 pass
19873 .endd
19874 The default (&"freeze"&) assumes that this state is a serious configuration
19875 error. The difference between &"pass"& and &"decline"& is that the former
19876 forces the address to be passed to the next router (or the router defined by
19877 &%pass_router%&),
19878 .oindex "&%more%&"
19879 overriding &%no_more%&, whereas the latter passes the address to the next
19880 router only if &%more%& is true.
19881
19882 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19883 cannot be found. If all the hosts in the list are ignored, the behaviour is
19884 controlled by the &%host_all_ignored%& option. This takes the same values
19885 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19886
19887 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19888 state; if a host lookup gets a temporary error, delivery is deferred unless the
19889 generic &%pass_on_timeout%& option is set.
19890
19891
19892 .option hosts_randomize manualroute boolean false
19893 .cindex "randomized host list"
19894 .cindex "host" "list of; randomized"
19895 If this option is set, the order of the items in a host list in a routing rule
19896 is randomized each time the list is used, unless an option in the routing rule
19897 overrides (see below). Randomizing the order of a host list can be used to do
19898 crude load sharing. However, if more than one mail address is routed by the
19899 same router to the same host list, the host lists are considered to be the same
19900 (even though they may be randomized into different orders) for the purpose of
19901 deciding whether to batch the deliveries into a single SMTP transaction.
19902
19903 When &%hosts_randomize%& is true, a host list may be split
19904 into groups whose order is separately randomized. This makes it possible to
19905 set up MX-like behaviour. The boundaries between groups are indicated by an
19906 item that is just &`+`& in the host list. For example:
19907 .code
19908 route_list = * host1:host2:host3:+:host4:host5
19909 .endd
19910 The order of the first three hosts and the order of the last two hosts is
19911 randomized for each use, but the first three always end up before the last two.
19912 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19913 randomized host list is passed to an &(smtp)& transport that also has
19914 &%hosts_randomize set%&, the list is not re-randomized.
19915
19916
19917 .option route_data manualroute string&!! unset
19918 If this option is set, it must expand to yield the data part of a routing rule.
19919 Typically, the expansion string includes a lookup based on the domain. For
19920 example:
19921 .code
19922 route_data = ${lookup{$domain}dbm{/etc/routes}}
19923 .endd
19924 If the expansion is forced to fail, or the result is an empty string, the
19925 router declines. Other kinds of expansion failure cause delivery to be
19926 deferred.
19927
19928
19929 .option route_list manualroute "string list" unset
19930 This string is a list of routing rules, in the form defined below. Note that,
19931 unlike most string lists, the items are separated by semicolons. This is so
19932 that they may contain colon-separated host lists.
19933
19934
19935 .option same_domain_copy_routing manualroute boolean false
19936 .cindex "address" "copying routing"
19937 Addresses with the same domain are normally routed by the &(manualroute)&
19938 router to the same list of hosts. However, this cannot be presumed, because the
19939 router options and preconditions may refer to the local part of the address. By
19940 default, therefore, Exim routes each address in a message independently. DNS
19941 servers run caches, so repeated DNS lookups are not normally expensive, and in
19942 any case, personal messages rarely have more than a few recipients.
19943
19944 If you are running mailing lists with large numbers of subscribers at the same
19945 domain, and you are using a &(manualroute)& router which is independent of the
19946 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19947 lookups for identical domains in one message. In this case, when
19948 &(manualroute)& routes an address to a remote transport, any other unrouted
19949 addresses in the message that have the same domain are automatically given the
19950 same routing without processing them independently. However, this is only done
19951 if &%headers_add%& and &%headers_remove%& are unset.
19952
19953
19954
19955
19956 .section "Routing rules in route_list" "SECID120"
19957 The value of &%route_list%& is a string consisting of a sequence of routing
19958 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19959 entered as two semicolons. Alternatively, the list separator can be changed as
19960 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19961 Empty rules are ignored. The format of each rule is
19962 .display
19963 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19964 .endd
19965 The following example contains two rules, each with a simple domain pattern and
19966 no options:
19967 .code
19968 route_list = \
19969   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19970   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19971 .endd
19972 The three parts of a rule are separated by white space. The pattern and the
19973 list of hosts can be enclosed in quotes if necessary, and if they are, the
19974 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19975 single domain pattern, which is the only mandatory item in the rule. The
19976 pattern is in the same format as one item in a domain list (see section
19977 &<<SECTdomainlist>>&),
19978 except that it may not be the name of an interpolated file.
19979 That is, it may be wildcarded, or a regular expression, or a file or database
19980 lookup (with semicolons doubled, because of the use of semicolon as a separator
19981 in a &%route_list%&).
19982
19983 The rules in &%route_list%& are searched in order until one of the patterns
19984 matches the domain that is being routed. The list of hosts and then options are
19985 then used as described below. If there is no match, the router declines. When
19986 &%route_list%& is set, &%route_data%& must not be set.
19987
19988
19989
19990 .section "Routing rules in route_data" "SECID121"
19991 The use of &%route_list%& is convenient when there are only a small number of
19992 routing rules. For larger numbers, it is easier to use a file or database to
19993 hold the routing information, and use the &%route_data%& option instead.
19994 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19995 Most commonly, &%route_data%& is set as a string that contains an
19996 expansion lookup. For example, suppose we place two routing rules in a file
19997 like this:
19998 .code
19999 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20000 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20001 .endd
20002 This data can be accessed by setting
20003 .code
20004 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20005 .endd
20006 Failure of the lookup results in an empty string, causing the router to
20007 decline. However, you do not have to use a lookup in &%route_data%&. The only
20008 requirement is that the result of expanding the string is a list of hosts,
20009 possibly followed by options, separated by white space. The list of hosts must
20010 be enclosed in quotes if it contains white space.
20011
20012
20013
20014
20015 .section "Format of the list of hosts" "SECID122"
20016 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20017 always separately expanded before use. If the expansion fails, the router
20018 declines. The result of the expansion must be a colon-separated list of names
20019 and/or IP addresses, optionally also including ports.
20020 If the list is written with spaces, it must be protected with quotes.
20021 The format of each item
20022 in the list is described in the next section. The list separator can be changed
20023 as described in section &<<SECTlistsepchange>>&.
20024
20025 If the list of hosts was obtained from a &%route_list%& item, the following
20026 variables are set during its expansion:
20027
20028 .ilist
20029 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20030 If the domain was matched against a regular expression, the numeric variables
20031 &$1$&, &$2$&, etc. may be set. For example:
20032 .code
20033 route_list = ^domain(\d+)   host-$1.text.example
20034 .endd
20035 .next
20036 &$0$& is always set to the entire domain.
20037 .next
20038 &$1$& is also set when partial matching is done in a file lookup.
20039
20040 .next
20041 .vindex "&$value$&"
20042 If the pattern that matched the domain was a lookup item, the data that was
20043 looked up is available in the expansion variable &$value$&. For example:
20044 .code
20045 route_list = lsearch;;/some/file.routes  $value
20046 .endd
20047 .endlist
20048
20049 Note the doubling of the semicolon in the pattern that is necessary because
20050 semicolon is the default route list separator.
20051
20052
20053
20054 .section "Format of one host item" "SECTformatonehostitem"
20055 Each item in the list of hosts is either a host name or an IP address,
20056 optionally with an attached port number. When no port is given, an IP address
20057 is not enclosed in brackets. When a port is specified, it overrides the port
20058 specification on the transport. The port is separated from the name or address
20059 by a colon. This leads to some complications:
20060
20061 .ilist
20062 Because colon is the default separator for the list of hosts, either
20063 the colon that specifies a port must be doubled, or the list separator must
20064 be changed. The following two examples have the same effect:
20065 .code
20066 route_list = * "host1.tld::1225 : host2.tld::1226"
20067 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20068 .endd
20069 .next
20070 When IPv6 addresses are involved, it gets worse, because they contain
20071 colons of their own. To make this case easier, it is permitted to
20072 enclose an IP address (either v4 or v6) in square brackets if a port
20073 number follows. For example:
20074 .code
20075 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20076 .endd
20077 .endlist
20078
20079 .section "How the list of hosts is used" "SECThostshowused"
20080 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20081 the hosts is tried, in the order specified, when carrying out the SMTP
20082 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20083 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20084 transport.
20085
20086 Hosts may be listed by name or by IP address. An unadorned name in the list of
20087 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20088 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20089 records in the DNS. For example:
20090 .code
20091 route_list = *  x.y.z:p.q.r/MX:e.f.g
20092 .endd
20093 If this feature is used with a port specifier, the port must come last. For
20094 example:
20095 .code
20096 route_list = *  dom1.tld/mx::1225
20097 .endd
20098 If the &%hosts_randomize%& option is set, the order of the items in the list is
20099 randomized before any lookups are done. Exim then scans the list; for any name
20100 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20101 be an interface on the local host and the item is not the first in the list,
20102 Exim discards it and any subsequent items. If it is the first item, what
20103 happens is controlled by the
20104 .oindex "&%self%&" "in &(manualroute)& router"
20105 &%self%& option of the router.
20106
20107 A name on the list that is followed by &`/MX`& is replaced with the list of
20108 hosts obtained by looking up MX records for the name. This is always a DNS
20109 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20110 below) are not relevant here. The order of these hosts is determined by the
20111 preference values in the MX records, according to the usual rules. Because
20112 randomizing happens before the MX lookup, it does not affect the order that is
20113 defined by MX preferences.
20114
20115 If the local host is present in the sublist obtained from MX records, but is
20116 not the most preferred host in that list, it and any equally or less
20117 preferred hosts are removed before the sublist is inserted into the main list.
20118
20119 If the local host is the most preferred host in the MX list, what happens
20120 depends on where in the original list of hosts the &`/MX`& item appears. If it
20121 is not the first item (that is, there are previous hosts in the main list),
20122 Exim discards this name and any subsequent items in the main list.
20123
20124 If the MX item is first in the list of hosts, and the local host is the
20125 most preferred host, what happens is controlled by the &%self%& option of the
20126 router.
20127
20128 DNS failures when lookup up the MX records are treated in the same way as DNS
20129 failures when looking up IP addresses: &%pass_on_timeout%& and
20130 &%host_find_failed%& are used when relevant.
20131
20132 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20133 whether obtained from an MX lookup or not.
20134
20135
20136
20137 .section "How the options are used" "SECThowoptused"
20138 The options are a sequence of words, space-separated.
20139 One of the words can be the name of a transport; this overrides the
20140 &%transport%& option on the router for this particular routing rule only. The
20141 other words (if present) control randomization of the list of hosts on a
20142 per-rule basis, and how the IP addresses of the hosts are to be found when
20143 routing to a remote transport. These options are as follows:
20144
20145 .ilist
20146 &%randomize%&: randomize the order of the hosts in this list, overriding the
20147 setting of &%hosts_randomize%& for this routing rule only.
20148 .next
20149 &%no_randomize%&: do not randomize the order of the hosts in this list,
20150 overriding the setting of &%hosts_randomize%& for this routing rule only.
20151 .next
20152 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20153 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20154 also look in &_/etc/hosts_& or other sources of information.
20155 .next
20156 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20157 no address records are found. If there is a temporary DNS error (such as a
20158 timeout), delivery is deferred.
20159 .next
20160 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20161 .next
20162 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20163 .endlist
20164
20165 For example:
20166 .code
20167 route_list = domain1  host1:host2:host3  randomize bydns;\
20168              domain2  host4:host5
20169 .endd
20170 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20171 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20172 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20173 or &[gethostbyname()]&, and the result of the lookup is the result of that
20174 call.
20175
20176 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20177 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20178 instead of TRY_AGAIN. That is why the default action is to try a DNS
20179 lookup first. Only if that gives a definite &"no such host"& is the local
20180 function called.
20181
20182 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20183 inadvertent constraint that a transport name as an option had to be the last
20184 option specified.
20185
20186
20187
20188 If no IP address for a host can be found, what happens is controlled by the
20189 &%host_find_failed%& option.
20190
20191 .vindex "&$host$&"
20192 When an address is routed to a local transport, IP addresses are not looked up.
20193 The host list is passed to the transport in the &$host$& variable.
20194
20195
20196
20197 .section "Manualroute examples" "SECID123"
20198 In some of the examples that follow, the presence of the &%remote_smtp%&
20199 transport, as defined in the default configuration file, is assumed:
20200
20201 .ilist
20202 .cindex "smart host" "example router"
20203 The &(manualroute)& router can be used to forward all external mail to a
20204 &'smart host'&. If you have set up, in the main part of the configuration, a
20205 named domain list that contains your local domains, for example:
20206 .code
20207 domainlist local_domains = my.domain.example
20208 .endd
20209 You can arrange for all other domains to be routed to a smart host by making
20210 your first router something like this:
20211 .code
20212 smart_route:
20213   driver = manualroute
20214   domains = !+local_domains
20215   transport = remote_smtp
20216   route_list = * smarthost.ref.example
20217 .endd
20218 This causes all non-local addresses to be sent to the single host
20219 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20220 they are tried in order
20221 (but you can use &%hosts_randomize%& to vary the order each time).
20222 Another way of configuring the same thing is this:
20223 .code
20224 smart_route:
20225   driver = manualroute
20226   transport = remote_smtp
20227   route_list = !+local_domains  smarthost.ref.example
20228 .endd
20229 There is no difference in behaviour between these two routers as they stand.
20230 However, they behave differently if &%no_more%& is added to them. In the first
20231 example, the router is skipped if the domain does not match the &%domains%&
20232 precondition; the following router is always tried. If the router runs, it
20233 always matches the domain and so can never decline. Therefore, &%no_more%&
20234 would have no effect. In the second case, the router is never skipped; it
20235 always runs. However, if it doesn't match the domain, it declines. In this case
20236 &%no_more%& would prevent subsequent routers from running.
20237
20238 .next
20239 .cindex "mail hub example"
20240 A &'mail hub'& is a host which receives mail for a number of domains via MX
20241 records in the DNS and delivers it via its own private routing mechanism. Often
20242 the final destinations are behind a firewall, with the mail hub being the one
20243 machine that can connect to machines both inside and outside the firewall. The
20244 &(manualroute)& router is usually used on a mail hub to route incoming messages
20245 to the correct hosts. For a small number of domains, the routing can be inline,
20246 using the &%route_list%& option, but for a larger number a file or database
20247 lookup is easier to manage.
20248
20249 If the domain names are in fact the names of the machines to which the mail is
20250 to be sent by the mail hub, the configuration can be quite simple. For
20251 example:
20252 .code
20253 hub_route:
20254   driver = manualroute
20255   transport = remote_smtp
20256   route_list = *.rhodes.tvs.example  $domain
20257 .endd
20258 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20259 whose names are the same as the mail domains. A similar approach can be taken
20260 if the host name can be obtained from the domain name by a string manipulation
20261 that the expansion facilities can handle. Otherwise, a lookup based on the
20262 domain can be used to find the host:
20263 .code
20264 through_firewall:
20265   driver = manualroute
20266   transport = remote_smtp
20267   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20268 .endd
20269 The result of the lookup must be the name or IP address of the host (or
20270 hosts) to which the address is to be routed. If the lookup fails, the route
20271 data is empty, causing the router to decline. The address then passes to the
20272 next router.
20273
20274 .next
20275 .cindex "batched SMTP output example"
20276 .cindex "SMTP" "batched outgoing; example"
20277 You can use &(manualroute)& to deliver messages to pipes or files in batched
20278 SMTP format for onward transportation by some other means. This is one way of
20279 storing mail for a dial-up host when it is not connected. The route list entry
20280 can be as simple as a single domain name in a configuration like this:
20281 .code
20282 save_in_file:
20283   driver = manualroute
20284   transport = batchsmtp_appendfile
20285   route_list = saved.domain.example
20286 .endd
20287 though often a pattern is used to pick up more than one domain. If there are
20288 several domains or groups of domains with different transport requirements,
20289 different transports can be listed in the routing information:
20290 .code
20291 save_in_file:
20292   driver = manualroute
20293   route_list = \
20294     *.saved.domain1.example  $domain  batch_appendfile; \
20295     *.saved.domain2.example  \
20296       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20297       batch_pipe
20298 .endd
20299 .vindex "&$domain$&"
20300 .vindex "&$host$&"
20301 The first of these just passes the domain in the &$host$& variable, which
20302 doesn't achieve much (since it is also in &$domain$&), but the second does a
20303 file lookup to find a value to pass, causing the router to decline to handle
20304 the address if the lookup fails.
20305
20306 .next
20307 .cindex "UUCP" "example of router for"
20308 Routing mail directly to UUCP software is a specific case of the use of
20309 &(manualroute)& in a gateway to another mail environment. This is an example of
20310 one way it can be done:
20311 .code
20312 # Transport
20313 uucp:
20314   driver = pipe
20315   user = nobody
20316   command = /usr/local/bin/uux -r - \
20317     ${substr_-5:$host}!rmail ${local_part}
20318   return_fail_output = true
20319
20320 # Router
20321 uucphost:
20322   transport = uucp
20323   driver = manualroute
20324   route_data = \
20325     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20326 .endd
20327 The file &_/usr/local/exim/uucphosts_& contains entries like
20328 .code
20329 darksite.ethereal.example:           darksite.UUCP
20330 .endd
20331 It can be set up more simply without adding and removing &".UUCP"& but this way
20332 makes clear the distinction between the domain name
20333 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20334 .endlist
20335 .ecindex IIDmanrou1
20336 .ecindex IIDmanrou2
20337
20338
20339
20340
20341
20342
20343
20344
20345 . ////////////////////////////////////////////////////////////////////////////
20346 . ////////////////////////////////////////////////////////////////////////////
20347
20348 .chapter "The queryprogram router" "CHAPdriverlast"
20349 .scindex IIDquerou1 "&(queryprogram)& router"
20350 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20351 .cindex "routing" "by external program"
20352 The &(queryprogram)& router routes an address by running an external command
20353 and acting on its output. This is an expensive way to route, and is intended
20354 mainly for use in lightly-loaded systems, or for performing experiments.
20355 However, if it is possible to use the precondition options (&%domains%&,
20356 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20357 be used in special cases, even on a busy host. There are the following private
20358 options:
20359 .cindex "options" "&(queryprogram)& router"
20360
20361 .option command queryprogram string&!! unset
20362 This option must be set. It specifies the command that is to be run. The
20363 command is split up into a command name and arguments, and then each is
20364 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20365 &<<CHAPpipetransport>>&).
20366
20367
20368 .option command_group queryprogram string unset
20369 .cindex "gid (group id)" "in &(queryprogram)& router"
20370 This option specifies a gid to be set when running the command while routing an
20371 address for deliver. It must be set if &%command_user%& specifies a numerical
20372 uid. If it begins with a digit, it is interpreted as the numerical value of the
20373 gid. Otherwise it is looked up using &[getgrnam()]&.
20374
20375
20376 .option command_user queryprogram string unset
20377 .cindex "uid (user id)" "for &(queryprogram)&"
20378 This option must be set. It specifies the uid which is set when running the
20379 command while routing an address for delivery. If the value begins with a digit,
20380 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20381 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20382 not set, a value for the gid also.
20383
20384 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20385 root, which it does during a normal delivery in a conventional configuration.
20386 However, when an address is being verified during message reception, Exim is
20387 usually running as the Exim user, not as root. If the &(queryprogram)& router
20388 is called from a non-root process, Exim cannot change uid or gid before running
20389 the command. In this circumstance the command runs under the current uid and
20390 gid.
20391
20392
20393 .option current_directory queryprogram string /
20394 This option specifies an absolute path which is made the current directory
20395 before running the command.
20396
20397
20398 .option timeout queryprogram time 1h
20399 If the command does not complete within the timeout period, its process group
20400 is killed and the message is frozen. A value of zero time specifies no
20401 timeout.
20402
20403
20404 The standard output of the command is connected to a pipe, which is read when
20405 the command terminates. It should consist of a single line of output,
20406 containing up to five fields, separated by white space. The maximum length of
20407 the line is 1023 characters. Longer lines are silently truncated. The first
20408 field is one of the following words (case-insensitive):
20409
20410 .ilist
20411 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20412 below).
20413 .next
20414 &'Decline'&: the router declines; pass the address to the next router, unless
20415 &%no_more%& is set.
20416 .next
20417 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20418 subsequent text on the line is an error message. If the router is run as part
20419 of address verification during an incoming SMTP message, the message is
20420 included in the SMTP response.
20421 .next
20422 &'Defer'&: routing could not be completed at this time; try again later. Any
20423 subsequent text on the line is an error message which is logged. It is not
20424 included in any SMTP response.
20425 .next
20426 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20427 .next
20428 &'Pass'&: pass the address to the next router (or the router specified by
20429 &%pass_router%&), overriding &%no_more%&.
20430 .next
20431 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20432 new addresses, which are routed independently, starting with the first router,
20433 or the router specified by &%redirect_router%&, if set.
20434 .endlist
20435
20436 When the first word is &'accept'&, the remainder of the line consists of a
20437 number of keyed data values, as follows (split into two lines here, to fit on
20438 the page):
20439 .code
20440 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20441 LOOKUP=byname|bydns DATA=<text>
20442 .endd
20443 The data items can be given in any order, and all are optional. If no transport
20444 is included, the transport specified by the generic &%transport%& option is
20445 used. The list of hosts and the lookup type are needed only if the transport is
20446 an &(smtp)& transport that does not itself supply a list of hosts.
20447
20448 The format of the list of hosts is the same as for the &(manualroute)& router.
20449 As well as host names and IP addresses with optional port numbers, as described
20450 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20451 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20452 (see section &<<SECThostshowused>>&).
20453
20454 If the lookup type is not specified, Exim behaves as follows when trying to
20455 find an IP address for each host: First, a DNS lookup is done. If this yields
20456 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20457 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20458 result of the lookup is the result of that call.
20459
20460 .vindex "&$address_data$&"
20461 If the DATA field is set, its value is placed in the &$address_data$&
20462 variable. For example, this return line
20463 .code
20464 accept hosts=x1.y.example:x2.y.example data="rule1"
20465 .endd
20466 routes the address to the default transport, passing a list of two hosts. When
20467 the transport runs, the string &"rule1"& is in &$address_data$&.
20468 .ecindex IIDquerou1
20469 .ecindex IIDquerou2
20470
20471
20472
20473
20474 . ////////////////////////////////////////////////////////////////////////////
20475 . ////////////////////////////////////////////////////////////////////////////
20476
20477 .chapter "The redirect router" "CHAPredirect"
20478 .scindex IIDredrou1 "&(redirect)& router"
20479 .scindex IIDredrou2 "routers" "&(redirect)&"
20480 .cindex "alias file" "in a &(redirect)& router"
20481 .cindex "address redirection" "&(redirect)& router"
20482 The &(redirect)& router handles several kinds of address redirection. Its most
20483 common uses are for resolving local part aliases from a central alias file
20484 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20485 files, but it has many other potential uses. The incoming address can be
20486 redirected in several different ways:
20487
20488 .ilist
20489 It can be replaced by one or more new addresses which are themselves routed
20490 independently.
20491 .next
20492 It can be routed to be delivered to a given file or directory.
20493 .next
20494 It can be routed to be delivered to a specified pipe command.
20495 .next
20496 It can cause an automatic reply to be generated.
20497 .next
20498 It can be forced to fail, optionally with a custom error message.
20499 .next
20500 It can be temporarily deferred, optionally with a custom message.
20501 .next
20502 It can be discarded.
20503 .endlist
20504
20505 The generic &%transport%& option must not be set for &(redirect)& routers.
20506 However, there are some private options which define transports for delivery to
20507 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20508 &%pipe_transport%& and &%reply_transport%& descriptions below.
20509
20510 If success DSNs have been requested
20511 .cindex "DSN" "success"
20512 .cindex "Delivery Status Notification" "success"
20513 redirection triggers one and the DSN options are not passed any further.
20514
20515
20516
20517 .section "Redirection data" "SECID124"
20518 The router operates by interpreting a text string which it obtains either by
20519 expanding the contents of the &%data%& option, or by reading the entire
20520 contents of a file whose name is given in the &%file%& option. These two
20521 options are mutually exclusive. The first is commonly used for handling system
20522 aliases, in a configuration like this:
20523 .code
20524 system_aliases:
20525   driver = redirect
20526   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20527 .endd
20528 If the lookup fails, the expanded string in this example is empty. When the
20529 expansion of &%data%& results in an empty string, the router declines. A forced
20530 expansion failure also causes the router to decline; other expansion failures
20531 cause delivery to be deferred.
20532
20533 A configuration using &%file%& is commonly used for handling users'
20534 &_.forward_& files, like this:
20535 .code
20536 userforward:
20537   driver = redirect
20538   check_local_user
20539   file = $home/.forward
20540   no_verify
20541 .endd
20542 If the file does not exist, or causes no action to be taken (for example, it is
20543 empty or consists only of comments), the router declines. &*Warning*&: This
20544 is not the case when the file contains syntactically valid items that happen to
20545 yield empty addresses, for example, items containing only RFC 2822 address
20546 comments.
20547
20548
20549
20550 .section "Forward files and address verification" "SECID125"
20551 .cindex "address redirection" "while verifying"
20552 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20553 &_.forward_& files, as in the example above. There are two reasons for this:
20554
20555 .ilist
20556 When Exim is receiving an incoming SMTP message from a remote host, it is
20557 running under the Exim uid, not as root. Exim is unable to change uid to read
20558 the file as the user, and it may not be able to read it as the Exim user. So in
20559 practice the router may not be able to operate.
20560 .next
20561 However, even when the router can operate, the existence of a &_.forward_& file
20562 is unimportant when verifying an address. What should be checked is whether the
20563 local part is a valid user name or not. Cutting out the redirection processing
20564 saves some resources.
20565 .endlist
20566
20567
20568
20569
20570
20571
20572 .section "Interpreting redirection data" "SECID126"
20573 .cindex "Sieve filter" "specifying in redirection data"
20574 .cindex "filter" "specifying in redirection data"
20575 The contents of the data string, whether obtained from &%data%& or &%file%&,
20576 can be interpreted in two different ways:
20577
20578 .ilist
20579 If the &%allow_filter%& option is set true, and the data begins with the text
20580 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20581 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20582 respectively. Details of the syntax and semantics of filter files are described
20583 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20584 document is intended for use by end users.
20585 .next
20586 Otherwise, the data must be a comma-separated list of redirection items, as
20587 described in the next section.
20588 .endlist
20589
20590 When a message is redirected to a file (a &"mail folder"&), the filename given
20591 in a non-filter redirection list must always be an absolute path. A filter may
20592 generate a relative path &-- how this is handled depends on the transport's
20593 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20594 for the &(appendfile)& transport.
20595
20596
20597
20598 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20599 .cindex "address redirection" "non-filter list items"
20600 When the redirection data is not an Exim or Sieve filter, for example, if it
20601 comes from a conventional alias or forward file, it consists of a list of
20602 addresses, filenames, pipe commands, or certain special items (see section
20603 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20604 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20605 depending on their default values. The items in the list are separated by
20606 commas or newlines.
20607 If a comma is required in an item, the entire item must be enclosed in double
20608 quotes.
20609
20610 Lines starting with a # character are comments, and are ignored, and # may
20611 also appear following a comma, in which case everything between the # and the
20612 next newline character is ignored.
20613
20614 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20615 double quotes are retained because some forms of mail address require their use
20616 (but never to enclose the entire address). In the following description,
20617 &"item"& refers to what remains after any surrounding double quotes have been
20618 removed.
20619
20620 .vindex "&$local_part$&"
20621 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20622 and the expansion contains a reference to &$local_part$&, you should make use
20623 of the &%quote_local_part%& expansion operator, in case the local part contains
20624 special characters. For example, to redirect all mail for the domain
20625 &'obsolete.example'&, retaining the existing local part, you could use this
20626 setting:
20627 .code
20628 data = ${quote_local_part:$local_part}@newdomain.example
20629 .endd
20630
20631
20632 .section "Redirecting to a local mailbox" "SECTredlocmai"
20633 .cindex "routing" "loops in"
20634 .cindex "loop" "while routing, avoidance of"
20635 .cindex "address redirection" "to local mailbox"
20636 A redirection item may safely be the same as the address currently under
20637 consideration. This does not cause a routing loop, because a router is
20638 automatically skipped if any ancestor of the address that is being processed
20639 is the same as the current address and was processed by the current router.
20640 Such an address is therefore passed to the following routers, so it is handled
20641 as if there were no redirection. When making this loop-avoidance test, the
20642 complete local part, including any prefix or suffix, is used.
20643
20644 .cindex "address redirection" "local part without domain"
20645 Specifying the same local part without a domain is a common usage in personal
20646 filter files when the user wants to have messages delivered to the local
20647 mailbox and also forwarded elsewhere. For example, the user whose login is
20648 &'cleo'& might have a &_.forward_& file containing this:
20649 .code
20650 cleo, cleopatra@egypt.example
20651 .endd
20652 .cindex "backslash in alias file"
20653 .cindex "alias file" "backslash in"
20654 For compatibility with other MTAs, such unqualified local parts may be
20655 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20656 it does make a difference if more than one domain is being handled
20657 synonymously.
20658
20659 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20660 2822 address that does not include a domain, the item is qualified using the
20661 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20662 addresses are qualified using the value in &%qualify_recipient%&, but you can
20663 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20664
20665 Care must be taken if there are alias names for local users.
20666 Consider an MTA handling a single local domain where the system alias file
20667 contains:
20668 .code
20669 Sam.Reman: spqr
20670 .endd
20671 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20672 messages in the local mailbox, and also forward copies elsewhere. He creates
20673 this forward file:
20674 .code
20675 Sam.Reman, spqr@reme.elsewhere.example
20676 .endd
20677 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20678 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20679 second time round, because it has previously routed it,
20680 and the following routers presumably cannot handle the alias. The forward file
20681 should really contain
20682 .code
20683 spqr, spqr@reme.elsewhere.example
20684 .endd
20685 but because this is such a common error, the &%check_ancestor%& option (see
20686 below) exists to provide a way to get round it. This is normally set on a
20687 &(redirect)& router that is handling users' &_.forward_& files.
20688
20689
20690
20691 .section "Special items in redirection lists" "SECTspecitredli"
20692 In addition to addresses, the following types of item may appear in redirection
20693 lists (that is, in non-filter redirection data):
20694
20695 .ilist
20696 .cindex "pipe" "in redirection list"
20697 .cindex "address redirection" "to pipe"
20698 An item is treated as a pipe command if it begins with &"|"& and does not parse
20699 as a valid RFC 2822 address that includes a domain. A transport for running the
20700 command must be specified by the &%pipe_transport%& option.
20701 Normally, either the router or the transport specifies a user and a group under
20702 which to run the delivery. The default is to use the Exim user and group.
20703
20704 Single or double quotes can be used for enclosing the individual arguments of
20705 the pipe command; no interpretation of escapes is done for single quotes. If
20706 the command contains a comma character, it is necessary to put the whole item
20707 in double quotes, for example:
20708 .code
20709 "|/some/command ready,steady,go"
20710 .endd
20711 since items in redirection lists are terminated by commas. Do not, however,
20712 quote just the command. An item such as
20713 .code
20714 |"/some/command ready,steady,go"
20715 .endd
20716 is interpreted as a pipe with a rather strange command name, and no arguments.
20717
20718 Note that the above example assumes that the text comes from a lookup source
20719 of some sort, so that the quotes are part of the data.  If composing a
20720 redirect router with a &%data%& option directly specifying this command, the
20721 quotes will be used by the configuration parser to define the extent of one
20722 string, but will not be passed down into the redirect router itself.  There
20723 are two main approaches to get around this: escape quotes to be part of the
20724 data itself, or avoid using this mechanism and instead create a custom
20725 transport with the &%command%& option set and reference that transport from
20726 an &%accept%& router.
20727
20728 .next
20729 .cindex "file" "in redirection list"
20730 .cindex "address redirection" "to file"
20731 An item is interpreted as a path name if it begins with &"/"& and does not
20732 parse as a valid RFC 2822 address that includes a domain. For example,
20733 .code
20734 /home/world/minbari
20735 .endd
20736 is treated as a filename, but
20737 .code
20738 /s=molari/o=babylon/@x400gate.way
20739 .endd
20740 is treated as an address. For a filename, a transport must be specified using
20741 the &%file_transport%& option. However, if the generated path name ends with a
20742 forward slash character, it is interpreted as a directory name rather than a
20743 filename, and &%directory_transport%& is used instead.
20744
20745 Normally, either the router or the transport specifies a user and a group under
20746 which to run the delivery. The default is to use the Exim user and group.
20747
20748 .cindex "&_/dev/null_&"
20749 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20750 bypassed at a high level, and the log entry shows &"**bypassed**"&
20751 instead of a transport name. In this case the user and group are not used.
20752
20753 .next
20754 .cindex "included address list"
20755 .cindex "address redirection" "included external list"
20756 If an item is of the form
20757 .code
20758 :include:<path name>
20759 .endd
20760 a list of further items is taken from the given file and included at that
20761 point. &*Note*&: Such a file can not be a filter file; it is just an
20762 out-of-line addition to the list. The items in the included list are separated
20763 by commas or newlines and are not subject to expansion. If this is the first
20764 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20765 the alias name. This example is incorrect:
20766 .code
20767 list1    :include:/opt/lists/list1
20768 .endd
20769 It must be given as
20770 .code
20771 list1:   :include:/opt/lists/list1
20772 .endd
20773 .next
20774 .cindex "address redirection" "to black hole"
20775 .cindex "delivery" "discard"
20776 .cindex "delivery" "blackhole"
20777 .cindex "black hole"
20778 .cindex "abandoning mail"
20779 Sometimes you want to throw away mail to a particular local part.  Making the
20780 &%data%& option expand to an empty string does not work, because that causes
20781 the router to decline. Instead, the alias item
20782 .code
20783 :blackhole:
20784 .endd
20785 can be used. It does what its name implies. No delivery is
20786 done, and no error message is generated. This has the same effect as specifying
20787 &_/dev/null_& as a destination, but it can be independently disabled.
20788
20789 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20790 delivery is done for the original local part, even if other redirection items
20791 are present. If you are generating a multi-item list (for example, by reading a
20792 database) and need the ability to provide a no-op item, you must use
20793 &_/dev/null_&.
20794
20795 .next
20796 .cindex "delivery" "forcing failure"
20797 .cindex "delivery" "forcing deferral"
20798 .cindex "failing delivery" "forcing"
20799 .cindex "deferred delivery, forcing"
20800 .cindex "customizing" "failure message"
20801 An attempt to deliver a particular address can be deferred or forced to fail by
20802 redirection items of the form
20803 .code
20804 :defer:
20805 :fail:
20806 .endd
20807 respectively. When a redirection list contains such an item, it applies
20808 to the entire redirection; any other items in the list are ignored. Any
20809 text following &':fail:'& or &':defer:'& is placed in the error text
20810 associated with the failure. For example, an alias file might contain:
20811 .code
20812 X.Employee:  :fail: Gone away, no forwarding address
20813 .endd
20814 In the case of an address that is being verified from an ACL or as the subject
20815 of a
20816 .cindex "VRFY" "error text, display of"
20817 VRFY command, the text is included in the SMTP error response by
20818 default.
20819 .cindex "EXPN" "error text, display of"
20820 The text is not included in the response to an EXPN command. In non-SMTP cases
20821 the text is included in the error message that Exim generates.
20822
20823 .cindex "SMTP" "error codes"
20824 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20825 &':fail:'&. However, if the message starts with three digits followed by a
20826 space, optionally followed by an extended code of the form &'n.n.n'&, also
20827 followed by a space, and the very first digit is the same as the default error
20828 code, the code from the message is used instead. If the very first digit is
20829 incorrect, a panic error is logged, and the default code is used. You can
20830 suppress the use of the supplied code in a redirect router by setting the
20831 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20832 ignored.
20833
20834 .vindex "&$acl_verify_message$&"
20835 In an ACL, an explicitly provided message overrides the default, but the
20836 default message is available in the variable &$acl_verify_message$& and can
20837 therefore be included in a custom message if this is desired.
20838
20839 Normally the error text is the rest of the redirection list &-- a comma does
20840 not terminate it &-- but a newline does act as a terminator. Newlines are not
20841 normally present in alias expansions. In &(lsearch)& lookups they are removed
20842 as part of the continuation process, but they may exist in other kinds of
20843 lookup and in &':include:'& files.
20844
20845 During routing for message delivery (as opposed to verification), a redirection
20846 containing &':fail:'& causes an immediate failure of the incoming address,
20847 whereas &':defer:'& causes the message to remain in the queue so that a
20848 subsequent delivery attempt can happen at a later time. If an address is
20849 deferred for too long, it will ultimately fail, because the normal retry
20850 rules still apply.
20851
20852 .next
20853 .cindex "alias file" "exception to default"
20854 Sometimes it is useful to use a single-key search type with a default (see
20855 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20856 for exceptions to the default. These can be handled by aliasing them to
20857 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20858 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20859 results in an empty redirection list has the same effect.
20860 .endlist
20861
20862
20863 .section "Duplicate addresses" "SECTdupaddr"
20864 .cindex "duplicate addresses"
20865 .cindex "address duplicate, discarding"
20866 .cindex "pipe" "duplicated"
20867 Exim removes duplicate addresses from the list to which it is delivering, so as
20868 to deliver just one copy to each address. This does not apply to deliveries
20869 routed to pipes by different immediate parent addresses, but an indirect
20870 aliasing scheme of the type
20871 .code
20872 pipe:       |/some/command $local_part
20873 localpart1: pipe
20874 localpart2: pipe
20875 .endd
20876 does not work with a message that is addressed to both local parts, because
20877 when the second is aliased to the intermediate local part &"pipe"& it gets
20878 discarded as being the same as a previously handled address. However, a scheme
20879 such as
20880 .code
20881 localpart1: |/some/command $local_part
20882 localpart2: |/some/command $local_part
20883 .endd
20884 does result in two different pipe deliveries, because the immediate parents of
20885 the pipes are distinct.
20886
20887
20888
20889 .section "Repeated redirection expansion" "SECID128"
20890 .cindex "repeated redirection expansion"
20891 .cindex "address redirection" "repeated for each delivery attempt"
20892 When a message cannot be delivered to all of its recipients immediately,
20893 leading to two or more delivery attempts, redirection expansion is carried out
20894 afresh each time for those addresses whose children were not all previously
20895 delivered. If redirection is being used as a mailing list, this can lead to new
20896 members of the list receiving copies of old messages. The &%one_time%& option
20897 can be used to avoid this.
20898
20899
20900 .section "Errors in redirection lists" "SECID129"
20901 .cindex "address redirection" "errors"
20902 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20903 error is skipped, and an entry is written to the main log. This may be useful
20904 for mailing lists that are automatically managed. Otherwise, if an error is
20905 detected while generating the list of new addresses, the original address is
20906 deferred. See also &%syntax_errors_to%&.
20907
20908
20909
20910 .section "Private options for the redirect router" "SECID130"
20911
20912 .cindex "options" "&(redirect)& router"
20913 The private options for the &(redirect)& router are as follows:
20914
20915
20916 .option allow_defer redirect boolean false
20917 Setting this option allows the use of &':defer:'& in non-filter redirection
20918 data, or the &%defer%& command in an Exim filter file.
20919
20920
20921 .option allow_fail redirect boolean false
20922 .cindex "failing delivery" "from filter"
20923 If this option is true, the &':fail:'& item can be used in a redirection list,
20924 and the &%fail%& command may be used in an Exim filter file.
20925
20926
20927 .option allow_filter redirect boolean false
20928 .cindex "filter" "enabling use of"
20929 .cindex "Sieve filter" "enabling use of"
20930 Setting this option allows Exim to interpret redirection data that starts with
20931 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20932 are some features of Exim filter files that some administrators may wish to
20933 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20934
20935 It is also possible to lock out Exim filters or Sieve filters while allowing
20936 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20937
20938
20939 The filter is run using the uid and gid set by the generic &%user%& and
20940 &%group%& options. These take their defaults from the password data if
20941 &%check_local_user%& is set, so in the normal case of users' personal filter
20942 files, the filter is run as the relevant user. When &%allow_filter%& is set
20943 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20944
20945
20946
20947 .option allow_freeze redirect boolean false
20948 .cindex "freezing messages" "allowing in filter"
20949 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20950 This command is more normally encountered in system filters, and is disabled by
20951 default for redirection filters because it isn't something you usually want to
20952 let ordinary users do.
20953
20954
20955
20956 .option check_ancestor redirect boolean false
20957 This option is concerned with handling generated addresses that are the same
20958 as some address in the list of redirection ancestors of the current address.
20959 Although it is turned off by default in the code, it is set in the default
20960 configuration file for handling users' &_.forward_& files. It is recommended
20961 for this use of the &(redirect)& router.
20962
20963 When &%check_ancestor%& is set, if a generated address (including the domain)
20964 is the same as any ancestor of the current address, it is replaced by a copy of
20965 the current address. This helps in the case where local part A is aliased to B,
20966 and B has a &_.forward_& file pointing back to A. For example, within a single
20967 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20968 &_&~jb/.forward_& contains:
20969 .code
20970 \Joe.Bloggs, <other item(s)>
20971 .endd
20972 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20973 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20974 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20975 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20976 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20977 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20978 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20979 original address. See also the &%repeat_use%& option below.
20980
20981
20982 .option check_group redirect boolean "see below"
20983 When the &%file%& option is used, the group owner of the file is checked only
20984 when this option is set. The permitted groups are those listed in the
20985 &%owngroups%& option, together with the user's default group if
20986 &%check_local_user%& is set. If the file has the wrong group, routing is
20987 deferred. The default setting for this option is true if &%check_local_user%&
20988 is set and the &%modemask%& option permits the group write bit, or if the
20989 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20990
20991
20992
20993 .option check_owner redirect boolean "see below"
20994 When the &%file%& option is used, the owner of the file is checked only when
20995 this option is set. If &%check_local_user%& is set, the local user is
20996 permitted; otherwise the owner must be one of those listed in the &%owners%&
20997 option. The default value for this option is true if &%check_local_user%& or
20998 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20999
21000
21001 .option data redirect string&!! unset
21002 This option is mutually exclusive with &%file%&. One or other of them must be
21003 set, but not both. The contents of &%data%& are expanded, and then used as the
21004 list of forwarding items, or as a set of filtering instructions. If the
21005 expansion is forced to fail, or the result is an empty string or a string that
21006 has no effect (consists entirely of comments), the router declines.
21007
21008 When filtering instructions are used, the string must begin with &"#Exim
21009 filter"&, and all comments in the string, including this initial one, must be
21010 terminated with newline characters. For example:
21011 .code
21012 data = #Exim filter\n\
21013        if $h_to: contains Exim then save $home/mail/exim endif
21014 .endd
21015 If you are reading the data from a database where newlines cannot be included,
21016 you can use the &${sg}$& expansion item to turn the escape string of your
21017 choice into a newline.
21018
21019
21020 .option directory_transport redirect string&!! unset
21021 A &(redirect)& router sets up a direct delivery to a directory when a path name
21022 ending with a slash is specified as a new &"address"&. The transport used is
21023 specified by this option, which, after expansion, must be the name of a
21024 configured transport. This should normally be an &(appendfile)& transport.
21025
21026
21027 .option file redirect string&!! unset
21028 This option specifies the name of a file that contains the redirection data. It
21029 is mutually exclusive with the &%data%& option. The string is expanded before
21030 use; if the expansion is forced to fail, the router declines. Other expansion
21031 failures cause delivery to be deferred. The result of a successful expansion
21032 must be an absolute path. The entire file is read and used as the redirection
21033 data. If the data is an empty string or a string that has no effect (consists
21034 entirely of comments), the router declines.
21035
21036 .cindex "NFS" "checking for file existence"
21037 If the attempt to open the file fails with a &"does not exist"& error, Exim
21038 runs a check on the containing directory,
21039 unless &%ignore_enotdir%& is true (see below).
21040 If the directory does not appear to exist, delivery is deferred. This can
21041 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21042 is a mount problem. If the containing directory does exist, but the file does
21043 not, the router declines.
21044
21045
21046 .option file_transport redirect string&!! unset
21047 .vindex "&$address_file$&"
21048 A &(redirect)& router sets up a direct delivery to a file when a path name not
21049 ending in a slash is specified as a new &"address"&. The transport used is
21050 specified by this option, which, after expansion, must be the name of a
21051 configured transport. This should normally be an &(appendfile)& transport. When
21052 it is running, the filename is in &$address_file$&.
21053
21054
21055 .option filter_prepend_home redirect boolean true
21056 When this option is true, if a &(save)& command in an Exim filter specifies a
21057 relative path, and &$home$& is defined, it is automatically prepended to the
21058 relative path. If this option is set false, this action does not happen. The
21059 relative path is then passed to the transport unmodified.
21060
21061
21062 .option forbid_blackhole redirect boolean false
21063 .cindex "restricting access to features"
21064 .cindex "filter" "locking out certain features"
21065 If this option is true, the &':blackhole:'& item may not appear in a
21066 redirection list.
21067
21068
21069 .option forbid_exim_filter redirect boolean false
21070 .cindex "restricting access to features"
21071 .cindex "filter" "locking out certain features"
21072 If this option is set true, only Sieve filters are permitted when
21073 &%allow_filter%& is true.
21074
21075
21076
21077
21078 .option forbid_file redirect boolean false
21079 .cindex "restricting access to features"
21080 .cindex "delivery" "to file; forbidding"
21081 .cindex "filter" "locking out certain features"
21082 .cindex "Sieve filter" "forbidding delivery to a file"
21083 .cindex "Sieve filter" "&""keep""& facility; disabling"
21084 If this option is true, this router may not generate a new address that
21085 specifies delivery to a local file or directory, either from a filter or from a
21086 conventional forward file. This option is forced to be true if &%one_time%& is
21087 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21088 locks out the Sieve's &"keep"& facility.
21089
21090
21091 .option forbid_filter_dlfunc redirect boolean false
21092 .cindex "restricting access to features"
21093 .cindex "filter" "locking out certain features"
21094 If this option is true, string expansions in Exim filters are not allowed to
21095 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21096 functions.
21097
21098 .option forbid_filter_existstest redirect boolean false
21099 .cindex "restricting access to features"
21100 .cindex "filter" "locking out certain features"
21101 .cindex "expansion" "statting a file"
21102 If this option is true, string expansions in Exim filters are not allowed to
21103 make use of the &%exists%& condition or the &%stat%& expansion item.
21104
21105 .option forbid_filter_logwrite redirect boolean false
21106 .cindex "restricting access to features"
21107 .cindex "filter" "locking out certain features"
21108 If this option is true, use of the logging facility in Exim filters is not
21109 permitted. Logging is in any case available only if the filter is being run
21110 under some unprivileged uid (which is normally the case for ordinary users'
21111 &_.forward_& files).
21112
21113
21114 .option forbid_filter_lookup redirect boolean false
21115 .cindex "restricting access to features"
21116 .cindex "filter" "locking out certain features"
21117 If this option is true, string expansions in Exim filter files are not allowed
21118 to make use of &%lookup%& items.
21119
21120
21121 .option forbid_filter_perl redirect boolean false
21122 .cindex "restricting access to features"
21123 .cindex "filter" "locking out certain features"
21124 This option has an effect only if Exim is built with embedded Perl support. If
21125 it is true, string expansions in Exim filter files are not allowed to make use
21126 of the embedded Perl support.
21127
21128
21129 .option forbid_filter_readfile redirect boolean false
21130 .cindex "restricting access to features"
21131 .cindex "filter" "locking out certain features"
21132 If this option is true, string expansions in Exim filter files are not allowed
21133 to make use of &%readfile%& items.
21134
21135
21136 .option forbid_filter_readsocket redirect boolean false
21137 .cindex "restricting access to features"
21138 .cindex "filter" "locking out certain features"
21139 If this option is true, string expansions in Exim filter files are not allowed
21140 to make use of &%readsocket%& items.
21141
21142
21143 .option forbid_filter_reply redirect boolean false
21144 .cindex "restricting access to features"
21145 .cindex "filter" "locking out certain features"
21146 If this option is true, this router may not generate an automatic reply
21147 message. Automatic replies can be generated only from Exim or Sieve filter
21148 files, not from traditional forward files. This option is forced to be true if
21149 &%one_time%& is set.
21150
21151
21152 .option forbid_filter_run redirect boolean false
21153 .cindex "restricting access to features"
21154 .cindex "filter" "locking out certain features"
21155 If this option is true, string expansions in Exim filter files are not allowed
21156 to make use of &%run%& items.
21157
21158
21159 .option forbid_include redirect boolean false
21160 .cindex "restricting access to features"
21161 .cindex "filter" "locking out certain features"
21162 If this option is true, items of the form
21163 .code
21164 :include:<path name>
21165 .endd
21166 are not permitted in non-filter redirection lists.
21167
21168
21169 .option forbid_pipe redirect boolean false
21170 .cindex "restricting access to features"
21171 .cindex "filter" "locking out certain features"
21172 .cindex "delivery" "to pipe; forbidding"
21173 If this option is true, this router may not generate a new address which
21174 specifies delivery to a pipe, either from an Exim filter or from a conventional
21175 forward file. This option is forced to be true if &%one_time%& is set.
21176
21177
21178 .option forbid_sieve_filter redirect boolean false
21179 .cindex "restricting access to features"
21180 .cindex "filter" "locking out certain features"
21181 If this option is set true, only Exim filters are permitted when
21182 &%allow_filter%& is true.
21183
21184
21185 .cindex "SMTP" "error codes"
21186 .option forbid_smtp_code redirect boolean false
21187 If this option is set true, any SMTP error codes that are present at the start
21188 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21189 the default codes (451 and 550, respectively) are always used.
21190
21191
21192
21193
21194 .option hide_child_in_errmsg redirect boolean false
21195 .cindex "bounce message" "redirection details; suppressing"
21196 If this option is true, it prevents Exim from quoting a child address if it
21197 generates a bounce or delay message for it. Instead it says &"an address
21198 generated from <&'the top level address'&>"&. Of course, this applies only to
21199 bounces generated locally. If a message is forwarded to another host, &'its'&
21200 bounce may well quote the generated address.
21201
21202
21203 .option ignore_eacces redirect boolean false
21204 .cindex "EACCES"
21205 If this option is set and an attempt to open a redirection file yields the
21206 EACCES error (permission denied), the &(redirect)& router behaves as if the
21207 file did not exist.
21208
21209
21210 .option ignore_enotdir redirect boolean false
21211 .cindex "ENOTDIR"
21212 If this option is set and an attempt to open a redirection file yields the
21213 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21214 router behaves as if the file did not exist.
21215
21216 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21217 router that has the &%file%& option set discovers that the file does not exist
21218 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21219 against unmounted NFS directories. If the parent can not be statted, delivery
21220 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21221 is set, because that option tells Exim to ignore &"something on the path is not
21222 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21223 that some operating systems give ENOENT where others give ENOTDIR.
21224
21225
21226
21227 .option include_directory redirect string unset
21228 If this option is set, the path names of any &':include:'& items in a
21229 redirection list must start with this directory.
21230
21231
21232 .option modemask redirect "octal integer" 022
21233 This specifies mode bits which must not be set for a file specified by the
21234 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21235
21236
21237 .option one_time redirect boolean false
21238 .cindex "one-time aliasing/forwarding expansion"
21239 .cindex "alias file" "one-time expansion"
21240 .cindex "forward file" "one-time expansion"
21241 .cindex "mailing lists" "one-time expansion"
21242 .cindex "address redirection" "one-time expansion"
21243 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21244 files each time it tries to deliver a message causes a problem when one or more
21245 of the generated addresses fails be delivered at the first attempt. The problem
21246 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21247 but of what happens when the redirection list changes during the time that the
21248 message is on Exim's queue. This is particularly true in the case of mailing
21249 lists, where new subscribers might receive copies of messages that were posted
21250 before they subscribed.
21251
21252 If &%one_time%& is set and any addresses generated by the router fail to
21253 deliver at the first attempt, the failing addresses are added to the message as
21254 &"top level"& addresses, and the parent address that generated them is marked
21255 &"delivered"&. Thus, redirection does not happen again at the next delivery
21256 attempt.
21257
21258 &*Warning 1*&: Any header line addition or removal that is specified by this
21259 router would be lost if delivery did not succeed at the first attempt. For this
21260 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21261 permitted when &%one_time%& is set.
21262
21263 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21264 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21265 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21266
21267 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21268 &%one_time%&.
21269
21270 The original top-level address is remembered with each of the generated
21271 addresses, and is output in any log messages. However, any intermediate parent
21272 addresses are not recorded. This makes a difference to the log only if
21273 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21274 typically be used for mailing lists, where there is normally just one level of
21275 expansion.
21276
21277
21278 .option owners redirect "string list" unset
21279 .cindex "ownership" "alias file"
21280 .cindex "ownership" "forward file"
21281 .cindex "alias file" "ownership"
21282 .cindex "forward file" "ownership"
21283 This specifies a list of permitted owners for the file specified by &%file%&.
21284 This list is in addition to the local user when &%check_local_user%& is set.
21285 See &%check_owner%& above.
21286
21287
21288 .option owngroups redirect "string list" unset
21289 This specifies a list of permitted groups for the file specified by &%file%&.
21290 The list is in addition to the local user's primary group when
21291 &%check_local_user%& is set. See &%check_group%& above.
21292
21293
21294 .option pipe_transport redirect string&!! unset
21295 .vindex "&$address_pipe$&"
21296 A &(redirect)& router sets up a direct delivery to a pipe when a string
21297 starting with a vertical bar character is specified as a new &"address"&. The
21298 transport used is specified by this option, which, after expansion, must be the
21299 name of a configured transport. This should normally be a &(pipe)& transport.
21300 When the transport is run, the pipe command is in &$address_pipe$&.
21301
21302
21303 .option qualify_domain redirect string&!! unset
21304 .vindex "&$qualify_recipient$&"
21305 If this option is set, and an unqualified address (one without a domain) is
21306 generated, and that address would normally be qualified by the global setting
21307 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21308 expanding this string. If the expansion fails, the router declines. If you want
21309 to revert to the default, you can have the expansion generate
21310 &$qualify_recipient$&.
21311
21312 This option applies to all unqualified addresses generated by Exim filters,
21313 but for traditional &_.forward_& files, it applies only to addresses that are
21314 not preceded by a backslash. Sieve filters cannot generate unqualified
21315 addresses.
21316
21317 .option qualify_preserve_domain redirect boolean false
21318 .cindex "domain" "in redirection; preserving"
21319 .cindex "preserving domain in redirection"
21320 .cindex "address redirection" "domain; preserving"
21321 If this option is set, the router's local &%qualify_domain%& option must not be
21322 set (a configuration error occurs if it is). If an unqualified address (one
21323 without a domain) is generated, it is qualified with the domain of the parent
21324 address (the immediately preceding ancestor) instead of the global
21325 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21326 this applies whether or not the address is preceded by a backslash.
21327
21328
21329 .option repeat_use redirect boolean true
21330 If this option is set false, the router is skipped for a child address that has
21331 any ancestor that was routed by this router. This test happens before any of
21332 the other preconditions are tested. Exim's default anti-looping rules skip
21333 only when the ancestor is the same as the current address. See also
21334 &%check_ancestor%& above and the generic &%redirect_router%& option.
21335
21336
21337 .option reply_transport redirect string&!! unset
21338 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21339 &%vacation%& command is used in a filter file. The transport used is specified
21340 by this option, which, after expansion, must be the name of a configured
21341 transport. This should normally be an &(autoreply)& transport. Other transports
21342 are unlikely to do anything sensible or useful.
21343
21344
21345 .option rewrite redirect boolean true
21346 .cindex "address redirection" "disabling rewriting"
21347 If this option is set false, addresses generated by the router are not
21348 subject to address rewriting. Otherwise, they are treated like new addresses
21349 and are rewritten according to the global rewriting rules.
21350
21351
21352 .option sieve_subaddress redirect string&!! unset
21353 The value of this option is passed to a Sieve filter to specify the
21354 :subaddress part of an address.
21355
21356 .option sieve_useraddress redirect string&!! unset
21357 The value of this option is passed to a Sieve filter to specify the :user part
21358 of an address. However, if it is unset, the entire original local part
21359 (including any prefix or suffix) is used for :user.
21360
21361
21362 .option sieve_vacation_directory redirect string&!! unset
21363 .cindex "Sieve filter" "vacation directory"
21364 To enable the &"vacation"& extension for Sieve filters, you must set
21365 &%sieve_vacation_directory%& to the directory where vacation databases are held
21366 (do not put anything else in that directory), and ensure that the
21367 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21368 needs their own directory; Exim will create it if necessary.
21369
21370
21371
21372 .option skip_syntax_errors redirect boolean false
21373 .cindex "forward file" "broken"
21374 .cindex "address redirection" "broken files"
21375 .cindex "alias file" "broken"
21376 .cindex "broken alias or forward files"
21377 .cindex "ignoring faulty addresses"
21378 .cindex "skipping faulty addresses"
21379 .cindex "error" "skipping bad syntax"
21380 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21381 non-filter redirection data are skipped, and each failing address is logged. If
21382 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21383 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21384 are expanded and placed at the head of the error message generated by
21385 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21386 be the same address as the generic &%errors_to%& option. The
21387 &%skip_syntax_errors%& option is often used when handling mailing lists.
21388
21389 If all the addresses in a redirection list are skipped because of syntax
21390 errors, the router declines to handle the original address, and it is passed to
21391 the following routers.
21392
21393 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21394 error in the filter causes filtering to be abandoned without any action being
21395 taken. The incident is logged, and the router declines to handle the address,
21396 so it is passed to the following routers.
21397
21398 .cindex "Sieve filter" "syntax errors in"
21399 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21400 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21401 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21402
21403 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21404 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21405 option, used with an address that does not get redirected, can be used to
21406 notify users of these errors, by means of a router like this:
21407 .code
21408 userforward:
21409   driver = redirect
21410   allow_filter
21411   check_local_user
21412   file = $home/.forward
21413   file_transport = address_file
21414   pipe_transport = address_pipe
21415   reply_transport = address_reply
21416   no_verify
21417   skip_syntax_errors
21418   syntax_errors_to = real-$local_part@$domain
21419   syntax_errors_text = \
21420    This is an automatically generated message. An error has\n\
21421    been found in your .forward file. Details of the error are\n\
21422    reported below. While this error persists, you will receive\n\
21423    a copy of this message for every message that is addressed\n\
21424    to you. If your .forward file is a filter file, or if it is\n\
21425    a non-filter file containing no valid forwarding addresses,\n\
21426    a copy of each incoming message will be put in your normal\n\
21427    mailbox. If a non-filter file contains at least one valid\n\
21428    forwarding address, forwarding to the valid addresses will\n\
21429    happen, and those will be the only deliveries that occur.
21430 .endd
21431 You also need a router to ensure that local addresses that are prefixed by
21432 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21433 put this immediately before the &(userforward)& router:
21434 .code
21435 real_localuser:
21436   driver = accept
21437   check_local_user
21438   local_part_prefix = real-
21439   transport = local_delivery
21440 .endd
21441 For security, it would probably be a good idea to restrict the use of this
21442 router to locally-generated messages, using a condition such as this:
21443 .code
21444   condition = ${if match {$sender_host_address}\
21445                          {\N^(|127\.0\.0\.1)$\N}}
21446 .endd
21447
21448
21449 .option syntax_errors_text redirect string&!! unset
21450 See &%skip_syntax_errors%& above.
21451
21452
21453 .option syntax_errors_to redirect string unset
21454 See &%skip_syntax_errors%& above.
21455 .ecindex IIDredrou1
21456 .ecindex IIDredrou2
21457
21458
21459
21460
21461
21462
21463 . ////////////////////////////////////////////////////////////////////////////
21464 . ////////////////////////////////////////////////////////////////////////////
21465
21466 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21467          "Environment for local transports"
21468 .scindex IIDenvlotra1 "local transports" "environment for"
21469 .scindex IIDenvlotra2 "environment" "local transports"
21470 .scindex IIDenvlotra3 "transport" "local; environment for"
21471 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21472 transport can be thought of as similar to a pipe.) Exim always runs transports
21473 in subprocesses, under specified uids and gids. Typical deliveries to local
21474 mailboxes run under the uid and gid of the local user.
21475
21476 Exim also sets a specific current directory while running the transport; for
21477 some transports a home directory setting is also relevant. The &(pipe)&
21478 transport is the only one that sets up environment variables; see section
21479 &<<SECTpipeenv>>& for details.
21480
21481 The values used for the uid, gid, and the directories may come from several
21482 different places. In many cases, the router that handles the address associates
21483 settings with that address as a result of its &%check_local_user%&, &%group%&,
21484 or &%user%& options. However, values may also be given in the transport's own
21485 configuration, and these override anything that comes from the router.
21486
21487
21488
21489 .section "Concurrent deliveries" "SECID131"
21490 .cindex "concurrent deliveries"
21491 .cindex "simultaneous deliveries"
21492 If two different messages for the same local recipient arrive more or less
21493 simultaneously, the two delivery processes are likely to run concurrently. When
21494 the &(appendfile)& transport is used to write to a file, Exim applies locking
21495 rules to stop concurrent processes from writing to the same file at the same
21496 time.
21497
21498 However, when you use a &(pipe)& transport, it is up to you to arrange any
21499 locking that is needed. Here is a silly example:
21500 .code
21501 my_transport:
21502   driver = pipe
21503   command = /bin/sh -c 'cat >>/some/file'
21504 .endd
21505 This is supposed to write the message at the end of the file. However, if two
21506 messages arrive at the same time, the file will be scrambled. You can use the
21507 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21508 file using the same algorithm that Exim itself uses.
21509
21510
21511
21512
21513 .section "Uids and gids" "SECTenvuidgid"
21514 .cindex "local transports" "uid and gid"
21515 .cindex "transport" "local; uid and gid"
21516 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21517 overrides any group that the router set in the address, even if &%user%& is not
21518 set for the transport. This makes it possible, for example, to run local mail
21519 delivery under the uid of the recipient (set by the router), but in a special
21520 group (set by the transport). For example:
21521 .code
21522 # Routers ...
21523 # User/group are set by check_local_user in this router
21524 local_users:
21525   driver = accept
21526   check_local_user
21527   transport = group_delivery
21528
21529 # Transports ...
21530 # This transport overrides the group
21531 group_delivery:
21532   driver = appendfile
21533   file = /var/spool/mail/$local_part
21534   group = mail
21535 .endd
21536 If &%user%& is set for a transport, its value overrides what is set in the
21537 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21538 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21539 set.
21540
21541 .oindex "&%initgroups%&"
21542 When the uid is taken from the transport's configuration, the &[initgroups()]&
21543 function is called for the groups associated with that uid if the
21544 &%initgroups%& option is set for the transport. When the uid is not specified
21545 by the transport, but is associated with the address by a router, the option
21546 for calling &[initgroups()]& is taken from the router configuration.
21547
21548 .cindex "&(pipe)& transport" "uid for"
21549 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21550 is set and &%user%& is not set, the uid of the process that called Exim to
21551 receive the message is used, and if &%group%& is not set, the corresponding
21552 original gid is also used.
21553
21554 This is the detailed preference order for obtaining a gid; the first of the
21555 following that is set is used:
21556
21557 .ilist
21558 A &%group%& setting of the transport;
21559 .next
21560 A &%group%& setting of the router;
21561 .next
21562 A gid associated with a user setting of the router, either as a result of
21563 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21564 .next
21565 The group associated with a non-numeric &%user%& setting of the transport;
21566 .next
21567 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21568 the uid is the creator's uid;
21569 .next
21570 The Exim gid if the Exim uid is being used as a default.
21571 .endlist
21572
21573 If, for example, the user is specified numerically on the router and there are
21574 no group settings, no gid is available. In this situation, an error occurs.
21575 This is different for the uid, for which there always is an ultimate default.
21576 The first of the following that is set is used:
21577
21578 .ilist
21579 A &%user%& setting of the transport;
21580 .next
21581 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21582 .next
21583 A &%user%& setting of the router;
21584 .next
21585 A &%check_local_user%& setting of the router;
21586 .next
21587 The Exim uid.
21588 .endlist
21589
21590 Of course, an error will still occur if the uid that is chosen is on the
21591 &%never_users%& list.
21592
21593
21594
21595
21596
21597 .section "Current and home directories" "SECID132"
21598 .cindex "current directory for local transport"
21599 .cindex "home directory" "for local transport"
21600 .cindex "transport" "local; home directory for"
21601 .cindex "transport" "local; current directory for"
21602 Routers may set current and home directories for local transports by means of
21603 the &%transport_current_directory%& and &%transport_home_directory%& options.
21604 However, if the transport's &%current_directory%& or &%home_directory%& options
21605 are set, they override the router's values. In detail, the home directory
21606 for a local transport is taken from the first of these values that is set:
21607
21608 .ilist
21609 The &%home_directory%& option on the transport;
21610 .next
21611 The &%transport_home_directory%& option on the router;
21612 .next
21613 The password data if &%check_local_user%& is set on the router;
21614 .next
21615 The &%router_home_directory%& option on the router.
21616 .endlist
21617
21618 The current directory is taken from the first of these values that is set:
21619
21620 .ilist
21621 The &%current_directory%& option on the transport;
21622 .next
21623 The &%transport_current_directory%& option on the router.
21624 .endlist
21625
21626
21627 If neither the router nor the transport sets a current directory, Exim uses the
21628 value of the home directory, if it is set. Otherwise it sets the current
21629 directory to &_/_& before running a local transport.
21630
21631
21632
21633 .section "Expansion variables derived from the address" "SECID133"
21634 .vindex "&$domain$&"
21635 .vindex "&$local_part$&"
21636 .vindex "&$original_domain$&"
21637 Normally a local delivery is handling a single address, and in that case the
21638 variables such as &$domain$& and &$local_part$& are set during local
21639 deliveries. However, in some circumstances more than one address may be handled
21640 at once (for example, while writing batch SMTP for onward transmission by some
21641 other means). In this case, the variables associated with the local part are
21642 never set, &$domain$& is set only if all the addresses have the same domain,
21643 and &$original_domain$& is never set.
21644 .ecindex IIDenvlotra1
21645 .ecindex IIDenvlotra2
21646 .ecindex IIDenvlotra3
21647
21648
21649
21650
21651
21652
21653
21654 . ////////////////////////////////////////////////////////////////////////////
21655 . ////////////////////////////////////////////////////////////////////////////
21656
21657 .chapter "Generic options for transports" "CHAPtransportgeneric"
21658 .scindex IIDgenoptra1 "generic options" "transport"
21659 .scindex IIDgenoptra2 "options" "generic; for transports"
21660 .scindex IIDgenoptra3 "transport" "generic options for"
21661 The following generic options apply to all transports:
21662
21663
21664 .option body_only transports boolean false
21665 .cindex "transport" "body only"
21666 .cindex "message" "transporting body only"
21667 .cindex "body of message" "transporting"
21668 If this option is set, the message's headers are not transported. It is
21669 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21670 or &(pipe)& transports, the settings of &%message_prefix%& and
21671 &%message_suffix%& should be checked, because this option does not
21672 automatically suppress them.
21673
21674
21675 .option current_directory transports string&!! unset
21676 .cindex "transport" "current directory for"
21677 This specifies the current directory that is to be set while running the
21678 transport, overriding any value that may have been set by the router.
21679 If the expansion fails for any reason, including forced failure, an error is
21680 logged, and delivery is deferred.
21681
21682
21683 .option disable_logging transports boolean false
21684 If this option is set true, nothing is logged for any
21685 deliveries by the transport or for any
21686 transport errors. You should not set this option unless you really, really know
21687 what you are doing.
21688
21689
21690 .option debug_print transports string&!! unset
21691 .cindex "testing" "variables in drivers"
21692 If this option is set and debugging is enabled (see the &%-d%& command line
21693 option), the string is expanded and included in the debugging output when the
21694 transport is run.
21695 If expansion of the string fails, the error message is written to the debugging
21696 output, and Exim carries on processing.
21697 This facility is provided to help with checking out the values of variables and
21698 so on when debugging driver configurations. For example, if a &%headers_add%&
21699 option is not working properly, &%debug_print%& could be used to output the
21700 variables it references. A newline is added to the text if it does not end with
21701 one.
21702 The variables &$transport_name$& and &$router_name$& contain the name of the
21703 transport and the router that called it.
21704
21705 .option delivery_date_add transports boolean false
21706 .cindex "&'Delivery-date:'& header line"
21707 If this option is true, a &'Delivery-date:'& header is added to the message.
21708 This gives the actual time the delivery was made. As this is not a standard
21709 header, Exim has a configuration option (&%delivery_date_remove%&) which
21710 requests its removal from incoming messages, so that delivered messages can
21711 safely be resent to other recipients.
21712
21713
21714 .option driver transports string unset
21715 This specifies which of the available transport drivers is to be used.
21716 There is no default, and this option must be set for every transport.
21717
21718
21719 .option envelope_to_add transports boolean false
21720 .cindex "&'Envelope-to:'& header line"
21721 If this option is true, an &'Envelope-to:'& header is added to the message.
21722 This gives the original address(es) in the incoming envelope that caused this
21723 delivery to happen. More than one address may be present if the transport is
21724 configured to handle several addresses at once, or if more than one original
21725 address was redirected to the same final address. As this is not a standard
21726 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21727 its removal from incoming messages, so that delivered messages can safely be
21728 resent to other recipients.
21729
21730
21731 .option event_action transports string&!! unset
21732 .cindex events
21733 This option declares a string to be expanded for Exim's events mechanism.
21734 For details see chapter &<<CHAPevents>>&.
21735
21736
21737 .option group transports string&!! "Exim group"
21738 .cindex "transport" "group; specifying"
21739 This option specifies a gid for running the transport process, overriding any
21740 value that the router supplies, and also overriding any value associated with
21741 &%user%& (see below).
21742
21743
21744 .option headers_add transports list&!! unset
21745 .cindex "header lines" "adding in transport"
21746 .cindex "transport" "header lines; adding"
21747 This option specifies a list of text headers,
21748 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21749 which are (separately) expanded and added to the header
21750 portion of a message as it is transported, as described in section
21751 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21752 routers. If the result of the expansion is an empty string, or if the expansion
21753 is forced to fail, no action is taken. Other expansion failures are treated as
21754 errors and cause the delivery to be deferred.
21755
21756 Unlike most options, &%headers_add%& can be specified multiple times
21757 for a transport; all listed headers are added.
21758
21759
21760 .option headers_only transports boolean false
21761 .cindex "transport" "header lines only"
21762 .cindex "message" "transporting headers only"
21763 .cindex "header lines" "transporting"
21764 If this option is set, the message's body is not transported. It is mutually
21765 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21766 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21767 checked, since this option does not automatically suppress them.
21768
21769
21770 .option headers_remove transports list&!! unset
21771 .cindex "header lines" "removing"
21772 .cindex "transport" "header lines; removing"
21773 This option specifies a list of header names,
21774 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21775 these headers are omitted from the message as it is transported, as described
21776 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21777 routers.
21778 Each list item is separately expanded.
21779 If the result of the expansion is an empty string, or if the expansion
21780 is forced to fail, no action is taken. Other expansion failures are treated as
21781 errors and cause the delivery to be deferred.
21782
21783 Unlike most options, &%headers_remove%& can be specified multiple times
21784 for a transport; all listed headers are removed.
21785
21786 &*Warning*&: Because of the separate expansion of the list items,
21787 items that contain a list separator must have it doubled.
21788 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21789
21790
21791
21792 .option headers_rewrite transports string unset
21793 .cindex "transport" "header lines; rewriting"
21794 .cindex "rewriting" "at transport time"
21795 This option allows addresses in header lines to be rewritten at transport time,
21796 that is, as the message is being copied to its destination. The contents of the
21797 option are a colon-separated list of rewriting rules. Each rule is in exactly
21798 the same form as one of the general rewriting rules that are applied when a
21799 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21800 example,
21801 .code
21802 headers_rewrite = a@b c@d f : \
21803                   x@y w@z
21804 .endd
21805 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21806 &'w@z'& in all address-bearing header lines. The rules are applied to the
21807 header lines just before they are written out at transport time, so they affect
21808 only those copies of the message that pass through the transport. However, only
21809 the message's original header lines, and any that were added by a system
21810 filter, are rewritten. If a router or transport adds header lines, they are not
21811 affected by this option. These rewriting rules are &'not'& applied to the
21812 envelope. You can change the return path using &%return_path%&, but you cannot
21813 change envelope recipients at this time.
21814
21815
21816 .option home_directory transports string&!! unset
21817 .cindex "transport" "home directory for"
21818 .vindex "&$home$&"
21819 This option specifies a home directory setting for a local transport,
21820 overriding any value that may be set by the router. The home directory is
21821 placed in &$home$& while expanding the transport's private options. It is also
21822 used as the current directory if no current directory is set by the
21823 &%current_directory%& option on the transport or the
21824 &%transport_current_directory%& option on the router. If the expansion fails
21825 for any reason, including forced failure, an error is logged, and delivery is
21826 deferred.
21827
21828
21829 .option initgroups transports boolean false
21830 .cindex "additional groups"
21831 .cindex "groups" "additional"
21832 .cindex "transport" "group; additional"
21833 If this option is true and the uid for the delivery process is provided by the
21834 transport, the &[initgroups()]& function is called when running the transport
21835 to ensure that any additional groups associated with the uid are set up.
21836
21837
21838 .option max_parallel transports integer&!! unset
21839 .cindex limit "transport parallelism"
21840 .cindex transport "parallel processes"
21841 .cindex transport "concurrency limit"
21842 .cindex "delivery" "parallelism for transport"
21843 If this option is set and expands to an integer greater than zero
21844 it limits the number of concurrent runs of the transport.
21845 The control does not apply to shadow transports.
21846
21847 .cindex "hints database" "transport concurrency control"
21848 Exim implements this control by means of a hints database in which a record is
21849 incremented whenever a transport process is being created. The record
21850 is decremented and possibly removed when the process terminates.
21851 Obviously there is scope for
21852 records to get left lying around if there is a system or program crash. To
21853 guard against this, Exim ignores any records that are more than six hours old.
21854
21855 If you use this option, you should also arrange to delete the
21856 relevant hints database whenever your system reboots. The names of the files
21857 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21858 may be one or two files, depending on the type of DBM in use. The same files
21859 are used for ETRN and smtp transport serialization.
21860
21861
21862 .option message_size_limit transports string&!! 0
21863 .cindex "limit" "message size per transport"
21864 .cindex "size" "of message, limit"
21865 .cindex "transport" "message size; limiting"
21866 This option controls the size of messages passed through the transport. It is
21867 expanded before use; the result of the expansion must be a sequence of decimal
21868 digits, optionally followed by K or M. If the expansion fails for any reason,
21869 including forced failure, or if the result is not of the required form,
21870 delivery is deferred. If the value is greater than zero and the size of a
21871 message exceeds this limit, the address is failed. If there is any chance that
21872 the resulting bounce message could be routed to the same transport, you should
21873 ensure that &%return_size_limit%& is less than the transport's
21874 &%message_size_limit%&, as otherwise the bounce message will fail to get
21875 delivered.
21876
21877
21878
21879 .option rcpt_include_affixes transports boolean false
21880 .cindex "prefix" "for local part, including in envelope"
21881 .cindex "suffix for local part" "including in envelope"
21882 .cindex "local part" "prefix"
21883 .cindex "local part" "suffix"
21884 When this option is false (the default), and an address that has had any
21885 affixes (prefixes or suffixes) removed from the local part is delivered by any
21886 form of SMTP or LMTP, the affixes are not included. For example, if a router
21887 that contains
21888 .code
21889 local_part_prefix = *-
21890 .endd
21891 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21892 is delivered with
21893 .code
21894 RCPT TO:<xyz@some.domain>
21895 .endd
21896 This is also the case when an ACL-time callout is being used to verify a
21897 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21898 whole local part is included in the RCPT command. This option applies to BSMTP
21899 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21900 &(lmtp)& and &(smtp)& transports.
21901
21902
21903 .option retry_use_local_part transports boolean "see below"
21904 .cindex "hints database" "retry keys"
21905 When a delivery suffers a temporary failure, a retry record is created
21906 in Exim's hints database. For remote deliveries, the key for the retry record
21907 is based on the name and/or IP address of the failing remote host. For local
21908 deliveries, the key is normally the entire address, including both the local
21909 part and the domain. This is suitable for most common cases of local delivery
21910 temporary failure &-- for example, exceeding a mailbox quota should delay only
21911 deliveries to that mailbox, not to the whole domain.
21912
21913 However, in some special cases you may want to treat a temporary local delivery
21914 as a failure associated with the domain, and not with a particular local part.
21915 (For example, if you are storing all mail for some domain in files.) You can do
21916 this by setting &%retry_use_local_part%& false.
21917
21918 For all the local transports, its default value is true. For remote transports,
21919 the default value is false for tidiness, but changing the value has no effect
21920 on a remote transport in the current implementation.
21921
21922
21923 .option return_path transports string&!! unset
21924 .cindex "envelope sender"
21925 .cindex "envelope from"
21926 .cindex "transport" "return path; changing"
21927 .cindex "return path" "changing in transport"
21928 If this option is set, the string is expanded at transport time and replaces
21929 the existing return path (envelope sender) value in the copy of the message
21930 that is being delivered. An empty return path is permitted. This feature is
21931 designed for remote deliveries, where the value of this option is used in the
21932 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21933 only effect is to change the address that is placed in the &'Return-path:'&
21934 header line, if one is added to the message (see the next option).
21935
21936 &*Note:*& A changed return path is not logged unless you add
21937 &%return_path_on_delivery%& to the log selector.
21938
21939 .vindex "&$return_path$&"
21940 The expansion can refer to the existing value via &$return_path$&. This is
21941 either the message's envelope sender, or an address set by the
21942 &%errors_to%& option on a router. If the expansion is forced to fail, no
21943 replacement occurs; if it fails for another reason, delivery is deferred. This
21944 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21945 section &<<SECTverp>>&.
21946
21947 &*Note*&: If a delivery error is detected locally, including the case when a
21948 remote server rejects a message at SMTP time, the bounce message is not sent to
21949 the value of this option. It is sent to the previously set errors address.
21950 This defaults to the incoming sender address, but can be changed by setting
21951 &%errors_to%& in a router.
21952
21953
21954
21955 .option return_path_add transports boolean false
21956 .cindex "&'Return-path:'& header line"
21957 If this option is true, a &'Return-path:'& header is added to the message.
21958 Although the return path is normally available in the prefix line of BSD
21959 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21960 have easy access to it.
21961
21962 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21963 the delivery SMTP server makes the final delivery"&. This implies that this
21964 header should not be present in incoming messages. Exim has a configuration
21965 option, &%return_path_remove%&, which requests removal of this header from
21966 incoming messages, so that delivered messages can safely be resent to other
21967 recipients.
21968
21969
21970 .option shadow_condition transports string&!! unset
21971 See &%shadow_transport%& below.
21972
21973
21974 .option shadow_transport transports string unset
21975 .cindex "shadow transport"
21976 .cindex "transport" "shadow"
21977 A local transport may set the &%shadow_transport%& option to the name of
21978 another local transport. Shadow remote transports are not supported.
21979
21980 Whenever a delivery to the main transport succeeds, and either
21981 &%shadow_condition%& is unset, or its expansion does not result in the empty
21982 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21983 passed to the shadow transport, with the same delivery address or addresses. If
21984 expansion fails, no action is taken except that non-forced expansion failures
21985 cause a log line to be written.
21986
21987 The result of the shadow transport is discarded and does not affect the
21988 subsequent processing of the message. Only a single level of shadowing is
21989 provided; the &%shadow_transport%& option is ignored on any transport when it
21990 is running as a shadow. Options concerned with output from pipes are also
21991 ignored. The log line for the successful delivery has an item added on the end,
21992 of the form
21993 .code
21994 ST=<shadow transport name>
21995 .endd
21996 If the shadow transport did not succeed, the error message is put in
21997 parentheses afterwards. Shadow transports can be used for a number of different
21998 purposes, including keeping more detailed log information than Exim normally
21999 provides, and implementing automatic acknowledgment policies based on message
22000 headers that some sites insist on.
22001
22002
22003 .option transport_filter transports string&!! unset
22004 .cindex "transport" "filter"
22005 .cindex "filter" "transport filter"
22006 This option sets up a filtering (in the Unix shell sense) process for messages
22007 at transport time. It should not be confused with mail filtering as set up by
22008 individual users or via a system filter.
22009 If unset, or expanding to an empty string, no filtering is done.
22010
22011 When the message is about to be written out, the command specified by
22012 &%transport_filter%& is started up in a separate, parallel process, and
22013 the entire message, including the header lines, is passed to it on its standard
22014 input (this in fact is done from a third process, to avoid deadlock). The
22015 command must be specified as an absolute path.
22016
22017 The lines of the message that are written to the transport filter are
22018 terminated by newline (&"\n"&). The message is passed to the filter before any
22019 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22020 lines beginning with a dot, and also before any processing implied by the
22021 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22022 &(pipe)& transports.
22023
22024 The standard error for the filter process is set to the same destination as its
22025 standard output; this is read and written to the message's ultimate
22026 destination. The process that writes the message to the filter, the
22027 filter itself, and the original process that reads the result and delivers it
22028 are all run in parallel, like a shell pipeline.
22029
22030 The filter can perform any transformations it likes, but of course should take
22031 care not to break RFC 2822 syntax. Exim does not check the result, except to
22032 test for a final newline when SMTP is in use. All messages transmitted over
22033 SMTP must end with a newline, so Exim supplies one if it is missing.
22034
22035 .cindex "content scanning" "per user"
22036 A transport filter can be used to provide content-scanning on a per-user basis
22037 at delivery time if the only required effect of the scan is to modify the
22038 message. For example, a content scan could insert a new header line containing
22039 a spam score. This could be interpreted by a filter in the user's MUA. It is
22040 not possible to discard a message at this stage.
22041
22042 .cindex "SMTP" "SIZE"
22043 A problem might arise if the filter increases the size of a message that is
22044 being sent down an SMTP connection. If the receiving SMTP server has indicated
22045 support for the SIZE parameter, Exim will have sent the size of the message
22046 at the start of the SMTP session. If what is actually sent is substantially
22047 more, the server might reject the message. This can be worked round by setting
22048 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22049 additions to the message, or to disable the use of SIZE altogether.
22050
22051 .vindex "&$pipe_addresses$&"
22052 The value of the &%transport_filter%& option is the command string for starting
22053 the filter, which is run directly from Exim, not under a shell. The string is
22054 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22055 Exim breaks it up into arguments and then expands each argument separately (see
22056 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22057 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22058 of arguments, one for each address that applies to this delivery. (This isn't
22059 an ideal name for this feature here, but as it was already implemented for the
22060 &(pipe)& transport, it seemed sensible not to change it.)
22061
22062 .vindex "&$host$&"
22063 .vindex "&$host_address$&"
22064 The expansion variables &$host$& and &$host_address$& are available when the
22065 transport is a remote one. They contain the name and IP address of the host to
22066 which the message is being sent. For example:
22067 .code
22068 transport_filter = /some/directory/transport-filter.pl \
22069   $host $host_address $sender_address $pipe_addresses
22070 .endd
22071
22072 Two problems arise if you want to use more complicated expansion items to
22073 generate transport filter commands, both of which due to the fact that the
22074 command is split up &'before'& expansion.
22075 .ilist
22076 If an expansion item contains white space, you must quote it, so that it is all
22077 part of the same command item. If the entire option setting is one such
22078 expansion item, you have to take care what kind of quoting you use. For
22079 example:
22080 .code
22081 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22082 .endd
22083 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22084 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22085 stripped by Exim when it read the option's value. When the value is used, if
22086 the single quotes were missing, the line would be split into two items,
22087 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22088 Exim tried to expand the first one.
22089 .next
22090 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22091 expansion cannot generate multiple arguments, or a command name followed by
22092 arguments. Consider this example:
22093 .code
22094 transport_filter = ${lookup{$host}lsearch{/a/file}\
22095                     {$value}{/bin/cat}}
22096 .endd
22097 The result of the lookup is interpreted as the name of the command, even
22098 if it contains white space. The simplest way round this is to use a shell:
22099 .code
22100 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22101                                {$value}{/bin/cat}}
22102 .endd
22103 .endlist
22104
22105 The filter process is run under the same uid and gid as the normal delivery.
22106 For remote deliveries this is the Exim uid/gid by default. The command should
22107 normally yield a zero return code. Transport filters are not supposed to fail.
22108 A non-zero code is taken to mean that the transport filter encountered some
22109 serious problem. Delivery of the message is deferred; the message remains on
22110 the queue and is tried again later. It is not possible to cause a message to be
22111 bounced from a transport filter.
22112
22113 If a transport filter is set on an autoreply transport, the original message is
22114 passed through the filter as it is being copied into the newly generated
22115 message, which happens if the &%return_message%& option is set.
22116
22117
22118 .option transport_filter_timeout transports time 5m
22119 .cindex "transport" "filter, timeout"
22120 When Exim is reading the output of a transport filter, it applies a timeout
22121 that can be set by this option. Exceeding the timeout is normally treated as a
22122 temporary delivery failure. However, if a transport filter is used with a
22123 &(pipe)& transport, a timeout in the transport filter is treated in the same
22124 way as a timeout in the pipe command itself. By default, a timeout is a hard
22125 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22126 becomes a temporary error.
22127
22128
22129 .option user transports string&!! "Exim user"
22130 .cindex "uid (user id)" "local delivery"
22131 .cindex "transport" "user, specifying"
22132 This option specifies the user under whose uid the delivery process is to be
22133 run, overriding any uid that may have been set by the router. If the user is
22134 given as a name, the uid is looked up from the password data, and the
22135 associated group is taken as the value of the gid to be used if the &%group%&
22136 option is not set.
22137
22138 For deliveries that use local transports, a user and group are normally
22139 specified explicitly or implicitly (for example, as a result of
22140 &%check_local_user%&) by the router or transport.
22141
22142 .cindex "hints database" "access by remote transport"
22143 For remote transports, you should leave this option unset unless you really are
22144 sure you know what you are doing. When a remote transport is running, it needs
22145 to be able to access Exim's hints databases, because each host may have its own
22146 retry data.
22147 .ecindex IIDgenoptra1
22148 .ecindex IIDgenoptra2
22149 .ecindex IIDgenoptra3
22150
22151
22152
22153
22154
22155
22156 . ////////////////////////////////////////////////////////////////////////////
22157 . ////////////////////////////////////////////////////////////////////////////
22158
22159 .chapter "Address batching in local transports" "CHAPbatching" &&&
22160          "Address batching"
22161 .cindex "transport" "local; address batching in"
22162 The only remote transport (&(smtp)&) is normally configured to handle more than
22163 one address at a time, so that when several addresses are routed to the same
22164 remote host, just one copy of the message is sent. Local transports, however,
22165 normally handle one address at a time. That is, a separate instance of the
22166 transport is run for each address that is routed to the transport. A separate
22167 copy of the message is delivered each time.
22168
22169 .cindex "batched local delivery"
22170 .oindex "&%batch_max%&"
22171 .oindex "&%batch_id%&"
22172 In special cases, it may be desirable to handle several addresses at once in a
22173 local transport, for example:
22174
22175 .ilist
22176 In an &(appendfile)& transport, when storing messages in files for later
22177 delivery by some other means, a single copy of the message with multiple
22178 recipients saves space.
22179 .next
22180 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22181 a single copy saves time, and is the normal way LMTP is expected to work.
22182 .next
22183 In a &(pipe)& transport, when passing the message
22184 to a scanner program or
22185 to some other delivery mechanism such as UUCP, multiple recipients may be
22186 acceptable.
22187 .endlist
22188
22189 These three local transports all have the same options for controlling multiple
22190 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22191 repeating the information for each transport, these options are described here.
22192
22193 The &%batch_max%& option specifies the maximum number of addresses that can be
22194 delivered together in a single run of the transport. Its default value is one
22195 (no batching). When more than one address is routed to a transport that has a
22196 &%batch_max%& value greater than one, the addresses are delivered in a batch
22197 (that is, in a single run of the transport with multiple recipients), subject
22198 to certain conditions:
22199
22200 .ilist
22201 .vindex "&$local_part$&"
22202 If any of the transport's options contain a reference to &$local_part$&, no
22203 batching is possible.
22204 .next
22205 .vindex "&$domain$&"
22206 If any of the transport's options contain a reference to &$domain$&, only
22207 addresses with the same domain are batched.
22208 .next
22209 .cindex "customizing" "batching condition"
22210 If &%batch_id%& is set, it is expanded for each address, and only those
22211 addresses with the same expanded value are batched. This allows you to specify
22212 customized batching conditions. Failure of the expansion for any reason,
22213 including forced failure, disables batching, but it does not stop the delivery
22214 from taking place.
22215 .next
22216 Batched addresses must also have the same errors address (where to send
22217 delivery errors), the same header additions and removals, the same user and
22218 group for the transport, and if a host list is present, the first host must
22219 be the same.
22220 .endlist
22221
22222 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22223 both when the file or pipe command is specified in the transport, and when it
22224 is specified by a &(redirect)& router, but all the batched addresses must of
22225 course be routed to the same file or pipe command. These two transports have an
22226 option called &%use_bsmtp%&, which causes them to deliver the message in
22227 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22228 &%check_string%& and &%escape_string%& options are forced to the values
22229 .code
22230 check_string = "."
22231 escape_string = ".."
22232 .endd
22233 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22234 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22235 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22236
22237 .cindex "&'Envelope-to:'& header line"
22238 If the generic &%envelope_to_add%& option is set for a batching transport, the
22239 &'Envelope-to:'& header that is added to the message contains all the addresses
22240 that are being processed together. If you are using a batching &(appendfile)&
22241 transport without &%use_bsmtp%&, the only way to preserve the recipient
22242 addresses is to set the &%envelope_to_add%& option.
22243
22244 .cindex "&(pipe)& transport" "with multiple addresses"
22245 .vindex "&$pipe_addresses$&"
22246 If you are using a &(pipe)& transport without BSMTP, and setting the
22247 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22248 the command. This is not a true variable; it is a bit of magic that causes each
22249 of the recipient addresses to be inserted into the command as a separate
22250 argument. This provides a way of accessing all the addresses that are being
22251 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22252 are specified by a &(redirect)& router.
22253
22254
22255
22256
22257 . ////////////////////////////////////////////////////////////////////////////
22258 . ////////////////////////////////////////////////////////////////////////////
22259
22260 .chapter "The appendfile transport" "CHAPappendfile"
22261 .scindex IIDapptra1 "&(appendfile)& transport"
22262 .scindex IIDapptra2 "transports" "&(appendfile)&"
22263 .cindex "directory creation"
22264 .cindex "creating directories"
22265 The &(appendfile)& transport delivers a message by appending it to an existing
22266 file, or by creating an entirely new file in a specified directory. Single
22267 files to which messages are appended can be in the traditional Unix mailbox
22268 format, or optionally in the MBX format supported by the Pine MUA and
22269 University of Washington IMAP daemon, &'inter alia'&. When each message is
22270 being delivered as a separate file, &"maildir"& format can optionally be used
22271 to give added protection against failures that happen part-way through the
22272 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22273 supported. For all file formats, Exim attempts to create as many levels of
22274 directory as necessary, provided that &%create_directory%& is set.
22275
22276 The code for the optional formats is not included in the Exim binary by
22277 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22278 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22279 included.
22280
22281 .cindex "quota" "system"
22282 Exim recognizes system quota errors, and generates an appropriate message. Exim
22283 also supports its own quota control within the transport, for use when the
22284 system facility is unavailable or cannot be used for some reason.
22285
22286 If there is an error while appending to a file (for example, quota exceeded or
22287 partition filled), Exim attempts to reset the file's length and last
22288 modification time back to what they were before. If there is an error while
22289 creating an entirely new file, the new file is removed.
22290
22291 Before appending to a file, a number of security checks are made, and the
22292 file is locked. A detailed description is given below, after the list of
22293 private options.
22294
22295 The &(appendfile)& transport is most commonly used for local deliveries to
22296 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22297 putting messages into files for remote delivery by some means other than Exim.
22298 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22299 option).
22300
22301
22302
22303 .section "The file and directory options" "SECTfildiropt"
22304 The &%file%& option specifies a single file, to which the message is appended;
22305 the &%directory%& option specifies a directory, in which a new file containing
22306 the message is created. Only one of these two options can be set, and for
22307 normal deliveries to mailboxes, one of them &'must'& be set.
22308
22309 .vindex "&$address_file$&"
22310 .vindex "&$local_part$&"
22311 However, &(appendfile)& is also used for delivering messages to files or
22312 directories whose names (or parts of names) are obtained from alias,
22313 forwarding, or filtering operations (for example, a &%save%& command in a
22314 user's Exim filter). When such a transport is running, &$local_part$& contains
22315 the local part that was aliased or forwarded, and &$address_file$& contains the
22316 name (or partial name) of the file or directory generated by the redirection
22317 operation. There are two cases:
22318
22319 .ilist
22320 If neither &%file%& nor &%directory%& is set, the redirection operation
22321 must specify an absolute path (one that begins with &`/`&). This is the most
22322 common case when users with local accounts use filtering to sort mail into
22323 different folders. See for example, the &(address_file)& transport in the
22324 default configuration. If the path ends with a slash, it is assumed to be the
22325 name of a directory. A delivery to a directory can also be forced by setting
22326 &%maildir_format%& or &%mailstore_format%&.
22327 .next
22328 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22329 used to determine the file or directory name for the delivery. Normally, the
22330 contents of &$address_file$& are used in some way in the string expansion.
22331 .endlist
22332
22333
22334 .cindex "Sieve filter" "configuring &(appendfile)&"
22335 .cindex "Sieve filter" "relative mailbox path handling"
22336 As an example of the second case, consider an environment where users do not
22337 have home directories. They may be permitted to use Exim filter commands of the
22338 form:
22339 .code
22340 save folder23
22341 .endd
22342 or Sieve filter commands of the form:
22343 .code
22344 require "fileinto";
22345 fileinto "folder23";
22346 .endd
22347 In this situation, the expansion of &%file%& or &%directory%& in the transport
22348 must transform the relative path into an appropriate absolute filename. In the
22349 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22350 is used as a result of a &"keep"& action in the filter. This example shows one
22351 way of handling this requirement:
22352 .code
22353 file = ${if eq{$address_file}{inbox} \
22354             {/var/mail/$local_part} \
22355             {${if eq{${substr_0_1:$address_file}}{/} \
22356                   {$address_file} \
22357                   {$home/mail/$address_file} \
22358             }} \
22359        }
22360 .endd
22361 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22362 location, absolute paths are used without change, and other folders are in the
22363 &_mail_& directory within the home directory.
22364
22365 &*Note 1*&: While processing an Exim filter, a relative path such as
22366 &_folder23_& is turned into an absolute path if a home directory is known to
22367 the router. In particular, this is the case if &%check_local_user%& is set. If
22368 you want to prevent this happening at routing time, you can set
22369 &%router_home_directory%& empty. This forces the router to pass the relative
22370 path to the transport.
22371
22372 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22373 the &%file%& or &%directory%& option is still used if it is set.
22374
22375
22376
22377
22378 .section "Private options for appendfile" "SECID134"
22379 .cindex "options" "&(appendfile)& transport"
22380
22381
22382
22383 .option allow_fifo appendfile boolean false
22384 .cindex "fifo (named pipe)"
22385 .cindex "named pipe (fifo)"
22386 .cindex "pipe" "named (fifo)"
22387 Setting this option permits delivery to named pipes (FIFOs) as well as to
22388 regular files. If no process is reading the named pipe at delivery time, the
22389 delivery is deferred.
22390
22391
22392 .option allow_symlink appendfile boolean false
22393 .cindex "symbolic link" "to mailbox"
22394 .cindex "mailbox" "symbolic link"
22395 By default, &(appendfile)& will not deliver if the path name for the file is
22396 that of a symbolic link. Setting this option relaxes that constraint, but there
22397 are security issues involved in the use of symbolic links. Be sure you know
22398 what you are doing if you set this. Details of exactly what this option affects
22399 are included in the discussion which follows this list of options.
22400
22401
22402 .option batch_id appendfile string&!! unset
22403 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22404 However, batching is automatically disabled for &(appendfile)& deliveries that
22405 happen as a result of forwarding or aliasing or other redirection directly to a
22406 file.
22407
22408
22409 .option batch_max appendfile integer 1
22410 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22411
22412
22413 .option check_group appendfile boolean false
22414 When this option is set, the group owner of the file defined by the &%file%&
22415 option is checked to see that it is the same as the group under which the
22416 delivery process is running. The default setting is false because the default
22417 file mode is 0600, which means that the group is irrelevant.
22418
22419
22420 .option check_owner appendfile boolean true
22421 When this option is set, the owner of the file defined by the &%file%& option
22422 is checked to ensure that it is the same as the user under which the delivery
22423 process is running.
22424
22425
22426 .option check_string appendfile string "see below"
22427 .cindex "&""From""& line"
22428 As &(appendfile)& writes the message, the start of each line is tested for
22429 matching &%check_string%&, and if it does, the initial matching characters are
22430 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22431 a literal string, not a regular expression, and the case of any letters it
22432 contains is significant.
22433
22434 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22435 are forced to &"."& and &".."& respectively, and any settings in the
22436 configuration are ignored. Otherwise, they default to &"From&~"& and
22437 &">From&~"& when the &%file%& option is set, and unset when any of the
22438 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22439
22440 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22441 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22442 &"From&~"& indicates the start of a new message. All four options need changing
22443 if another format is used. For example, to deliver to mailboxes in MMDF format:
22444 .cindex "MMDF format mailbox"
22445 .cindex "mailbox" "MMDF format"
22446 .code
22447 check_string = "\1\1\1\1\n"
22448 escape_string = "\1\1\1\1 \n"
22449 message_prefix = "\1\1\1\1\n"
22450 message_suffix = "\1\1\1\1\n"
22451 .endd
22452 .option create_directory appendfile boolean true
22453 .cindex "directory creation"
22454 When this option is true, Exim attempts to create any missing superior
22455 directories for the file that it is about to write. A created directory's mode
22456 is given by the &%directory_mode%& option.
22457
22458 The group ownership of a newly created directory is highly dependent on the
22459 operating system (and possibly the file system) that is being used. For
22460 example, in Solaris, if the parent directory has the setgid bit set, its group
22461 is propagated to the child; if not, the currently set group is used. However,
22462 in FreeBSD, the parent's group is always used.
22463
22464
22465
22466 .option create_file appendfile string anywhere
22467 This option constrains the location of files and directories that are created
22468 by this transport. It applies to files defined by the &%file%& option and
22469 directories defined by the &%directory%& option. In the case of maildir
22470 delivery, it applies to the top level directory, not the maildir directories
22471 beneath.
22472
22473 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22474 &"belowhome"&. In the second and third cases, a home directory must have been
22475 set for the transport. This option is not useful when an explicit filename is
22476 given for normal mailbox deliveries. It is intended for the case when filenames
22477 are generated from users' &_.forward_& files. These are usually handled
22478 by an &(appendfile)& transport called &%address_file%&. See also
22479 &%file_must_exist%&.
22480
22481
22482 .option directory appendfile string&!! unset
22483 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22484 or &%directory%& must be set, unless the delivery is the direct result of a
22485 redirection (see section &<<SECTfildiropt>>&).
22486
22487 When &%directory%& is set, the string is expanded, and the message is delivered
22488 into a new file or files in or below the given directory, instead of being
22489 appended to a single mailbox file. A number of different formats are provided
22490 (see &%maildir_format%& and &%mailstore_format%&), and see section
22491 &<<SECTopdir>>& for further details of this form of delivery.
22492
22493
22494 .option directory_file appendfile string&!! "see below"
22495 .cindex "base62"
22496 .vindex "&$inode$&"
22497 When &%directory%& is set, but neither &%maildir_format%& nor
22498 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22499 whose name is obtained by expanding this string. The default value is:
22500 .code
22501 q${base62:$tod_epoch}-$inode
22502 .endd
22503 This generates a unique name from the current time, in base 62 form, and the
22504 inode of the file. The variable &$inode$& is available only when expanding this
22505 option.
22506
22507
22508 .option directory_mode appendfile "octal integer" 0700
22509 If &(appendfile)& creates any directories as a result of the
22510 &%create_directory%& option, their mode is specified by this option.
22511
22512
22513 .option escape_string appendfile string "see description"
22514 See &%check_string%& above.
22515
22516
22517 .option file appendfile string&!! unset
22518 This option is mutually exclusive with the &%directory%& option, but one of
22519 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22520 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22521 specifies a single file, to which the message is appended. One or more of
22522 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22523 &%file%&.
22524
22525 .cindex "NFS" "lock file"
22526 .cindex "locking files"
22527 .cindex "lock files"
22528 If you are using more than one host to deliver over NFS into the same
22529 mailboxes, you should always use lock files.
22530
22531 The string value is expanded for each delivery, and must yield an absolute
22532 path. The most common settings of this option are variations on one of these
22533 examples:
22534 .code
22535 file = /var/spool/mail/$local_part
22536 file = /home/$local_part/inbox
22537 file = $home/inbox
22538 .endd
22539 .cindex "&""sticky""& bit"
22540 In the first example, all deliveries are done into the same directory. If Exim
22541 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22542 create a file in the directory, so the &"sticky"& bit must be turned on for
22543 deliveries to be possible, or alternatively the &%group%& option can be used to
22544 run the delivery under a group id which has write access to the directory.
22545
22546
22547
22548 .option file_format appendfile string unset
22549 .cindex "file" "mailbox; checking existing format"
22550 This option requests the transport to check the format of an existing file
22551 before adding to it. The check consists of matching a specific string at the
22552 start of the file. The value of the option consists of an even number of
22553 colon-separated strings. The first of each pair is the test string, and the
22554 second is the name of a transport. If the transport associated with a matched
22555 string is not the current transport, control is passed over to the other
22556 transport. For example, suppose the standard &(local_delivery)& transport has
22557 this added to it:
22558 .code
22559 file_format = "From       : local_delivery :\
22560                \1\1\1\1\n : local_mmdf_delivery"
22561 .endd
22562 Mailboxes that begin with &"From"& are still handled by this transport, but if
22563 a mailbox begins with four binary ones followed by a newline, control is passed
22564 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22565 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22566 is assumed to match the current transport. If the start of a mailbox doesn't
22567 match any string, or if the transport named for a given string is not defined,
22568 delivery is deferred.
22569
22570
22571 .option file_must_exist appendfile boolean false
22572 If this option is true, the file specified by the &%file%& option must exist.
22573 A temporary error occurs if it does not, causing delivery to be deferred.
22574 If this option is false, the file is created if it does not exist.
22575
22576
22577 .option lock_fcntl_timeout appendfile time 0s
22578 .cindex "timeout" "mailbox locking"
22579 .cindex "mailbox" "locking, blocking and non-blocking"
22580 .cindex "locking files"
22581 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22582 when locking an open mailbox file. If the call fails, the delivery process
22583 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22584 Non-blocking calls are used so that the file is not kept open during the wait
22585 for the lock; the reason for this is to make it as safe as possible for
22586 deliveries over NFS in the case when processes might be accessing an NFS
22587 mailbox without using a lock file. This should not be done, but
22588 misunderstandings and hence misconfigurations are not unknown.
22589
22590 On a busy system, however, the performance of a non-blocking lock approach is
22591 not as good as using a blocking lock with a timeout. In this case, the waiting
22592 is done inside the system call, and Exim's delivery process acquires the lock
22593 and can proceed as soon as the previous lock holder releases it.
22594
22595 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22596 timeout, are used. There may still be some retrying: the maximum number of
22597 retries is
22598 .code
22599 (lock_retries * lock_interval) / lock_fcntl_timeout
22600 .endd
22601 rounded up to the next whole number. In other words, the total time during
22602 which &(appendfile)& is trying to get a lock is roughly the same, unless
22603 &%lock_fcntl_timeout%& is set very large.
22604
22605 You should consider setting this option if you are getting a lot of delayed
22606 local deliveries because of errors of the form
22607 .code
22608 failed to lock mailbox /some/file (fcntl)
22609 .endd
22610
22611 .option lock_flock_timeout appendfile time 0s
22612 This timeout applies to file locking when using &[flock()]& (see
22613 &%use_flock%&); the timeout operates in a similar manner to
22614 &%lock_fcntl_timeout%&.
22615
22616
22617 .option lock_interval appendfile time 3s
22618 This specifies the time to wait between attempts to lock the file. See below
22619 for details of locking.
22620
22621
22622 .option lock_retries appendfile integer 10
22623 This specifies the maximum number of attempts to lock the file. A value of zero
22624 is treated as 1. See below for details of locking.
22625
22626
22627 .option lockfile_mode appendfile "octal integer" 0600
22628 This specifies the mode of the created lock file, when a lock file is being
22629 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22630
22631
22632 .option lockfile_timeout appendfile time 30m
22633 .cindex "timeout" "mailbox locking"
22634 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22635 exists and is older than this value, it is assumed to have been left behind by
22636 accident, and Exim attempts to remove it.
22637
22638
22639 .option mailbox_filecount appendfile string&!! unset
22640 .cindex "mailbox" "specifying size of"
22641 .cindex "size" "of mailbox"
22642 If this option is set, it is expanded, and the result is taken as the current
22643 number of files in the mailbox. It must be a decimal number, optionally
22644 followed by K or M. This provides a way of obtaining this information from an
22645 external source that maintains the data.
22646
22647
22648 .option mailbox_size appendfile string&!! unset
22649 .cindex "mailbox" "specifying size of"
22650 .cindex "size" "of mailbox"
22651 If this option is set, it is expanded, and the result is taken as the current
22652 size the mailbox. It must be a decimal number, optionally followed by K or M.
22653 This provides a way of obtaining this information from an external source that
22654 maintains the data. This is likely to be helpful for maildir deliveries where
22655 it is computationally expensive to compute the size of a mailbox.
22656
22657
22658
22659 .option maildir_format appendfile boolean false
22660 .cindex "maildir format" "specifying"
22661 If this option is set with the &%directory%& option, the delivery is into a new
22662 file, in the &"maildir"& format that is used by other mail software. When the
22663 transport is activated directly from a &(redirect)& router (for example, the
22664 &(address_file)& transport in the default configuration), setting
22665 &%maildir_format%& causes the path received from the router to be treated as a
22666 directory, whether or not it ends with &`/`&. This option is available only if
22667 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22668 &<<SECTmaildirdelivery>>& below for further details.
22669
22670
22671 .option maildir_quota_directory_regex appendfile string "See below"
22672 .cindex "maildir format" "quota; directories included in"
22673 .cindex "quota" "maildir; directories included in"
22674 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22675 a regular expression for specifying directories, relative to the quota
22676 directory (see &%quota_directory%&), that should be included in the quota
22677 calculation. The default value is:
22678 .code
22679 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22680 .endd
22681 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22682 (directories whose names begin with a dot). If you want to exclude the
22683 &_Trash_&
22684 folder from the count (as some sites do), you need to change this setting to
22685 .code
22686 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22687 .endd
22688 This uses a negative lookahead in the regular expression to exclude the
22689 directory whose name is &_.Trash_&. When a directory is excluded from quota
22690 calculations, quota processing is bypassed for any messages that are delivered
22691 directly into that directory.
22692
22693
22694 .option maildir_retries appendfile integer 10
22695 This option specifies the number of times to retry when writing a file in
22696 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22697
22698
22699 .option maildir_tag appendfile string&!! unset
22700 This option applies only to deliveries in maildir format, and is described in
22701 section &<<SECTmaildirdelivery>>& below.
22702
22703
22704 .option maildir_use_size_file appendfile&!! boolean false
22705 .cindex "maildir format" "&_maildirsize_& file"
22706 The result of string expansion for this option must be a valid boolean value.
22707 If it is true, it enables support for &_maildirsize_& files. Exim
22708 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22709 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22710 value is zero. See &%maildir_quota_directory_regex%& above and section
22711 &<<SECTmaildirdelivery>>& below for further details.
22712
22713 .option maildirfolder_create_regex appendfile string unset
22714 .cindex "maildir format" "&_maildirfolder_& file"
22715 .cindex "&_maildirfolder_&, creating"
22716 The value of this option is a regular expression. If it is unset, it has no
22717 effect. Otherwise, before a maildir delivery takes place, the pattern is
22718 matched against the name of the maildir directory, that is, the directory
22719 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22720 delivery. If there is a match, Exim checks for the existence of a file called
22721 &_maildirfolder_& in the directory, and creates it if it does not exist.
22722 See section &<<SECTmaildirdelivery>>& for more details.
22723
22724
22725 .option mailstore_format appendfile boolean false
22726 .cindex "mailstore format" "specifying"
22727 If this option is set with the &%directory%& option, the delivery is into two
22728 new files in  &"mailstore"& format. The option is available only if
22729 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22730 below for further details.
22731
22732
22733 .option mailstore_prefix appendfile string&!! unset
22734 This option applies only to deliveries in mailstore format, and is described in
22735 section &<<SECTopdir>>& below.
22736
22737
22738 .option mailstore_suffix appendfile string&!! unset
22739 This option applies only to deliveries in mailstore format, and is described in
22740 section &<<SECTopdir>>& below.
22741
22742
22743 .option mbx_format appendfile boolean false
22744 .cindex "locking files"
22745 .cindex "file" "locking"
22746 .cindex "file" "MBX format"
22747 .cindex "MBX format, specifying"
22748 This option is available only if Exim has been compiled with SUPPORT_MBX
22749 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22750 the message is appended to the mailbox file in MBX format instead of
22751 traditional Unix format. This format is supported by Pine4 and its associated
22752 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22753
22754 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22755 automatically changed by the use of &%mbx_format%&. They should normally be set
22756 empty when using MBX format, so this option almost always appears in this
22757 combination:
22758 .code
22759 mbx_format = true
22760 message_prefix =
22761 message_suffix =
22762 .endd
22763 If none of the locking options are mentioned in the configuration,
22764 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22765 is possible to specify the other kinds of locking with &%mbx_format%&, but
22766 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22767 interworks with &'c-client'&, providing for shared access to the mailbox. It
22768 should not be used if any program that does not use this form of locking is
22769 going to access the mailbox, nor should it be used if the mailbox file is NFS
22770 mounted, because it works only when the mailbox is accessed from a single host.
22771
22772 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22773 the standard version of &'c-client'&, because as long as it has a mailbox open
22774 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22775 append messages to it.
22776
22777
22778 .option message_prefix appendfile string&!! "see below"
22779 .cindex "&""From""& line"
22780 The string specified here is expanded and output at the start of every message.
22781 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22782 in which case it is:
22783 .code
22784 message_prefix = "From ${if def:return_path{$return_path}\
22785   {MAILER-DAEMON}} $tod_bsdinbox\n"
22786 .endd
22787 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22788 &`\n`& to &`\r\n`& in &%message_prefix%&.
22789
22790 .option message_suffix appendfile string&!! "see below"
22791 The string specified here is expanded and output at the end of every message.
22792 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22793 in which case it is a single newline character. The suffix can be suppressed by
22794 setting
22795 .code
22796 message_suffix =
22797 .endd
22798 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22799 &`\n`& to &`\r\n`& in &%message_suffix%&.
22800
22801 .option mode appendfile "octal integer" 0600
22802 If the output file is created, it is given this mode. If it already exists and
22803 has wider permissions, they are reduced to this mode. If it has narrower
22804 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22805 if the delivery is the result of a &%save%& command in a filter file specifying
22806 a particular mode, the mode of the output file is always forced to take that
22807 value, and this option is ignored.
22808
22809
22810 .option mode_fail_narrower appendfile boolean true
22811 This option applies in the case when an existing mailbox file has a narrower
22812 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22813 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22814 continues with the delivery attempt, using the existing mode of the file.
22815
22816
22817 .option notify_comsat appendfile boolean false
22818 If this option is true, the &'comsat'& daemon is notified after every
22819 successful delivery to a user mailbox. This is the daemon that notifies logged
22820 on users about incoming mail.
22821
22822
22823 .option quota appendfile string&!! unset
22824 .cindex "quota" "imposed by Exim"
22825 This option imposes a limit on the size of the file to which Exim is appending,
22826 or to the total space used in the directory tree when the &%directory%& option
22827 is set. In the latter case, computation of the space used is expensive, because
22828 all the files in the directory (and any sub-directories) have to be
22829 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22830 &%maildir_use_size_file%& for ways to avoid this in environments where users
22831 have no shell access to their mailboxes).
22832
22833 As there is no interlock against two simultaneous deliveries into a
22834 multi-file mailbox, it is possible for the quota to be overrun in this case.
22835 For single-file mailboxes, of course, an interlock is a necessity.
22836
22837 A file's size is taken as its &'used'& value. Because of blocking effects, this
22838 may be a lot less than the actual amount of disk space allocated to the file.
22839 If the sizes of a number of files are being added up, the rounding effect can
22840 become quite noticeable, especially on systems that have large block sizes.
22841 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22842 the obvious value which users understand most easily.
22843
22844 The value of the option is expanded, and must then be a numerical value
22845 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22846 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22847 and further option modifiers. If Exim is running on a system with
22848 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22849 be handled.
22850
22851 The option modifier &%no_check%& can be used to force delivery even if the over
22852 quota condition is met. The quota gets updated as usual.
22853
22854 &*Note*&: A value of zero is interpreted as &"no quota"&.
22855
22856 The expansion happens while Exim is running as root, before it changes uid for
22857 the delivery. This means that files that are inaccessible to the end user can
22858 be used to hold quota values that are looked up in the expansion. When delivery
22859 fails because this quota is exceeded, the handling of the error is as for
22860 system quota failures.
22861
22862 By default, Exim's quota checking mimics system quotas, and restricts the
22863 mailbox to the specified maximum size, though the value is not accurate to the
22864 last byte, owing to separator lines and additional headers that may get added
22865 during message delivery. When a mailbox is nearly full, large messages may get
22866 refused even though small ones are accepted, because the size of the current
22867 message is added to the quota when the check is made. This behaviour can be
22868 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22869 for exceeding the quota does not include the current message. Thus, deliveries
22870 continue until the quota has been exceeded; thereafter, no further messages are
22871 delivered. See also &%quota_warn_threshold%&.
22872
22873
22874 .option quota_directory appendfile string&!! unset
22875 This option defines the directory to check for quota purposes when delivering
22876 into individual files. The default is the delivery directory, or, if a file
22877 called &_maildirfolder_& exists in a maildir directory, the parent of the
22878 delivery directory.
22879
22880
22881 .option quota_filecount appendfile string&!! 0
22882 This option applies when the &%directory%& option is set. It limits the total
22883 number of files in the directory (compare the inode limit in system quotas). It
22884 can only be used if &%quota%& is also set. The value is expanded; an expansion
22885 failure causes delivery to be deferred. A value of zero is interpreted as
22886 &"no quota"&.
22887
22888 The option modifier &%no_check%& can be used to force delivery even if the over
22889 quota condition is met. The quota gets updated as usual.
22890
22891 .option quota_is_inclusive appendfile boolean true
22892 See &%quota%& above.
22893
22894
22895 .option quota_size_regex appendfile string unset
22896 This option applies when one of the delivery modes that writes a separate file
22897 for each message is being used. When Exim wants to find the size of one of
22898 these files in order to test the quota, it first checks &%quota_size_regex%&.
22899 If this is set to a regular expression that matches the filename, and it
22900 captures one string, that string is interpreted as a representation of the
22901 file's size. The value of &%quota_size_regex%& is not expanded.
22902
22903 This feature is useful only when users have no shell access to their mailboxes
22904 &-- otherwise they could defeat the quota simply by renaming the files. This
22905 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22906 the file length to the filename. For example:
22907 .code
22908 maildir_tag = ,S=$message_size
22909 quota_size_regex = ,S=(\d+)
22910 .endd
22911 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22912 number of lines in the message.
22913
22914 The regular expression should not assume that the length is at the end of the
22915 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22916 sometimes add other information onto the ends of message filenames.
22917
22918 Section &<<SECID136>>& contains further information.
22919
22920 .new
22921 This option should not be used when other message-handling software
22922 may duplicate messages by making hardlinks to the files.  When that is done Exim
22923 will count the message size once for each filename, in contrast with the actual
22924 disk usage.  When the option is not set, calculating total usage requires
22925 a system-call per file to get the size; the number of links is then available also
22926 as is used to adjust the effective size.
22927 .wen
22928
22929
22930 .option quota_warn_message appendfile string&!! "see below"
22931 See below for the use of this option. If it is not set when
22932 &%quota_warn_threshold%& is set, it defaults to
22933 .code
22934 quota_warn_message = "\
22935   To: $local_part@$domain\n\
22936   Subject: Your mailbox\n\n\
22937   This message is automatically created \
22938   by mail delivery software.\n\n\
22939   The size of your mailbox has exceeded \
22940   a warning threshold that is\n\
22941   set by the system administrator.\n"
22942 .endd
22943
22944
22945 .option quota_warn_threshold appendfile string&!! 0
22946 .cindex "quota" "warning threshold"
22947 .cindex "mailbox" "size warning"
22948 .cindex "size" "of mailbox"
22949 This option is expanded in the same way as &%quota%& (see above). If the
22950 resulting value is greater than zero, and delivery of the message causes the
22951 size of the file or total space in the directory tree to cross the given
22952 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22953 may be specified as a percentage of it by following the value with a percent
22954 sign. For example:
22955 .code
22956 quota = 10M
22957 quota_warn_threshold = 75%
22958 .endd
22959 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22960 percent sign is ignored.
22961
22962 The warning message itself is specified by the &%quota_warn_message%& option,
22963 and it must start with a &'To:'& header line containing the recipient(s) of the
22964 warning message. These do not necessarily have to include the recipient(s) of
22965 the original message. A &'Subject:'& line should also normally be supplied. You
22966 can include any other header lines that you want. If you do not include a
22967 &'From:'& line, the default is:
22968 .code
22969 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22970 .endd
22971 .oindex &%errors_reply_to%&
22972 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22973 option.
22974
22975 The &%quota%& option does not have to be set in order to use this option; they
22976 are independent of one another except when the threshold is specified as a
22977 percentage.
22978
22979
22980 .option use_bsmtp appendfile boolean false
22981 .cindex "envelope from"
22982 .cindex "envelope sender"
22983 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22984 format, with the envelope sender and recipient(s) included as SMTP commands. If
22985 you want to include a leading HELO command with such messages, you can do
22986 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22987 for details of batch SMTP.
22988
22989
22990 .option use_crlf appendfile boolean false
22991 .cindex "carriage return"
22992 .cindex "linefeed"
22993 This option causes lines to be terminated with the two-character CRLF sequence
22994 (carriage return, linefeed) instead of just a linefeed character. In the case
22995 of batched SMTP, the byte sequence written to the file is then an exact image
22996 of what would be sent down a real SMTP connection.
22997
22998 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22999 (which are used to supply the traditional &"From&~"& and blank line separators
23000 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23001 carriage return characters if these are needed. In cases where these options
23002 have non-empty defaults, the values end with a single linefeed, so they must be
23003 changed to end with &`\r\n`& if &%use_crlf%& is set.
23004
23005
23006 .option use_fcntl_lock appendfile boolean "see below"
23007 This option controls the use of the &[fcntl()]& function to lock a file for
23008 exclusive use when a message is being appended. It is set by default unless
23009 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23010 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23011 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23012
23013
23014 .option use_flock_lock appendfile boolean false
23015 This option is provided to support the use of &[flock()]& for file locking, for
23016 the few situations where it is needed. Most modern operating systems support
23017 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23018 each other. Exim uses &[fcntl()]& locking by default.
23019
23020 This option is required only if you are using an operating system where
23021 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23022 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23023 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23024
23025 .cindex "Solaris" "&[flock()]& support"
23026 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23027 have it (and some, I think, provide a not quite right version built on top of
23028 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23029 the ability to use it, and any attempt to do so will cause a configuration
23030 error.
23031
23032 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23033 is just being mapped onto &[fcntl()]& by the OS).
23034
23035
23036 .option use_lockfile appendfile boolean "see below"
23037 If this option is turned off, Exim does not attempt to create a lock file when
23038 appending to a mailbox file. In this situation, the only locking is by
23039 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23040 sure that every MUA that is ever going to look at your users' mailboxes uses
23041 &[fcntl()]& rather than a lock file, and even then only when you are not
23042 delivering over NFS from more than one host.
23043
23044 .cindex "NFS" "lock file"
23045 In order to append to an NFS file safely from more than one host, it is
23046 necessary to take out a lock &'before'& opening the file, and the lock file
23047 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23048 file corruption.
23049
23050 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23051 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23052 except when &%mbx_format%& is set.
23053
23054
23055 .option use_mbx_lock appendfile boolean "see below"
23056 This option is available only if Exim has been compiled with SUPPORT_MBX
23057 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23058 locking rules be used. It is set by default if &%mbx_format%& is set and none
23059 of the locking options are mentioned in the configuration. The locking rules
23060 are the same as are used by the &'c-client'& library that underlies Pine and
23061 the IMAP4 and POP daemons that come with it (see the discussion below). The
23062 rules allow for shared access to the mailbox. However, this kind of locking
23063 does not work when the mailbox is NFS mounted.
23064
23065 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23066 &%use_flock_lock%& to control what kind of locking is used in implementing the
23067 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23068 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23069
23070
23071
23072
23073 .section "Operational details for appending" "SECTopappend"
23074 .cindex "appending to a file"
23075 .cindex "file" "appending"
23076 Before appending to a file, the following preparations are made:
23077
23078 .ilist
23079 If the name of the file is &_/dev/null_&, no action is taken, and a success
23080 return is given.
23081
23082 .next
23083 .cindex "directory creation"
23084 If any directories on the file's path are missing, Exim creates them if the
23085 &%create_directory%& option is set. A created directory's mode is given by the
23086 &%directory_mode%& option.
23087
23088 .next
23089 If &%file_format%& is set, the format of an existing file is checked. If this
23090 indicates that a different transport should be used, control is passed to that
23091 transport.
23092
23093 .next
23094 .cindex "file" "locking"
23095 .cindex "locking files"
23096 .cindex "NFS" "lock file"
23097 If &%use_lockfile%& is set, a lock file is built in a way that will work
23098 reliably over NFS, as follows:
23099
23100 .olist
23101 Create a &"hitching post"& file whose name is that of the lock file with the
23102 current time, primary host name, and process id added, by opening for writing
23103 as a new file. If this fails with an access error, delivery is deferred.
23104 .next
23105 Close the hitching post file, and hard link it to the lock filename.
23106 .next
23107 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23108 Unlink the hitching post name.
23109 .next
23110 Otherwise, use &[stat()]& to get information about the hitching post file, and
23111 then unlink hitching post name. If the number of links is exactly two, creation
23112 of the lock file succeeded but something (for example, an NFS server crash and
23113 restart) caused this fact not to be communicated to the &[link()]& call.
23114 .next
23115 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23116 up to &%lock_retries%& times. However, since any program that writes to a
23117 mailbox should complete its task very quickly, it is reasonable to time out old
23118 lock files that are normally the result of user agent and system crashes. If an
23119 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23120 it before trying again.
23121 .endlist olist
23122
23123 .next
23124 A call is made to &[lstat()]& to discover whether the main file exists, and if
23125 so, what its characteristics are. If &[lstat()]& fails for any reason other
23126 than non-existence, delivery is deferred.
23127
23128 .next
23129 .cindex "symbolic link" "to mailbox"
23130 .cindex "mailbox" "symbolic link"
23131 If the file does exist and is a symbolic link, delivery is deferred, unless the
23132 &%allow_symlink%& option is set, in which case the ownership of the link is
23133 checked, and then &[stat()]& is called to find out about the real file, which
23134 is then subjected to the checks below. The check on the top-level link
23135 ownership prevents one user creating a link for another's mailbox in a sticky
23136 directory, though allowing symbolic links in this case is definitely not a good
23137 idea. If there is a chain of symbolic links, the intermediate ones are not
23138 checked.
23139
23140 .next
23141 If the file already exists but is not a regular file, or if the file's owner
23142 and group (if the group is being checked &-- see &%check_group%& above) are
23143 different from the user and group under which the delivery is running,
23144 delivery is deferred.
23145
23146 .next
23147 If the file's permissions are more generous than specified, they are reduced.
23148 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23149 is set false, in which case the delivery is tried using the existing
23150 permissions.
23151
23152 .next
23153 The file's inode number is saved, and the file is then opened for appending.
23154 If this fails because the file has vanished, &(appendfile)& behaves as if it
23155 hadn't existed (see below). For any other failures, delivery is deferred.
23156
23157 .next
23158 If the file is opened successfully, check that the inode number hasn't
23159 changed, that it is still a regular file, and that the owner and permissions
23160 have not changed. If anything is wrong, defer delivery and freeze the message.
23161
23162 .next
23163 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23164 option is set. Otherwise, check that the file is being created in a permitted
23165 directory if the &%create_file%& option is set (deferring on failure), and then
23166 open for writing as a new file, with the O_EXCL and O_CREAT options,
23167 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23168 set). In this case, which can happen if the link points to a non-existent file,
23169 the file is opened for writing using O_CREAT but not O_EXCL, because
23170 that prevents link following.
23171
23172 .next
23173 .cindex "loop" "while file testing"
23174 If opening fails because the file exists, obey the tests given above for
23175 existing files. However, to avoid looping in a situation where the file is
23176 being continuously created and destroyed, the exists/not-exists loop is broken
23177 after 10 repetitions, and the message is then frozen.
23178
23179 .next
23180 If opening fails with any other error, defer delivery.
23181
23182 .next
23183 .cindex "file" "locking"
23184 .cindex "locking files"
23185 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23186 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23187 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23188 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23189 file, and an exclusive lock on the file whose name is
23190 .code
23191 /tmp/.<device-number>.<inode-number>
23192 .endd
23193 using the device and inode numbers of the open mailbox file, in accordance with
23194 the MBX locking rules. This file is created with a mode that is specified by
23195 the &%lockfile_mode%& option.
23196
23197 If Exim fails to lock the file, there are two possible courses of action,
23198 depending on the value of the locking timeout. This is obtained from
23199 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23200
23201 If the timeout value is zero, the file is closed, Exim waits for
23202 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23203 to lock it again. This happens up to &%lock_retries%& times, after which the
23204 delivery is deferred.
23205
23206 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23207 &[flock()]& are used (with the given timeout), so there has already been some
23208 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23209 immediately. It retries up to
23210 .code
23211 (lock_retries * lock_interval) / <timeout>
23212 .endd
23213 times (rounded up).
23214 .endlist
23215
23216 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23217 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23218
23219
23220 .section "Operational details for delivery to a new file" "SECTopdir"
23221 .cindex "delivery" "to single file"
23222 .cindex "&""From""& line"
23223 When the &%directory%& option is set instead of &%file%&, each message is
23224 delivered into a newly-created file or set of files. When &(appendfile)& is
23225 activated directly from a &(redirect)& router, neither &%file%& nor
23226 &%directory%& is normally set, because the path for delivery is supplied by the
23227 router. (See for example, the &(address_file)& transport in the default
23228 configuration.) In this case, delivery is to a new file if either the path name
23229 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23230
23231 No locking is required while writing the message to a new file, so the various
23232 locking options of the transport are ignored. The &"From"& line that by default
23233 separates messages in a single file is not normally needed, nor is the escaping
23234 of message lines that start with &"From"&, and there is no need to ensure a
23235 newline at the end of each message. Consequently, the default values for
23236 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23237 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23238
23239 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23240 the files in the delivery directory by default. However, you can specify a
23241 different directory by setting &%quota_directory%&. Also, for maildir
23242 deliveries (see below) the &_maildirfolder_& convention is honoured.
23243
23244
23245 .cindex "maildir format"
23246 .cindex "mailstore format"
23247 There are three different ways in which delivery to individual files can be
23248 done, controlled by the settings of the &%maildir_format%& and
23249 &%mailstore_format%& options. Note that code to support maildir or mailstore
23250 formats is not included in the binary unless SUPPORT_MAILDIR or
23251 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23252
23253 .cindex "directory creation"
23254 In all three cases an attempt is made to create the directory and any necessary
23255 sub-directories if they do not exist, provided that the &%create_directory%&
23256 option is set (the default). The location of a created directory can be
23257 constrained by setting &%create_file%&. A created directory's mode is given by
23258 the &%directory_mode%& option. If creation fails, or if the
23259 &%create_directory%& option is not set when creation is required, delivery is
23260 deferred.
23261
23262
23263
23264 .section "Maildir delivery" "SECTmaildirdelivery"
23265 .cindex "maildir format" "description of"
23266 If the &%maildir_format%& option is true, Exim delivers each message by writing
23267 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23268 directory that is defined by the &%directory%& option (the &"delivery
23269 directory"&). If the delivery is successful, the file is renamed into the
23270 &_new_& subdirectory.
23271
23272 In the filename, <&'stime'&> is the current time of day in seconds, and
23273 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23274 Exim checks that the time-of-day clock has moved on by at least one microsecond
23275 before terminating the delivery process. This guarantees uniqueness for the
23276 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23277 opening it. If any response other than ENOENT (does not exist) is given,
23278 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23279
23280 Before Exim carries out a maildir delivery, it ensures that subdirectories
23281 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23282 do not exist, Exim tries to create them and any superior directories in their
23283 path, subject to the &%create_directory%& and &%create_file%& options. If the
23284 &%maildirfolder_create_regex%& option is set, and the regular expression it
23285 contains matches the delivery directory, Exim also ensures that a file called
23286 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23287 &_maildirfolder_& file cannot be created, delivery is deferred.
23288
23289 These features make it possible to use Exim to create all the necessary files
23290 and directories in a maildir mailbox, including subdirectories for maildir++
23291 folders. Consider this example:
23292 .code
23293 maildir_format = true
23294 directory = /var/mail/$local_part\
23295            ${if eq{$local_part_suffix}{}{}\
23296            {/.${substr_1:$local_part_suffix}}}
23297 maildirfolder_create_regex = /\.[^/]+$
23298 .endd
23299 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23300 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23301 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23302 not match this name, so Exim will not look for or create the file
23303 &_/var/mail/pimbo/maildirfolder_&, though it will create
23304 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23305
23306 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23307 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23308 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23309 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23310 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23311
23312 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23313 not inadvertently match the toplevel maildir directory, because a
23314 &_maildirfolder_& file at top level would completely break quota calculations.
23315
23316 .cindex "quota" "in maildir delivery"
23317 .cindex "maildir++"
23318 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23319 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23320 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23321 Exim assumes the directory is a maildir++ folder directory, which is one level
23322 down from the user's top level mailbox directory. This causes it to start at
23323 the parent directory instead of the current directory when calculating the
23324 amount of space used.
23325
23326 One problem with delivering into a multi-file mailbox is that it is
23327 computationally expensive to compute the size of the mailbox for quota
23328 checking. Various approaches have been taken to reduce the amount of work
23329 needed. The next two sections describe two of them. A third alternative is to
23330 use some external process for maintaining the size data, and use the expansion
23331 of the &%mailbox_size%& option as a way of importing it into Exim.
23332
23333
23334
23335
23336 .section "Using tags to record message sizes" "SECID135"
23337 If &%maildir_tag%& is set, the string is expanded for each delivery.
23338 When the maildir file is renamed into the &_new_& sub-directory, the
23339 tag is added to its name. However, if adding the tag takes the length of the
23340 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23341 the tag is dropped and the maildir file is created with no tag.
23342
23343
23344 .vindex "&$message_size$&"
23345 Tags can be used to encode the size of files in their names; see
23346 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23347 happens after the message has been written. The value of the &$message_size$&
23348 variable is set to the number of bytes actually written. If the expansion is
23349 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23350 be deferred. The expanded tag may contain any printing characters except &"/"&.
23351 Non-printing characters in the string are ignored; if the resulting string is
23352 empty, it is ignored. If it starts with an alphanumeric character, a leading
23353 colon is inserted; this default has not proven to be the path that popular
23354 maildir implementations have chosen (but changing it in Exim would break
23355 backwards compatibility).
23356
23357 For one common implementation, you might set:
23358 .code
23359 maildir_tag = ,S=${message_size}
23360 .endd
23361 but you should check the documentation of the other software to be sure.
23362
23363 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23364 as this allows Exim to extract the size from your tag, instead of having to
23365 &[stat()]& each message file.
23366
23367
23368 .section "Using a maildirsize file" "SECID136"
23369 .cindex "quota" "in maildir delivery"
23370 .cindex "maildir format" "&_maildirsize_& file"
23371 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23372 storing quota and message size information in a file called &_maildirsize_&
23373 within the toplevel maildir directory. If this file does not exist, Exim
23374 creates it, setting the quota from the &%quota%& option of the transport. If
23375 the maildir directory itself does not exist, it is created before any attempt
23376 to write a &_maildirsize_& file.
23377
23378 The &_maildirsize_& file is used to hold information about the sizes of
23379 messages in the maildir, thus speeding up quota calculations. The quota value
23380 in the file is just a cache; if the quota is changed in the transport, the new
23381 value overrides the cached value when the next message is delivered. The cache
23382 is maintained for the benefit of other programs that access the maildir and
23383 need to know the quota.
23384
23385 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23386 file is maintained (with a zero quota setting), but no quota is imposed.
23387
23388 A regular expression is available for controlling which directories in the
23389 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23390 See the description of the &%maildir_quota_directory_regex%& option above for
23391 details.
23392
23393
23394 .section "Mailstore delivery" "SECID137"
23395 .cindex "mailstore format" "description of"
23396 If the &%mailstore_format%& option is true, each message is written as two
23397 files in the given directory. A unique base name is constructed from the
23398 message id and the current delivery process, and the files that are written use
23399 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23400 contains the message's envelope, and the &_.msg_& file contains the message
23401 itself. The base name is placed in the variable &$mailstore_basename$&.
23402
23403 During delivery, the envelope is first written to a file with the suffix
23404 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23405 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23406 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23407 file before accessing either of them. An alternative approach is to wait for
23408 the absence of a &_.tmp_& file.
23409
23410 The envelope file starts with any text defined by the &%mailstore_prefix%&
23411 option, expanded and terminated by a newline if there isn't one. Then follows
23412 the sender address on one line, then all the recipient addresses, one per line.
23413 There can be more than one recipient only if the &%batch_max%& option is set
23414 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23415 appended to the file, followed by a newline if it does not end with one.
23416
23417 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23418 failure, it is ignored. Other expansion errors are treated as serious
23419 configuration errors, and delivery is deferred. The variable
23420 &$mailstore_basename$& is available for use during these expansions.
23421
23422
23423 .section "Non-special new file delivery" "SECID138"
23424 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23425 file is created directly in the named directory. For example, when delivering
23426 messages into files in batched SMTP format for later delivery to some host (see
23427 section &<<SECTbatchSMTP>>&), a setting such as
23428 .code
23429 directory = /var/bsmtp/$host
23430 .endd
23431 might be used. A message is written to a file with a temporary name, which is
23432 then renamed when the delivery is complete. The final name is obtained by
23433 expanding the contents of the &%directory_file%& option.
23434 .ecindex IIDapptra1
23435 .ecindex IIDapptra2
23436
23437
23438
23439
23440
23441
23442 . ////////////////////////////////////////////////////////////////////////////
23443 . ////////////////////////////////////////////////////////////////////////////
23444
23445 .chapter "The autoreply transport" "CHID8"
23446 .scindex IIDauttra1 "transports" "&(autoreply)&"
23447 .scindex IIDauttra2 "&(autoreply)& transport"
23448 The &(autoreply)& transport is not a true transport in that it does not cause
23449 the message to be transmitted. Instead, it generates a new mail message as an
23450 automatic reply to the incoming message. &'References:'& and
23451 &'Auto-Submitted:'& header lines are included. These are constructed according
23452 to the rules in RFCs 2822 and 3834, respectively.
23453
23454 If the router that passes the message to this transport does not have the
23455 &%unseen%& option set, the original message (for the current recipient) is not
23456 delivered anywhere. However, when the &%unseen%& option is set on the router
23457 that passes the message to this transport, routing of the address continues, so
23458 another router can set up a normal message delivery.
23459
23460
23461 The &(autoreply)& transport is usually run as the result of mail filtering, a
23462 &"vacation"& message being the standard example. However, it can also be run
23463 directly from a router like any other transport. To reduce the possibility of
23464 message cascades, messages created by the &(autoreply)& transport always have
23465 empty envelope sender addresses, like bounce messages.
23466
23467 The parameters of the message to be sent can be specified in the configuration
23468 by options described below. However, these are used only when the address
23469 passed to the transport does not contain its own reply information. When the
23470 transport is run as a consequence of a
23471 &%mail%&
23472 or &%vacation%& command in a filter file, the parameters of the message are
23473 supplied by the filter, and passed with the address. The transport's options
23474 that define the message are then ignored (so they are not usually set in this
23475 case). The message is specified entirely by the filter or by the transport; it
23476 is never built from a mixture of options. However, the &%file_optional%&,
23477 &%mode%&, and &%return_message%& options apply in all cases.
23478
23479 &(Autoreply)& is implemented as a local transport. When used as a result of a
23480 command in a user's filter file, &(autoreply)& normally runs under the uid and
23481 gid of the user, and with appropriate current and home directories (see chapter
23482 &<<CHAPenvironment>>&).
23483
23484 There is a subtle difference between routing a message to a &(pipe)& transport
23485 that generates some text to be returned to the sender, and routing it to an
23486 &(autoreply)& transport. This difference is noticeable only if more than one
23487 address from the same message is so handled. In the case of a pipe, the
23488 separate outputs from the different addresses are gathered up and returned to
23489 the sender in a single message, whereas if &(autoreply)& is used, a separate
23490 message is generated for each address that is passed to it.
23491
23492 Non-printing characters are not permitted in the header lines generated for the
23493 message that &(autoreply)& creates, with the exception of newlines that are
23494 immediately followed by white space. If any non-printing characters are found,
23495 the transport defers.
23496 Whether characters with the top bit set count as printing characters or not is
23497 controlled by the &%print_topbitchars%& global option.
23498
23499 If any of the generic options for manipulating headers (for example,
23500 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23501 of the original message that is included in the generated message when
23502 &%return_message%& is set. They do not apply to the generated message itself.
23503
23504 .vindex "&$sender_address$&"
23505 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23506 the message, indicating that there were no recipients, it does not treat this
23507 as an error. This means that autoreplies sent to &$sender_address$& when this
23508 is empty (because the incoming message is a bounce message) do not cause
23509 problems. They are just discarded.
23510
23511
23512
23513 .section "Private options for autoreply" "SECID139"
23514 .cindex "options" "&(autoreply)& transport"
23515
23516 .option bcc autoreply string&!! unset
23517 This specifies the addresses that are to receive &"blind carbon copies"& of the
23518 message when the message is specified by the transport.
23519
23520
23521 .option cc autoreply string&!! unset
23522 This specifies recipients of the message and the contents of the &'Cc:'& header
23523 when the message is specified by the transport.
23524
23525
23526 .option file autoreply string&!! unset
23527 The contents of the file are sent as the body of the message when the message
23528 is specified by the transport. If both &%file%& and &%text%& are set, the text
23529 string comes first.
23530
23531
23532 .option file_expand autoreply boolean false
23533 If this is set, the contents of the file named by the &%file%& option are
23534 subjected to string expansion as they are added to the message.
23535
23536
23537 .option file_optional autoreply boolean false
23538 If this option is true, no error is generated if the file named by the &%file%&
23539 option or passed with the address does not exist or cannot be read.
23540
23541
23542 .option from autoreply string&!! unset
23543 This specifies the contents of the &'From:'& header when the message is
23544 specified by the transport.
23545
23546
23547 .option headers autoreply string&!! unset
23548 This specifies additional RFC 2822 headers that are to be added to the message
23549 when the message is specified by the transport. Several can be given by using
23550 &"\n"& to separate them. There is no check on the format.
23551
23552
23553 .option log autoreply string&!! unset
23554 This option names a file in which a record of every message sent is logged when
23555 the message is specified by the transport.
23556
23557
23558 .option mode autoreply "octal integer" 0600
23559 If either the log file or the &"once"& file has to be created, this mode is
23560 used.
23561
23562
23563 .option never_mail autoreply "address list&!!" unset
23564 If any run of the transport creates a message with a recipient that matches any
23565 item in the list, that recipient is quietly discarded. If all recipients are
23566 discarded, no message is created. This applies both when the recipients are
23567 generated by a filter and when they are specified in the transport.
23568
23569
23570
23571 .option once autoreply string&!! unset
23572 This option names a file or DBM database in which a record of each &'To:'&
23573 recipient is kept when the message is specified by the transport. &*Note*&:
23574 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23575
23576 If &%once%& is unset, or is set to an empty string, the message is always sent.
23577 By default, if &%once%& is set to a non-empty filename, the message
23578 is not sent if a potential recipient is already listed in the database.
23579 However, if the &%once_repeat%& option specifies a time greater than zero, the
23580 message is sent if that much time has elapsed since a message was last sent to
23581 this recipient. A setting of zero time for &%once_repeat%& (the default)
23582 prevents a message from being sent a second time &-- in this case, zero means
23583 infinity.
23584
23585 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23586 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23587 greater than zero, it changes the way Exim implements the &%once%& option.
23588 Instead of using a DBM file to record every recipient it sends to, it uses a
23589 regular file, whose size will never get larger than the given value.
23590
23591 In the file, Exim keeps a linear list of recipient addresses and the times at
23592 which they were sent messages. If the file is full when a new address needs to
23593 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23594 means that a given recipient may receive multiple messages, but at
23595 unpredictable intervals that depend on the rate of turnover of addresses in the
23596 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23597
23598
23599 .option once_file_size autoreply integer 0
23600 See &%once%& above.
23601
23602
23603 .option once_repeat autoreply time&!! 0s
23604 See &%once%& above.
23605 After expansion, the value of this option must be a valid time value.
23606
23607
23608 .option reply_to autoreply string&!! unset
23609 This specifies the contents of the &'Reply-To:'& header when the message is
23610 specified by the transport.
23611
23612
23613 .option return_message autoreply boolean false
23614 If this is set, a copy of the original message is returned with the new
23615 message, subject to the maximum size set in the &%return_size_limit%& global
23616 configuration option.
23617
23618
23619 .option subject autoreply string&!! unset
23620 This specifies the contents of the &'Subject:'& header when the message is
23621 specified by the transport. It is tempting to quote the original subject in
23622 automatic responses. For example:
23623 .code
23624 subject = Re: $h_subject:
23625 .endd
23626 There is a danger in doing this, however. It may allow a third party to
23627 subscribe your users to an opt-in mailing list, provided that the list accepts
23628 bounce messages as subscription confirmations. Well-managed lists require a
23629 non-bounce message to confirm a subscription, so the danger is relatively
23630 small.
23631
23632
23633
23634 .option text autoreply string&!! unset
23635 This specifies a single string to be used as the body of the message when the
23636 message is specified by the transport. If both &%text%& and &%file%& are set,
23637 the text comes first.
23638
23639
23640 .option to autoreply string&!! unset
23641 This specifies recipients of the message and the contents of the &'To:'& header
23642 when the message is specified by the transport.
23643 .ecindex IIDauttra1
23644 .ecindex IIDauttra2
23645
23646
23647
23648
23649 . ////////////////////////////////////////////////////////////////////////////
23650 . ////////////////////////////////////////////////////////////////////////////
23651
23652 .chapter "The lmtp transport" "CHAPLMTP"
23653 .cindex "transports" "&(lmtp)&"
23654 .cindex "&(lmtp)& transport"
23655 .cindex "LMTP" "over a pipe"
23656 .cindex "LMTP" "over a socket"
23657 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23658 specified command
23659 or by interacting with a Unix domain socket.
23660 This transport is something of a cross between the &(pipe)& and &(smtp)&
23661 transports. Exim also has support for using LMTP over TCP/IP; this is
23662 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23663 to be of minority interest, the default build-time configure in &_src/EDITME_&
23664 has it commented out. You need to ensure that
23665 .code
23666 TRANSPORT_LMTP=yes
23667 .endd
23668 .cindex "options" "&(lmtp)& transport"
23669 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23670 included in the Exim binary. The private options of the &(lmtp)& transport are
23671 as follows:
23672
23673 .option batch_id lmtp string&!! unset
23674 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23675
23676
23677 .option batch_max lmtp integer 1
23678 This limits the number of addresses that can be handled in a single delivery.
23679 Most LMTP servers can handle several addresses at once, so it is normally a
23680 good idea to increase this value. See the description of local delivery
23681 batching in chapter &<<CHAPbatching>>&.
23682
23683
23684 .option command lmtp string&!! unset
23685 This option must be set if &%socket%& is not set. The string is a command which
23686 is run in a separate process. It is split up into a command name and list of
23687 arguments, each of which is separately expanded (so expansion cannot change the
23688 number of arguments). The command is run directly, not via a shell. The message
23689 is passed to the new process using the standard input and output to operate the
23690 LMTP protocol.
23691
23692 .option ignore_quota lmtp boolean false
23693 .cindex "LMTP" "ignoring quota errors"
23694 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23695 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23696 in its response to the LHLO command.
23697
23698 .option socket lmtp string&!! unset
23699 This option must be set if &%command%& is not set. The result of expansion must
23700 be the name of a Unix domain socket. The transport connects to the socket and
23701 delivers the message to it using the LMTP protocol.
23702
23703
23704 .option timeout lmtp time 5m
23705 The transport is aborted if the created process or Unix domain socket does not
23706 respond to LMTP commands or message input within this timeout. Delivery
23707 is deferred, and will be tried again later. Here is an example of a typical
23708 LMTP transport:
23709 .code
23710 lmtp:
23711   driver = lmtp
23712   command = /some/local/lmtp/delivery/program
23713   batch_max = 20
23714   user = exim
23715 .endd
23716 This delivers up to 20 addresses at a time, in a mixture of domains if
23717 necessary, running as the user &'exim'&.
23718
23719
23720
23721 . ////////////////////////////////////////////////////////////////////////////
23722 . ////////////////////////////////////////////////////////////////////////////
23723
23724 .chapter "The pipe transport" "CHAPpipetransport"
23725 .scindex IIDpiptra1 "transports" "&(pipe)&"
23726 .scindex IIDpiptra2 "&(pipe)& transport"
23727 The &(pipe)& transport is used to deliver messages via a pipe to a command
23728 running in another process. One example is the use of &(pipe)& as a
23729 pseudo-remote transport for passing messages to some other delivery mechanism
23730 (such as UUCP). Another is the use by individual users to automatically process
23731 their incoming messages. The &(pipe)& transport can be used in one of the
23732 following ways:
23733
23734 .ilist
23735 .vindex "&$local_part$&"
23736 A router routes one address to a transport in the normal way, and the
23737 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23738 contains the local part of the address (as usual), and the command that is run
23739 is specified by the &%command%& option on the transport.
23740 .next
23741 .vindex "&$pipe_addresses$&"
23742 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23743 transport can handle more than one address in a single run. In this case, when
23744 more than one address is routed to the transport, &$local_part$& is not set
23745 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23746 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23747 that are routed to the transport.
23748 .next
23749 .vindex "&$address_pipe$&"
23750 A router redirects an address directly to a pipe command (for example, from an
23751 alias or forward file). In this case, &$address_pipe$& contains the text of the
23752 pipe command, and the &%command%& option on the transport is ignored unless
23753 &%force_command%& is set. If only one address is being transported
23754 (&%batch_max%& is not greater than one, or only one address was redirected to
23755 this pipe command), &$local_part$& contains the local part that was redirected.
23756 .endlist
23757
23758
23759 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23760 deliver messages over pipes using the LMTP interactive protocol. This is
23761 implemented by the &(lmtp)& transport.
23762
23763 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23764 &_.forward_& file, the command runs under the uid and gid of that user. In
23765 other cases, the uid and gid have to be specified explicitly, either on the
23766 transport or on the router that handles the address. Current and &"home"&
23767 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23768 details of the local delivery environment and chapter &<<CHAPbatching>>&
23769 for a discussion of local delivery batching.
23770
23771
23772 .section "Concurrent delivery" "SECID140"
23773 If two messages arrive at almost the same time, and both are routed to a pipe
23774 delivery, the two pipe transports may be run concurrently. You must ensure that
23775 any pipe commands you set up are robust against this happening. If the commands
23776 write to a file, the &%exim_lock%& utility might be of use.
23777 Alternatively the &%max_parallel%& option could be used with a value
23778 of "1" to enforce serialization.
23779
23780
23781
23782
23783 .section "Returned status and data" "SECID141"
23784 .cindex "&(pipe)& transport" "returned data"
23785 If the command exits with a non-zero return code, the delivery is deemed to
23786 have failed, unless either the &%ignore_status%& option is set (in which case
23787 the return code is treated as zero), or the return code is one of those listed
23788 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23789 later"&. In this case, delivery is deferred. Details of a permanent failure are
23790 logged, but are not included in the bounce message, which merely contains
23791 &"local delivery failed"&.
23792
23793 If the command exits on a signal and the &%freeze_signal%& option is set then
23794 the message will be frozen in the queue. If that option is not set, a bounce
23795 will be sent as normal.
23796
23797 If the return code is greater than 128 and the command being run is a shell
23798 script, it normally means that the script was terminated by a signal whose
23799 value is the return code minus 128. The &%freeze_signal%& option does not
23800 apply in this case.
23801
23802 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23803 return code is set to 127. This is the value that a shell returns if it is
23804 asked to run a non-existent command. The wording for the log line suggests that
23805 a non-existent command may be the problem.
23806
23807 The &%return_output%& option can affect the result of a pipe delivery. If it is
23808 set and the command produces any output on its standard output or standard
23809 error streams, the command is considered to have failed, even if it gave a zero
23810 return code or if &%ignore_status%& is set. The output from the command is
23811 included as part of the bounce message. The &%return_fail_output%& option is
23812 similar, except that output is returned only when the command exits with a
23813 failure return code, that is, a value other than zero or a code that matches
23814 &%temp_errors%&.
23815
23816
23817
23818 .section "How the command is run" "SECThowcommandrun"
23819 .cindex "&(pipe)& transport" "path for command"
23820 The command line is (by default) broken down into a command name and arguments
23821 by the &(pipe)& transport itself. The &%allow_commands%& and
23822 &%restrict_to_path%& options can be used to restrict the commands that may be
23823 run.
23824
23825 .cindex "quoting" "in pipe command"
23826 Unquoted arguments are delimited by white space. If an argument appears in
23827 double quotes, backslash is interpreted as an escape character in the usual
23828 way. If an argument appears in single quotes, no escaping is done.
23829
23830 String expansion is applied to the command line except when it comes from a
23831 traditional &_.forward_& file (commands from a filter file are expanded). The
23832 expansion is applied to each argument in turn rather than to the whole line.
23833 For this reason, any string expansion item that contains white space must be
23834 quoted so as to be contained within a single argument. A setting such as
23835 .code
23836 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23837 .endd
23838 will not work, because the expansion item gets split between several
23839 arguments. You have to write
23840 .code
23841 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23842 .endd
23843 to ensure that it is all in one argument. The expansion is done in this way,
23844 argument by argument, so that the number of arguments cannot be changed as a
23845 result of expansion, and quotes or backslashes in inserted variables do not
23846 interact with external quoting. However, this leads to problems if you want to
23847 generate multiple arguments (or the command name plus arguments) from a single
23848 expansion. In this situation, the simplest solution is to use a shell. For
23849 example:
23850 .code
23851 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23852 .endd
23853
23854 .cindex "transport" "filter"
23855 .cindex "filter" "transport filter"
23856 .vindex "&$pipe_addresses$&"
23857 Special handling takes place when an argument consists of precisely the text
23858 &`$pipe_addresses`& (no quotes).
23859 This is not a general expansion variable; the only
23860 place this string is recognized is when it appears as an argument for a pipe or
23861 transport filter command. It causes each address that is being handled to be
23862 inserted in the argument list at that point &'as a separate argument'&. This
23863 avoids any problems with spaces or shell metacharacters, and is of use when a
23864 &(pipe)& transport is handling groups of addresses in a batch.
23865
23866 If &%force_command%& is enabled on the transport, special handling takes place
23867 for an argument that consists of precisely the text &`$address_pipe`&.  It
23868 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23869 argument is inserted in the argument list at that point
23870 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23871 the only item in the argument; in fact, if it were then &%force_command%&
23872 should behave as a no-op.  Rather, it should be used to adjust the command
23873 run while preserving the argument vector separation.
23874
23875 After splitting up into arguments and expansion, the resulting command is run
23876 in a subprocess directly from the transport, &'not'& under a shell. The
23877 message that is being delivered is supplied on the standard input, and the
23878 standard output and standard error are both connected to a single pipe that is
23879 read by Exim. The &%max_output%& option controls how much output the command
23880 may produce, and the &%return_output%& and &%return_fail_output%& options
23881 control what is done with it.
23882
23883 Not running the command under a shell (by default) lessens the security risks
23884 in cases when a command from a user's filter file is built out of data that was
23885 taken from an incoming message. If a shell is required, it can of course be
23886 explicitly specified as the command to be run. However, there are circumstances
23887 where existing commands (for example, in &_.forward_& files) expect to be run
23888 under a shell and cannot easily be modified. To allow for these cases, there is
23889 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23890 works. Instead of breaking up the command line as just described, it expands it
23891 as a single string and passes the result to &_/bin/sh_&. The
23892 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23893 with &%use_shell%&, and the whole mechanism is inherently less secure.
23894
23895
23896
23897 .section "Environment variables" "SECTpipeenv"
23898 .cindex "&(pipe)& transport" "environment for command"
23899 .cindex "environment" "&(pipe)& transport"
23900 The environment variables listed below are set up when the command is invoked.
23901 This list is a compromise for maximum compatibility with other MTAs. Note that
23902 the &%environment%& option can be used to add additional variables to this
23903 environment. The environment for the &(pipe)& transport is not subject
23904 to the &%add_environment%& and &%keep_environment%& main config options.
23905 .display
23906 &`DOMAIN            `&   the domain of the address
23907 &`HOME              `&   the home directory, if set
23908 &`HOST              `&   the host name when called from a router (see below)
23909 &`LOCAL_PART        `&   see below
23910 &`LOCAL_PART_PREFIX `&   see below
23911 &`LOCAL_PART_SUFFIX `&   see below
23912 &`LOGNAME           `&   see below
23913 &`MESSAGE_ID        `&   Exim's local ID for the message
23914 &`PATH              `&   as specified by the &%path%& option below
23915 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23916 &`RECIPIENT         `&   the complete recipient address
23917 &`SENDER            `&   the sender of the message (empty if a bounce)
23918 &`SHELL             `&   &`/bin/sh`&
23919 &`TZ                `&   the value of the &%timezone%& option, if set
23920 &`USER              `&   see below
23921 .endd
23922 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23923 router, LOCAL_PART is set to the local part of the address. When it is
23924 called as a result of a forward or alias expansion, LOCAL_PART is set to
23925 the local part of the address that was expanded. In both cases, any affixes are
23926 removed from the local part, and made available in LOCAL_PART_PREFIX and
23927 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23928 same value as LOCAL_PART for compatibility with other MTAs.
23929
23930 .cindex "HOST"
23931 HOST is set only when a &(pipe)& transport is called from a router that
23932 associates hosts with an address, typically when using &(pipe)& as a
23933 pseudo-remote transport. HOST is set to the first host name specified by
23934 the router.
23935
23936 .cindex "HOME"
23937 If the transport's generic &%home_directory%& option is set, its value is used
23938 for the HOME environment variable. Otherwise, a home directory may be set
23939 by the router's &%transport_home_directory%& option, which defaults to the
23940 user's home directory if &%check_local_user%& is set.
23941
23942
23943 .section "Private options for pipe" "SECID142"
23944 .cindex "options" "&(pipe)& transport"
23945
23946
23947
23948 .option allow_commands pipe "string list&!!" unset
23949 .cindex "&(pipe)& transport" "permitted commands"
23950 The string is expanded, and is then interpreted as a colon-separated list of
23951 permitted commands. If &%restrict_to_path%& is not set, the only commands
23952 permitted are those in the &%allow_commands%& list. They need not be absolute
23953 paths; the &%path%& option is still used for relative paths. If
23954 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23955 in the &%allow_commands%& list, or a name without any slashes that is found on
23956 the path. In other words, if neither &%allow_commands%& nor
23957 &%restrict_to_path%& is set, there is no restriction on the command, but
23958 otherwise only commands that are permitted by one or the other are allowed. For
23959 example, if
23960 .code
23961 allow_commands = /usr/bin/vacation
23962 .endd
23963 and &%restrict_to_path%& is not set, the only permitted command is
23964 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23965 &%use_shell%& is set.
23966
23967
23968 .option batch_id pipe string&!! unset
23969 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23970
23971
23972 .option batch_max pipe integer 1
23973 This limits the number of addresses that can be handled in a single delivery.
23974 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23975
23976
23977 .option check_string pipe string unset
23978 As &(pipe)& writes the message, the start of each line is tested for matching
23979 &%check_string%&, and if it does, the initial matching characters are replaced
23980 by the contents of &%escape_string%&, provided both are set. The value of
23981 &%check_string%& is a literal string, not a regular expression, and the case of
23982 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23983 of &%check_string%& and &%escape_string%& are forced to values that implement
23984 the SMTP escaping protocol. Any settings made in the configuration file are
23985 ignored.
23986
23987
23988 .option command pipe string&!! unset
23989 This option need not be set when &(pipe)& is being used to deliver to pipes
23990 obtained directly from address redirections. In other cases, the option must be
23991 set, to provide a command to be run. It need not yield an absolute path (see
23992 the &%path%& option below). The command is split up into separate arguments by
23993 Exim, and each argument is separately expanded, as described in section
23994 &<<SECThowcommandrun>>& above.
23995
23996
23997 .option environment pipe string&!! unset
23998 .cindex "&(pipe)& transport" "environment for command"
23999 .cindex "environment" "&(pipe)& transport"
24000 This option is used to add additional variables to the environment in which the
24001 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24002 a string which is expanded, and then interpreted as a colon-separated list of
24003 environment settings of the form <&'name'&>=<&'value'&>.
24004
24005
24006 .option escape_string pipe string unset
24007 See &%check_string%& above.
24008
24009
24010 .option freeze_exec_fail pipe boolean false
24011 .cindex "exec failure"
24012 .cindex "failure of exec"
24013 .cindex "&(pipe)& transport" "failure of exec"
24014 Failure to exec the command in a pipe transport is by default treated like
24015 any other failure while running the command. However, if &%freeze_exec_fail%&
24016 is set, failure to exec is treated specially, and causes the message to be
24017 frozen, whatever the setting of &%ignore_status%&.
24018
24019
24020 .option freeze_signal pipe boolean false
24021 .cindex "signal exit"
24022 .cindex "&(pipe)& transport", "signal exit"
24023 Normally if the process run by a command in a pipe transport exits on a signal,
24024 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24025 frozen in Exim's queue instead.
24026
24027
24028 .option force_command pipe boolean false
24029 .cindex "force command"
24030 .cindex "&(pipe)& transport", "force command"
24031 Normally when a router redirects an address directly to a pipe command
24032 the &%command%& option on the transport is ignored.  If &%force_command%&
24033 is set, the &%command%& option will used. This is especially
24034 useful for forcing a wrapper or additional argument to be added to the
24035 command. For example:
24036 .code
24037 command = /usr/bin/remote_exec myhost -- $address_pipe
24038 force_command
24039 .endd
24040
24041 Note that &$address_pipe$& is handled specially in &%command%& when
24042 &%force_command%& is set, expanding out to the original argument vector as
24043 separate items, similarly to a Unix shell &`"$@"`& construct.
24044
24045
24046 .option ignore_status pipe boolean false
24047 If this option is true, the status returned by the subprocess that is set up to
24048 run the command is ignored, and Exim behaves as if zero had been returned.
24049 Otherwise, a non-zero status or termination by signal causes an error return
24050 from the transport unless the status value is one of those listed in
24051 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24052
24053 &*Note*&: This option does not apply to timeouts, which do not return a status.
24054 See the &%timeout_defer%& option for how timeouts are handled.
24055
24056
24057 .option log_defer_output pipe boolean false
24058 .cindex "&(pipe)& transport" "logging output"
24059 If this option is set, and the status returned by the command is
24060 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24061 and any output was produced on stdout or stderr, the first line of it is
24062 written to the main log.
24063
24064
24065 .option log_fail_output pipe boolean false
24066 If this option is set, and the command returns any output on stdout or
24067 stderr, and also ends with a return code that is neither zero nor one of
24068 the return codes listed in &%temp_errors%& (that is, the delivery
24069 failed), the first line of output is written to the main log. This
24070 option and &%log_output%& are mutually exclusive.  Only one of them may
24071 be set.
24072
24073
24074 .option log_output pipe boolean false
24075 If this option is set and the command returns any output on stdout or
24076 stderr, the first line of output is written to the main log, whatever
24077 the return code. This option and &%log_fail_output%& are mutually
24078 exclusive. Only one of them may be set.
24079
24080
24081 .option max_output pipe integer 20K
24082 This specifies the maximum amount of output that the command may produce on its
24083 standard output and standard error file combined. If the limit is exceeded, the
24084 process running the command is killed. This is intended as a safety measure to
24085 catch runaway processes. The limit is applied independently of the settings of
24086 the options that control what is done with such output (for example,
24087 &%return_output%&). Because of buffering effects, the amount of output may
24088 exceed the limit by a small amount before Exim notices.
24089
24090
24091 .option message_prefix pipe string&!! "see below"
24092 The string specified here is expanded and output at the start of every message.
24093 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24094 .code
24095 message_prefix = \
24096   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24097   ${tod_bsdinbox}\n
24098 .endd
24099 .cindex "Cyrus"
24100 .cindex "&%tmail%&"
24101 .cindex "&""From""& line"
24102 This is required by the commonly used &_/usr/bin/vacation_& program.
24103 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24104 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24105 setting
24106 .code
24107 message_prefix =
24108 .endd
24109 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24110 &`\n`& to &`\r\n`& in &%message_prefix%&.
24111
24112
24113 .option message_suffix pipe string&!! "see below"
24114 The string specified here is expanded and output at the end of every message.
24115 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24116 The suffix can be suppressed by setting
24117 .code
24118 message_suffix =
24119 .endd
24120 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24121 &`\n`& to &`\r\n`& in &%message_suffix%&.
24122
24123
24124 .option path pipe string&!! "/bin:/usr/bin"
24125 This option is expanded and
24126 specifies the string that is set up in the PATH environment
24127 variable of the subprocess.
24128 If the &%command%& option does not yield an absolute path name, the command is
24129 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24130 apply to a command specified as a transport filter.
24131
24132
24133 .option permit_coredump pipe boolean false
24134 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24135 a core-dump of a pipe command, enable this command.  This enables core-dumps
24136 during delivery and affects both the Exim binary and the pipe command run.
24137 It is recommended that this option remain off unless and until you have a need
24138 for it and that this only be enabled when needed, as the risk of excessive
24139 resource consumption can be quite high.  Note also that Exim is typically
24140 installed as a setuid binary and most operating systems will inhibit coredumps
24141 of these by default, so further OS-specific action may be required.
24142
24143
24144 .option pipe_as_creator pipe boolean false
24145 .cindex "uid (user id)" "local delivery"
24146 If the generic &%user%& option is not set and this option is true, the delivery
24147 process is run under the uid that was in force when Exim was originally called
24148 to accept the message. If the group id is not otherwise set (via the generic
24149 &%group%& option), the gid that was in force when Exim was originally called to
24150 accept the message is used.
24151
24152
24153 .option restrict_to_path pipe boolean false
24154 When this option is set, any command name not listed in &%allow_commands%& must
24155 contain no slashes. The command is searched for only in the directories listed
24156 in the &%path%& option. This option is intended for use in the case when a pipe
24157 command has been generated from a user's &_.forward_& file. This is usually
24158 handled by a &(pipe)& transport called &%address_pipe%&.
24159
24160
24161 .option return_fail_output pipe boolean false
24162 If this option is true, and the command produced any output and ended with a
24163 return code other than zero or one of the codes listed in &%temp_errors%& (that
24164 is, the delivery failed), the output is returned in the bounce message.
24165 However, if the message has a null sender (that is, it is itself a bounce
24166 message), output from the command is discarded. This option and
24167 &%return_output%& are mutually exclusive. Only one of them may be set.
24168
24169
24170
24171 .option return_output pipe boolean false
24172 If this option is true, and the command produced any output, the delivery is
24173 deemed to have failed whatever the return code from the command, and the output
24174 is returned in the bounce message. Otherwise, the output is just discarded.
24175 However, if the message has a null sender (that is, it is a bounce message),
24176 output from the command is always discarded, whatever the setting of this
24177 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24178 of them may be set.
24179
24180
24181
24182 .option temp_errors pipe "string list" "see below"
24183 .cindex "&(pipe)& transport" "temporary failure"
24184 This option contains either a colon-separated list of numbers, or a single
24185 asterisk. If &%ignore_status%& is false
24186 and &%return_output%& is not set,
24187 and the command exits with a non-zero return code, the failure is treated as
24188 temporary and the delivery is deferred if the return code matches one of the
24189 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24190 codes are treated as permanent errors. The default setting contains the codes
24191 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24192 compiled on a system that does not define these macros, it assumes values of 75
24193 and 73, respectively.
24194
24195
24196 .option timeout pipe time 1h
24197 If the command fails to complete within this time, it is killed. This normally
24198 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24199 specifies no timeout. In order to ensure that any subprocesses created by the
24200 command are also killed, Exim makes the initial process a process group leader,
24201 and kills the whole process group on a timeout. However, this can be defeated
24202 if one of the processes starts a new process group.
24203
24204 .option timeout_defer pipe boolean false
24205 A timeout in a &(pipe)& transport, either in the command that the transport
24206 runs, or in a transport filter that is associated with it, is by default
24207 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24208 is set true, both kinds of timeout become temporary errors, causing the
24209 delivery to be deferred.
24210
24211 .option umask pipe "octal integer" 022
24212 This specifies the umask setting for the subprocess that runs the command.
24213
24214
24215 .option use_bsmtp pipe boolean false
24216 .cindex "envelope sender"
24217 If this option is set true, the &(pipe)& transport writes messages in &"batch
24218 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24219 commands. If you want to include a leading HELO command with such messages,
24220 you can do so by setting the &%message_prefix%& option. See section
24221 &<<SECTbatchSMTP>>& for details of batch SMTP.
24222
24223 .option use_classresources pipe boolean false
24224 .cindex "class resources (BSD)"
24225 This option is available only when Exim is running on FreeBSD, NetBSD, or
24226 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24227 resource limits when a &(pipe)& transport is run to perform a delivery. The
24228 limits for the uid under which the pipe is to run are obtained from the login
24229 class database.
24230
24231
24232 .option use_crlf pipe boolean false
24233 .cindex "carriage return"
24234 .cindex "linefeed"
24235 This option causes lines to be terminated with the two-character CRLF sequence
24236 (carriage return, linefeed) instead of just a linefeed character. In the case
24237 of batched SMTP, the byte sequence written to the pipe is then an exact image
24238 of what would be sent down a real SMTP connection.
24239
24240 The contents of the &%message_prefix%& and &%message_suffix%& options are
24241 written verbatim, so must contain their own carriage return characters if these
24242 are needed. When &%use_bsmtp%& is not set, the default values for both
24243 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24244 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24245
24246
24247 .option use_shell pipe boolean false
24248 .vindex "&$pipe_addresses$&"
24249 If this option is set, it causes the command to be passed to &_/bin/sh_&
24250 instead of being run directly from the transport, as described in section
24251 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24252 where the command is expected to be run under a shell and cannot easily be
24253 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24254 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24255 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24256 its &%-c%& option.
24257
24258
24259
24260 .section "Using an external local delivery agent" "SECID143"
24261 .cindex "local delivery" "using an external agent"
24262 .cindex "&'procmail'&"
24263 .cindex "external local delivery"
24264 .cindex "delivery" "&'procmail'&"
24265 .cindex "delivery" "by external agent"
24266 The &(pipe)& transport can be used to pass all messages that require local
24267 delivery to a separate local delivery agent such as &%procmail%&. When doing
24268 this, care must be taken to ensure that the pipe is run under an appropriate
24269 uid and gid. In some configurations one wants this to be a uid that is trusted
24270 by the delivery agent to supply the correct sender of the message. It may be
24271 necessary to recompile or reconfigure the delivery agent so that it trusts an
24272 appropriate user. The following is an example transport and router
24273 configuration for &%procmail%&:
24274 .code
24275 # transport
24276 procmail_pipe:
24277   driver = pipe
24278   command = /usr/local/bin/procmail -d $local_part
24279   return_path_add
24280   delivery_date_add
24281   envelope_to_add
24282   check_string = "From "
24283   escape_string = ">From "
24284   umask = 077
24285   user = $local_part
24286   group = mail
24287
24288 # router
24289 procmail:
24290   driver = accept
24291   check_local_user
24292   transport = procmail_pipe
24293 .endd
24294 In this example, the pipe is run as the local user, but with the group set to
24295 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24296 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24297 user to supply a correct sender address. If you do not specify either a
24298 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24299 home directory is the user's home directory by default.
24300
24301 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24302 .code
24303 IFS=" "
24304 .endd
24305 as shown in some &%procmail%& documentation, because Exim does not by default
24306 use a shell to run pipe commands.
24307
24308 .cindex "Cyrus"
24309 The next example shows a transport and a router for a system where local
24310 deliveries are handled by the Cyrus IMAP server.
24311 .code
24312 # transport
24313 local_delivery_cyrus:
24314   driver = pipe
24315   command = /usr/cyrus/bin/deliver \
24316             -m ${substr_1:$local_part_suffix} -- $local_part
24317   user = cyrus
24318   group = mail
24319   return_output
24320   log_output
24321   message_prefix =
24322   message_suffix =
24323
24324 # router
24325 local_user_cyrus:
24326   driver = accept
24327   check_local_user
24328   local_part_suffix = .*
24329   transport = local_delivery_cyrus
24330 .endd
24331 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24332 &%return_output%& to cause any text written by Cyrus to be returned to the
24333 sender.
24334 .ecindex IIDpiptra1
24335 .ecindex IIDpiptra2
24336
24337
24338 . ////////////////////////////////////////////////////////////////////////////
24339 . ////////////////////////////////////////////////////////////////////////////
24340
24341 .chapter "The smtp transport" "CHAPsmtptrans"
24342 .scindex IIDsmttra1 "transports" "&(smtp)&"
24343 .scindex IIDsmttra2 "&(smtp)& transport"
24344 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24345 or LMTP protocol. The list of hosts to try can either be taken from the address
24346 that is being processed (having been set up by the router), or specified
24347 explicitly for the transport. Timeout and retry processing (see chapter
24348 &<<CHAPretry>>&) is applied to each IP address independently.
24349
24350
24351 .section "Multiple messages on a single connection" "SECID144"
24352 The sending of multiple messages over a single TCP/IP connection can arise in
24353 two ways:
24354
24355 .ilist
24356 If a message contains more than &%max_rcpt%& (see below) addresses that are
24357 routed to the same host, more than one copy of the message has to be sent to
24358 that host. In this situation, multiple copies may be sent in a single run of
24359 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24360 does when it has too many addresses to send in one message also depends on the
24361 value of the global &%remote_max_parallel%& option. Details are given in
24362 section &<<SECToutSMTPTCP>>&.)
24363 .next
24364 .cindex "hints database" "remembering routing"
24365 When a message has been successfully delivered over a TCP/IP connection, Exim
24366 looks in its hints database to see if there are any other messages awaiting a
24367 connection to the same host. If there are, a new delivery process is started
24368 for one of them, and the current TCP/IP connection is passed on to it. The new
24369 process may in turn send multiple copies and possibly create yet another
24370 process.
24371 .endlist
24372
24373
24374 For each copy sent over the same TCP/IP connection, a sequence counter is
24375 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24376 no further messages are sent over that connection.
24377
24378
24379
24380 .section "Use of the $host and $host_address variables" "SECID145"
24381 .vindex "&$host$&"
24382 .vindex "&$host_address$&"
24383 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24384 &$host_address$& are the name and IP address of the first host on the host list
24385 passed by the router. However, when the transport is about to connect to a
24386 specific host, and while it is connected to that host, &$host$& and
24387 &$host_address$& are set to the values for that host. These are the values
24388 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24389 &%serialize_hosts%&, and the various TLS options are expanded.
24390
24391
24392 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24393 .vindex &$tls_bits$&
24394 .vindex &$tls_cipher$&
24395 .vindex &$tls_peerdn$&
24396 .vindex &$tls_sni$&
24397 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24398 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24399 are the values that were set when the message was received.
24400 These are the values that are used for options that are expanded before any
24401 SMTP connections are made. Just before each connection is made, these four
24402 variables are emptied. If TLS is subsequently started, they are set to the
24403 appropriate values for the outgoing connection, and these are the values that
24404 are in force when any authenticators are run and when the
24405 &%authenticated_sender%& option is expanded.
24406
24407 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24408 and will be removed in a future release.
24409
24410
24411 .section "Private options for smtp" "SECID146"
24412 .cindex "options" "&(smtp)& transport"
24413 The private options of the &(smtp)& transport are as follows:
24414
24415
24416 .option address_retry_include_sender smtp boolean true
24417 .cindex "4&'xx'& responses" "retrying after"
24418 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24419 is the combination of sender and recipient that is delayed in subsequent queue
24420 runs until the retry time is reached. You can delay the recipient without
24421 reference to the sender (which is what earlier versions of Exim did), by
24422 setting &%address_retry_include_sender%& false. However, this can lead to
24423 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24424
24425 .option allow_localhost smtp boolean false
24426 .cindex "local host" "sending to"
24427 .cindex "fallback" "hosts specified on transport"
24428 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24429 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24430 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24431 the delivery anyway. This should be used only in special cases when the
24432 configuration ensures that no looping will result (for example, a differently
24433 configured Exim is listening on the port to which the message is sent).
24434
24435
24436 .option authenticated_sender smtp string&!! unset
24437 .cindex "Cyrus"
24438 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24439 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24440 overriding any existing authenticated sender value. If the string expansion is
24441 forced to fail, the option is ignored. Other expansion failures cause delivery
24442 to be deferred. If the result of expansion is an empty string, that is also
24443 ignored.
24444
24445 The expansion happens after the outgoing connection has been made and TLS
24446 started, if required. This means that the &$host$&, &$host_address$&,
24447 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24448 particular connection.
24449
24450 If the SMTP session is not authenticated, the expansion of
24451 &%authenticated_sender%& still happens (and can cause the delivery to be
24452 deferred if it fails), but no AUTH= item is added to MAIL commands
24453 unless &%authenticated_sender_force%& is true.
24454
24455 This option allows you to use the &(smtp)& transport in LMTP mode to
24456 deliver mail to Cyrus IMAP and provide the proper local part as the
24457 &"authenticated sender"&, via a setting such as:
24458 .code
24459 authenticated_sender = $local_part
24460 .endd
24461 This removes the need for IMAP subfolders to be assigned special ACLs to
24462 allow direct delivery to those subfolders.
24463
24464 Because of expected uses such as that just described for Cyrus (when no
24465 domain is involved), there is no checking on the syntax of the provided
24466 value.
24467
24468
24469 .option authenticated_sender_force smtp boolean false
24470 If this option is set true, the &%authenticated_sender%& option's value
24471 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24472 authenticated as a client.
24473
24474
24475 .option command_timeout smtp time 5m
24476 This sets a timeout for receiving a response to an SMTP command that has been
24477 sent out. It is also used when waiting for the initial banner line from the
24478 remote host. Its value must not be zero.
24479
24480
24481 .option connect_timeout smtp time 5m
24482 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24483 to a remote host. A setting of zero allows the system timeout (typically
24484 several minutes) to act. To have any effect, the value of this option must be
24485 less than the system timeout. However, it has been observed that on some
24486 systems there is no system timeout, which is why the default value for this
24487 option is 5 minutes, a value recommended by RFC 1123.
24488
24489
24490 .option connection_max_messages smtp integer 500
24491 .cindex "SMTP" "passed connection"
24492 .cindex "SMTP" "multiple deliveries"
24493 .cindex "multiple SMTP deliveries"
24494 This controls the maximum number of separate message deliveries that are sent
24495 over a single TCP/IP connection. If the value is zero, there is no limit.
24496 For testing purposes, this value can be overridden by the &%-oB%& command line
24497 option.
24498
24499
24500 .option dane_require_tls_ciphers smtp string&!! unset
24501 .cindex "TLS" "requiring specific ciphers for DANE"
24502 .cindex "cipher" "requiring specific"
24503 .cindex DANE "TLS ciphers"
24504 This option may be used to override &%tls_require_ciphers%& for connections
24505 where DANE has been determined to be in effect.
24506 If not set, then &%tls_require_ciphers%& will be used.
24507 Normal SMTP delivery is not able to make strong demands of TLS cipher
24508 configuration, because delivery will fall back to plaintext.  Once DANE has
24509 been determined to be in effect, there is no plaintext fallback and making the
24510 TLS cipherlist configuration stronger will increase security, rather than
24511 counter-intuitively decreasing it.
24512 If the option expands to be empty or is forced to fail, then it will
24513 be treated as unset and &%tls_require_ciphers%& will be used instead.
24514
24515
24516 .option data_timeout smtp time 5m
24517 This sets a timeout for the transmission of each block in the data portion of
24518 the message. As a result, the overall timeout for a message depends on the size
24519 of the message. Its value must not be zero. See also &%final_timeout%&.
24520
24521
24522 .option dkim_canon smtp string&!! unset
24523 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24524 .option dkim_domain smtp string list&!! unset
24525 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24526 .option dkim_hash smtp string&!! sha256
24527 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24528 .option dkim_identity smtp string&!! unset
24529 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24530 .option dkim_private_key smtp string&!! unset
24531 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24532 .option dkim_selector smtp string&!! unset
24533 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24534 .option dkim_strict smtp string&!! unset
24535 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24536 .option dkim_sign_headers smtp string&!! "per RFC"
24537 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24538 .option dkim_timestamps smtp string&!! unset
24539 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24540
24541
24542 .option delay_after_cutoff smtp boolean true
24543 .cindex "final cutoff" "retries, controlling"
24544 .cindex retry "final cutoff"
24545 This option controls what happens when all remote IP addresses for a given
24546 domain have been inaccessible for so long that they have passed their retry
24547 cutoff times.
24548
24549 In the default state, if the next retry time has not been reached for any of
24550 them, the address is bounced without trying any deliveries. In other words,
24551 Exim delays retrying an IP address after the final cutoff time until a new
24552 retry time is reached, and can therefore bounce an address without ever trying
24553 a delivery, when machines have been down for a long time. Some people are
24554 unhappy at this prospect, so...
24555
24556 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24557 addresses are past their final cutoff time, Exim tries to deliver to those
24558 IP addresses that have not been tried since the message arrived. If there are
24559 none, of if they all fail, the address is bounced. In other words, it does not
24560 delay when a new message arrives, but immediately tries those expired IP
24561 addresses that haven't been tried since the message arrived. If there is a
24562 continuous stream of messages for the dead hosts, unsetting
24563 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24564 to them.
24565
24566
24567 .option dns_qualify_single smtp boolean true
24568 If the &%hosts%& or &%fallback_hosts%& option is being used,
24569 and the &%gethostbyname%& option is false,
24570 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24571 in chapter &<<CHAPdnslookup>>& for more details.
24572
24573
24574 .option dns_search_parents smtp boolean false
24575 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24576 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24577 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24578 details.
24579
24580
24581 .option dnssec_request_domains smtp "domain list&!!" *
24582 .cindex "MX record" "security"
24583 .cindex "DNSSEC" "MX lookup"
24584 .cindex "security" "MX lookup"
24585 .cindex "DNS" "DNSSEC"
24586 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24587 the dnssec request bit set. Setting this transport option is only useful if the
24588 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24589 router option.
24590
24591
24592
24593 .option dnssec_require_domains smtp "domain list&!!" unset
24594 .cindex "MX record" "security"
24595 .cindex "DNSSEC" "MX lookup"
24596 .cindex "security" "MX lookup"
24597 .cindex "DNS" "DNSSEC"
24598 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24599 the dnssec request bit set.  Setting this transport option is only
24600 useful if the transport overrides or sets the host names. See the
24601 &%dnssec_require_domains%& router option.
24602
24603
24604
24605 .option dscp smtp string&!! unset
24606 .cindex "DCSP" "outbound"
24607 This option causes the DSCP value associated with a socket to be set to one
24608 of a number of fixed strings or to numeric value.
24609 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24610 Common values include &`throughput`&, &`mincost`&, and on newer systems
24611 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24612
24613 The outbound packets from Exim will be marked with this value in the header
24614 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24615 that these values will have any effect, not be stripped by networking
24616 equipment, or do much of anything without cooperation with your Network
24617 Engineer and those of all network operators between the source and destination.
24618
24619
24620 .option fallback_hosts smtp "string list" unset
24621 .cindex "fallback" "hosts specified on transport"
24622 String expansion is not applied to this option. The argument must be a
24623 colon-separated list of host names or IP addresses, optionally also including
24624 port numbers, though the separator can be changed, as described in section
24625 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24626 item in a &%route_list%& setting for the &(manualroute)& router, as described
24627 in section &<<SECTformatonehostitem>>&.
24628
24629 Fallback hosts can also be specified on routers, which associate them with the
24630 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24631 &%fallback_hosts%& specified on the transport is used only if the address does
24632 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24633 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24634 However, &%hosts_randomize%& does apply to fallback host lists.
24635
24636 If Exim is unable to deliver to any of the hosts for a particular address, and
24637 the errors are not permanent rejections, the address is put on a separate
24638 transport queue with its host list replaced by the fallback hosts, unless the
24639 address was routed via MX records and the current host was in the original MX
24640 list. In that situation, the fallback host list is not used.
24641
24642 Once normal deliveries are complete, the fallback queue is delivered by
24643 re-running the same transports with the new host lists. If several failing
24644 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24645 copy of the message is sent.
24646
24647 The resolution of the host names on the fallback list is controlled by the
24648 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24649 both to cases when the host list comes with the address and when it is taken
24650 from &%hosts%&. This option provides a &"use a smart host only if delivery
24651 fails"& facility.
24652
24653
24654 .option final_timeout smtp time 10m
24655 This is the timeout that applies while waiting for the response to the final
24656 line containing just &"."& that terminates a message. Its value must not be
24657 zero.
24658
24659 .option gethostbyname smtp boolean false
24660 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24661 being used, names are looked up using &[gethostbyname()]&
24662 (or &[getipnodebyname()]& when available)
24663 instead of using the DNS. Of course, that function may in fact use the DNS, but
24664 it may also consult other sources of information such as &_/etc/hosts_&.
24665
24666 .option gnutls_compat_mode smtp boolean unset
24667 This option controls whether GnuTLS is used in compatibility mode in an Exim
24668 server. This reduces security slightly, but improves interworking with older
24669 implementations of TLS.
24670
24671 .option helo_data smtp string&!! "see below"
24672 .cindex "HELO" "argument, setting"
24673 .cindex "EHLO" "argument, setting"
24674 .cindex "LHLO argument setting"
24675 The value of this option is expanded after a connection to a another host has
24676 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24677 command that starts the outgoing SMTP or LMTP session. The default value of the
24678 option is:
24679 .code
24680 $primary_hostname
24681 .endd
24682 During the expansion, the variables &$host$& and &$host_address$& are set to
24683 the identity of the remote host, and the variables &$sending_ip_address$& and
24684 &$sending_port$& are set to the local IP address and port number that are being
24685 used. These variables can be used to generate different values for different
24686 servers or different local IP addresses. For example, if you want the string
24687 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24688 interface address, you could use this:
24689 .code
24690 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24691   {$primary_hostname}}
24692 .endd
24693 The use of &%helo_data%& applies both to sending messages and when doing
24694 callouts.
24695
24696 .option hosts smtp "string list&!!" unset
24697 Hosts are associated with an address by a router such as &(dnslookup)&, which
24698 finds the hosts by looking up the address domain in the DNS, or by
24699 &(manualroute)&, which has lists of hosts in its configuration. However,
24700 email addresses can be passed to the &(smtp)& transport by any router, and not
24701 all of them can provide an associated list of hosts.
24702
24703 The &%hosts%& option specifies a list of hosts to be used if the address being
24704 processed does not have any hosts associated with it. The hosts specified by
24705 &%hosts%& are also used, whether or not the address has its own hosts, if
24706 &%hosts_override%& is set.
24707
24708 The string is first expanded, before being interpreted as a colon-separated
24709 list of host names or IP addresses, possibly including port numbers. The
24710 separator may be changed to something other than colon, as described in section
24711 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24712 item in a &%route_list%& setting for the &(manualroute)& router, as described
24713 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24714 of the &(manualroute)& router is not available here.
24715
24716 If the expansion fails, delivery is deferred. Unless the failure was caused by
24717 the inability to complete a lookup, the error is logged to the panic log as
24718 well as the main log. Host names are looked up either by searching directly for
24719 address records in the DNS or by calling &[gethostbyname()]& (or
24720 &[getipnodebyname()]& when available), depending on the setting of the
24721 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24722 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24723 address are used.
24724
24725 During delivery, the hosts are tried in order, subject to their retry status,
24726 unless &%hosts_randomize%& is set.
24727
24728
24729 .option hosts_avoid_esmtp smtp "host list&!!" unset
24730 .cindex "ESMTP, avoiding use of"
24731 .cindex "HELO" "forcing use of"
24732 .cindex "EHLO" "avoiding use of"
24733 .cindex "PIPELINING" "avoiding the use of"
24734 This option is for use with broken hosts that announce ESMTP facilities (for
24735 example, PIPELINING) and then fail to implement them properly. When a host
24736 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24737 start of the SMTP session. This means that it cannot use any of the ESMTP
24738 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24739
24740
24741 .option hosts_avoid_pipelining smtp "host list&!!" unset
24742 .cindex "PIPELINING" "avoiding the use of"
24743 Exim will not use the SMTP PIPELINING extension when delivering to any host
24744 that matches this list, even if the server host advertises PIPELINING support.
24745
24746 .new
24747 .option hosts_pipe_connect smtp "host list&!!" unset
24748 .cindex "pipelining" "early connection"
24749 .cindex "pipelining" PIPE_CONNECT
24750 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24751 this option controls which to hosts the facility watched for
24752 and recorded, and used for subsequent connections.
24753
24754 The retry hints database is used for the record,
24755 and records are subject to the &%retry_data_expire%& option.
24756 When used, the pipelining saves on roundtrip times.
24757 It also turns SMTP into a client-first protocol
24758 so combines well with TCP Fast Open.
24759
24760 See also the &%pipelining_connect_advertise_hosts%& main option.
24761
24762 Note:
24763 When the facility is used, the transport &%helo_data%& option
24764 will be expanded before the &$sending_ip_address$& variable
24765 is filled in.
24766 A check is made for the use of that variable, without the
24767 presence of a &"def:"& test on it, but suitably complex coding
24768 can avoid the check and produce unexpected results.
24769 You have been warned.
24770 .wen
24771
24772
24773 .option hosts_avoid_tls smtp "host list&!!" unset
24774 .cindex "TLS" "avoiding for certain hosts"
24775 Exim will not try to start a TLS session when delivering to any host that
24776 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24777
24778 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24779 .cindex "TLS" "avoiding for certain hosts"
24780 Exim will not try to start a TLS session for a verify callout,
24781 or when delivering in cutthrough mode,
24782 to any host that matches this list.
24783
24784
24785 .option hosts_max_try smtp integer 5
24786 .cindex "host" "maximum number to try"
24787 .cindex "limit" "number of hosts tried"
24788 .cindex "limit" "number of MX tried"
24789 .cindex "MX record" "maximum tried"
24790 This option limits the number of IP addresses that are tried for any one
24791 delivery in cases where there are temporary delivery errors. Section
24792 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24793
24794
24795 .option hosts_max_try_hardlimit smtp integer 50
24796 This is an additional check on the maximum number of IP addresses that Exim
24797 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24798 why it exists.
24799
24800
24801
24802 .option hosts_nopass_tls smtp "host list&!!" unset
24803 .cindex "TLS" "passing connection"
24804 .cindex "multiple SMTP deliveries"
24805 .cindex "TLS" "multiple message deliveries"
24806 For any host that matches this list, a connection on which a TLS session has
24807 been started will not be passed to a new delivery process for sending another
24808 message on the same connection. See section &<<SECTmulmessam>>& for an
24809 explanation of when this might be needed.
24810
24811 .new
24812 .option hosts_noproxy_tls smtp "host list&!!" unset
24813 .cindex "TLS" "passing connection"
24814 .cindex "multiple SMTP deliveries"
24815 .cindex "TLS" "multiple message deliveries"
24816 For any host that matches this list, a TLS session which has
24817 been started will not be passed to a new delivery process for sending another
24818 message on the same session.
24819 .wen
24820
24821 The traditional implementation closes down TLS and re-starts it in the new
24822 process, on the same open TCP connection, for each successive message
24823 sent.  If permitted by this option a pipe to to the new process is set up
24824 instead, and the original process maintains the TLS connection and proxies
24825 the SMTP connection from and to the new process and any subsequents.
24826 The new process has no access to TLS information, so cannot include it in
24827 logging.
24828
24829
24830
24831 .option hosts_override smtp boolean false
24832 If this option is set and the &%hosts%& option is also set, any hosts that are
24833 attached to the address are ignored, and instead the hosts specified by the
24834 &%hosts%& option are always used. This option does not apply to
24835 &%fallback_hosts%&.
24836
24837
24838 .option hosts_randomize smtp boolean false
24839 .cindex "randomized host list"
24840 .cindex "host" "list of; randomized"
24841 .cindex "fallback" "randomized hosts"
24842 If this option is set, and either the list of hosts is taken from the
24843 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24844 were not obtained from MX records (this includes fallback hosts from the
24845 router), and were not randomized by the router, the order of trying the hosts
24846 is randomized each time the transport runs. Randomizing the order of a host
24847 list can be used to do crude load sharing.
24848
24849 When &%hosts_randomize%& is true, a host list may be split into groups whose
24850 order is separately randomized. This makes it possible to set up MX-like
24851 behaviour. The boundaries between groups are indicated by an item that is just
24852 &`+`& in the host list. For example:
24853 .code
24854 hosts = host1:host2:host3:+:host4:host5
24855 .endd
24856 The order of the first three hosts and the order of the last two hosts is
24857 randomized for each use, but the first three always end up before the last two.
24858 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24859
24860 .option hosts_require_auth smtp "host list&!!" unset
24861 .cindex "authentication" "required by client"
24862 This option provides a list of servers for which authentication must succeed
24863 before Exim will try to transfer a message. If authentication fails for
24864 servers which are not in this list, Exim tries to send unauthenticated. If
24865 authentication fails for one of these servers, delivery is deferred. This
24866 temporary error is detectable in the retry rules, so it can be turned into a
24867 hard failure if required. See also &%hosts_try_auth%&, and chapter
24868 &<<CHAPSMTPAUTH>>& for details of authentication.
24869
24870
24871 .option hosts_request_ocsp smtp "host list&!!" *
24872 .cindex "TLS" "requiring for certain servers"
24873 Exim will request a Certificate Status on a
24874 TLS session for any host that matches this list.
24875 &%tls_verify_certificates%& should also be set for the transport.
24876
24877 .option hosts_require_dane smtp "host list&!!" unset
24878 .cindex DANE "transport options"
24879 .cindex DANE "requiring for certain servers"
24880 If built with DANE support, Exim  will require that a DNSSEC-validated
24881 TLSA record is present for any host matching the list,
24882 and that a DANE-verified TLS connection is made. See
24883 the &%dnssec_request_domains%& router and transport options.
24884 There will be no fallback to in-clear communication.
24885 See section &<<SECDANE>>&.
24886
24887 .option hosts_require_ocsp smtp "host list&!!" unset
24888 .cindex "TLS" "requiring for certain servers"
24889 Exim will request, and check for a valid Certificate Status being given, on a
24890 TLS session for any host that matches this list.
24891 &%tls_verify_certificates%& should also be set for the transport.
24892
24893 .option hosts_require_tls smtp "host list&!!" unset
24894 .cindex "TLS" "requiring for certain servers"
24895 Exim will insist on using a TLS session when delivering to any host that
24896 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24897 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24898 incoming messages, use an appropriate ACL.
24899
24900 .option hosts_try_auth smtp "host list&!!" unset
24901 .cindex "authentication" "optional in client"
24902 This option provides a list of servers to which, provided they announce
24903 authentication support, Exim will attempt to authenticate as a client when it
24904 connects. If authentication fails, Exim will try to transfer the message
24905 unauthenticated. See also &%hosts_require_auth%&, and chapter
24906 &<<CHAPSMTPAUTH>>& for details of authentication.
24907
24908 .option hosts_try_chunking smtp "host list&!!" *
24909 .cindex CHUNKING "enabling, in client"
24910 .cindex BDAT "SMTP command"
24911 .cindex "RFC 3030" "CHUNKING"
24912 This option provides a list of servers to which, provided they announce
24913 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24914 BDAT will not be used in conjunction with a transport filter.
24915
24916 .option hosts_try_dane smtp "host list&!!" *
24917 .cindex DANE "transport options"
24918 .cindex DANE "attempting for certain servers"
24919 If built with DANE support, Exim  will require that a DNSSEC-validated
24920 TLSA record is present for any host matching the list,
24921 and that a DANE-verified TLS connection is made. See
24922 the &%dnssec_request_domains%& router and transport options.
24923 There will be no fallback to in-clear communication.
24924 See section &<<SECDANE>>&.
24925
24926 .option hosts_try_fastopen smtp "host list&!!" *
24927 .cindex "fast open, TCP" "enabling, in client"
24928 .cindex "TCP Fast Open" "enabling, in client"
24929 .cindex "RFC 7413" "TCP Fast Open"
24930 This option provides a list of servers to which, provided
24931 the facility is supported by this system, Exim will attempt to
24932 perform a TCP Fast Open.
24933 No data is sent on the SYN segment but, if the remote server also
24934 supports the facility, it can send its SMTP banner immediately after
24935 the SYN,ACK segment.  This can save up to one round-trip time.
24936
24937 The facility is only active for previously-contacted servers,
24938 as the initiator must present a cookie in the SYN segment.
24939
24940 On (at least some) current Linux distributions the facility must be enabled
24941 in the kernel by the sysadmin before the support is usable.
24942 There is no option for control of the server side; if the system supports
24943 it it is always enabled.  Note that lengthy operations in the connect ACL,
24944 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24945
24946 .option hosts_try_prdr smtp "host list&!!" *
24947 .cindex "PRDR" "enabling, optional in client"
24948 This option provides a list of servers to which, provided they announce
24949 PRDR support, Exim will attempt to negotiate PRDR
24950 for multi-recipient messages.
24951 The option can usually be left as default.
24952
24953 .option interface smtp "string list&!!" unset
24954 .cindex "bind IP address"
24955 .cindex "IP address" "binding"
24956 .vindex "&$host$&"
24957 .vindex "&$host_address$&"
24958 This option specifies which interface to bind to when making an outgoing SMTP
24959 call. The value is an IP address, not an interface name such as
24960 &`eth0`&. Do not confuse this with the interface address that was used when a
24961 message was received, which is in &$received_ip_address$&, formerly known as
24962 &$interface_address$&. The name was changed to minimize confusion with the
24963 outgoing interface address. There is no variable that contains an outgoing
24964 interface address because, unless it is set by this option, its value is
24965 unknown.
24966
24967 During the expansion of the &%interface%& option the variables &$host$& and
24968 &$host_address$& refer to the host to which a connection is about to be made
24969 during the expansion of the string. Forced expansion failure, or an empty
24970 string result causes the option to be ignored. Otherwise, after expansion, the
24971 string must be a list of IP addresses, colon-separated by default, but the
24972 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24973 For example:
24974 .code
24975 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24976 .endd
24977 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24978 connection. If none of them are the correct type, the option is ignored. If
24979 &%interface%& is not set, or is ignored, the system's IP functions choose which
24980 interface to use if the host has more than one.
24981
24982
24983 .option keepalive smtp boolean true
24984 .cindex "keepalive" "on outgoing connection"
24985 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24986 connections. When set, it causes the kernel to probe idle connections
24987 periodically, by sending packets with &"old"& sequence numbers. The other end
24988 of the connection should send a acknowledgment if the connection is still okay
24989 or a reset if the connection has been aborted. The reason for doing this is
24990 that it has the beneficial effect of freeing up certain types of connection
24991 that can get stuck when the remote host is disconnected without tidying up the
24992 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24993 unreachable hosts.
24994
24995
24996 .option lmtp_ignore_quota smtp boolean false
24997 .cindex "LMTP" "ignoring quota errors"
24998 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24999 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25000 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25001
25002 .option max_rcpt smtp integer 100
25003 .cindex "RCPT" "maximum number of outgoing"
25004 This option limits the number of RCPT commands that are sent in a single
25005 SMTP message transaction. Each set of addresses is treated independently, and
25006 so can cause parallel connections to the same host if &%remote_max_parallel%&
25007 permits this.
25008
25009
25010 .option multi_domain smtp boolean&!! true
25011 .vindex "&$domain$&"
25012 When this option is set, the &(smtp)& transport can handle a number of
25013 addresses containing a mixture of different domains provided they all resolve
25014 to the same list of hosts. Turning the option off restricts the transport to
25015 handling only one domain at a time. This is useful if you want to use
25016 &$domain$& in an expansion for the transport, because it is set only when there
25017 is a single domain involved in a remote delivery.
25018
25019 It is expanded per-address and can depend on any of
25020 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25021 &$host$&, &$host_address$& and &$host_port$&.
25022
25023 .option port smtp string&!! "see below"
25024 .cindex "port" "sending TCP/IP"
25025 .cindex "TCP/IP" "setting outgoing port"
25026 This option specifies the TCP/IP port on the server to which Exim connects.
25027 &*Note:*& Do not confuse this with the port that was used when a message was
25028 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25029 The name was changed to minimize confusion with the outgoing port. There is no
25030 variable that contains an outgoing port.
25031
25032 If the value of this option begins with a digit it is taken as a port number;
25033 otherwise it is looked up using &[getservbyname()]&. The default value is
25034 normally &"smtp"&,
25035 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25036 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25037 If the expansion fails, or if a port number cannot be found, delivery
25038 is deferred.
25039
25040 Note that at least one Linux distribution has been seen failing
25041 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25042
25043
25044
25045 .option protocol smtp string smtp
25046 .cindex "LMTP" "over TCP/IP"
25047 .cindex "ssmtp protocol" "outbound"
25048 .cindex "TLS" "SSL-on-connect outbound"
25049 .vindex "&$port$&"
25050 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25051 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25052 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25053 deliveries into closed message stores. Exim also has support for running LMTP
25054 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25055
25056 If this option is set to &"smtps"&, the default value for the &%port%& option
25057 changes to &"smtps"&, and the transport initiates TLS immediately after
25058 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25059 The Internet standards bodies used to strongly discourage use of this mode,
25060 but as of RFC 8314 it is perferred over STARTTLS for message submission
25061 (as distinct from MTA-MTA communication).
25062
25063
25064 .option retry_include_ip_address smtp boolean&!! true
25065 Exim normally includes both the host name and the IP address in the key it
25066 constructs for indexing retry data after a temporary delivery failure. This
25067 means that when one of several IP addresses for a host is failing, it gets
25068 tried periodically (controlled by the retry rules), but use of the other IP
25069 addresses is not affected.
25070
25071 However, in some dialup environments hosts are assigned a different IP address
25072 each time they connect. In this situation the use of the IP address as part of
25073 the retry key leads to undesirable behaviour. Setting this option false causes
25074 Exim to use only the host name.
25075 Since it is expanded it can be made to depend on the host or domain.
25076
25077
25078 .option serialize_hosts smtp "host list&!!" unset
25079 .cindex "serializing connections"
25080 .cindex "host" "serializing connections"
25081 Because Exim operates in a distributed manner, if several messages for the same
25082 host arrive at around the same time, more than one simultaneous connection to
25083 the remote host can occur. This is not usually a problem except when there is a
25084 slow link between the hosts. In that situation it may be helpful to restrict
25085 Exim to one connection at a time. This can be done by setting
25086 &%serialize_hosts%& to match the relevant hosts.
25087
25088 .cindex "hints database" "serializing deliveries to a host"
25089 Exim implements serialization by means of a hints database in which a record is
25090 written whenever a process connects to one of the restricted hosts. The record
25091 is deleted when the connection is completed. Obviously there is scope for
25092 records to get left lying around if there is a system or program crash. To
25093 guard against this, Exim ignores any records that are more than six hours old.
25094
25095 If you set up this kind of serialization, you should also arrange to delete the
25096 relevant hints database whenever your system reboots. The names of the files
25097 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25098 may be one or two files, depending on the type of DBM in use. The same files
25099 are used for ETRN serialization.
25100
25101 See also the &%max_parallel%& generic transport option.
25102
25103
25104 .option size_addition smtp integer 1024
25105 .cindex "SMTP" "SIZE"
25106 .cindex "message" "size issue for transport filter"
25107 .cindex "size" "of message"
25108 .cindex "transport" "filter"
25109 .cindex "filter" "transport filter"
25110 If a remote SMTP server indicates that it supports the SIZE option of the
25111 MAIL command, Exim uses this to pass over the message size at the start of
25112 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25113 sends, to allow for headers and other text that may be added during delivery by
25114 configuration options or in a transport filter. It may be necessary to increase
25115 this if a lot of text is added to messages.
25116
25117 Alternatively, if the value of &%size_addition%& is set negative, it disables
25118 the use of the SIZE option altogether.
25119
25120
25121 .option socks_proxy smtp string&!! unset
25122 .cindex proxy SOCKS
25123 This option enables use of SOCKS proxies for connections made by the
25124 transport.  For details see section &<<SECTproxySOCKS>>&.
25125
25126
25127 .option tls_certificate smtp string&!! unset
25128 .cindex "TLS" "client certificate, location of"
25129 .cindex "certificate" "client, location of"
25130 .vindex "&$host$&"
25131 .vindex "&$host_address$&"
25132 The value of this option must be the absolute path to a file which contains the
25133 client's certificate, for possible use when sending a message over an encrypted
25134 connection. The values of &$host$& and &$host_address$& are set to the name and
25135 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25136 details of TLS.
25137
25138 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25139 certificate when sending messages as a client. The global option of the same
25140 name specifies the certificate for Exim as a server; it is not automatically
25141 assumed that the same certificate should be used when Exim is operating as a
25142 client.
25143
25144
25145 .option tls_crl smtp string&!! unset
25146 .cindex "TLS" "client certificate revocation list"
25147 .cindex "certificate" "revocation list for client"
25148 This option specifies a certificate revocation list. The expanded value must
25149 be the name of a file that contains a CRL in PEM format.
25150
25151
25152 .option tls_dh_min_bits smtp integer 1024
25153 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25154 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25155 key agreement is negotiated, the server will provide a large prime number
25156 for use.  This option establishes the minimum acceptable size of that number.
25157 If the parameter offered by the server is too small, then the TLS handshake
25158 will fail.
25159
25160 Only supported when using GnuTLS.
25161
25162
25163 .option tls_privatekey smtp string&!! unset
25164 .cindex "TLS" "client private key, location of"
25165 .vindex "&$host$&"
25166 .vindex "&$host_address$&"
25167 The value of this option must be the absolute path to a file which contains the
25168 client's private key. This is used when sending a message over an encrypted
25169 connection using a client certificate. The values of &$host$& and
25170 &$host_address$& are set to the name and address of the server during the
25171 expansion. If this option is unset, or the expansion is forced to fail, or the
25172 result is an empty string, the private key is assumed to be in the same file as
25173 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25174
25175
25176 .option tls_require_ciphers smtp string&!! unset
25177 .cindex "TLS" "requiring specific ciphers"
25178 .cindex "cipher" "requiring specific"
25179 .vindex "&$host$&"
25180 .vindex "&$host_address$&"
25181 The value of this option must be a list of permitted cipher suites, for use
25182 when setting up an outgoing encrypted connection. (There is a global option of
25183 the same name for controlling incoming connections.) The values of &$host$& and
25184 &$host_address$& are set to the name and address of the server during the
25185 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25186 is used in different ways by OpenSSL and GnuTLS (see sections
25187 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25188 ciphers is a preference order.
25189
25190
25191
25192 .option tls_sni smtp string&!! unset
25193 .cindex "TLS" "Server Name Indication"
25194 .vindex "&$tls_sni$&"
25195 If this option is set then it sets the $tls_out_sni variable and causes any
25196 TLS session to pass this value as the Server Name Indication extension to
25197 the remote side, which can be used by the remote side to select an appropriate
25198 certificate and private key for the session.
25199
25200 See &<<SECTtlssni>>& for more information.
25201
25202 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25203 TLS extensions.
25204
25205
25206
25207
25208 .option tls_tempfail_tryclear smtp boolean true
25209 .cindex "4&'xx'& responses" "to STARTTLS"
25210 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25211 setting up a TLS session, this option determines whether or not Exim should try
25212 to deliver the message unencrypted. If it is set false, delivery to the
25213 current host is deferred; if there are other hosts, they are tried. If this
25214 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25215 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25216 TLS negotiation fails, Exim closes the current connection (because it is in an
25217 unknown state), opens a new one to the same host, and then tries the delivery
25218 in clear.
25219
25220
25221 .option tls_try_verify_hosts smtp "host list&!!" *
25222 .cindex "TLS" "server certificate verification"
25223 .cindex "certificate" "verification of server"
25224 This option gives a list of hosts for which, on encrypted connections,
25225 certificate verification will be tried but need not succeed.
25226 The &%tls_verify_certificates%& option must also be set.
25227 Note that unless the host is in this list
25228 TLS connections will be denied to hosts using self-signed certificates
25229 when &%tls_verify_certificates%& is matched.
25230 The &$tls_out_certificate_verified$& variable is set when
25231 certificate verification succeeds.
25232
25233
25234 .option tls_verify_cert_hostnames smtp "host list&!!" *
25235 .cindex "TLS" "server certificate hostname verification"
25236 .cindex "certificate" "verification of server"
25237 This option give a list of hosts for which,
25238 while verifying the server certificate,
25239 checks will be included on the host name
25240 (note that this will generally be the result of a DNS MX lookup)
25241 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25242 limited to being the initial component of a 3-or-more component FQDN.
25243
25244 There is no equivalent checking on client certificates.
25245
25246
25247 .option tls_verify_certificates smtp string&!! system
25248 .cindex "TLS" "server certificate verification"
25249 .cindex "certificate" "verification of server"
25250 .vindex "&$host$&"
25251 .vindex "&$host_address$&"
25252 The value of this option must be either the
25253 word "system"
25254 or the absolute path to
25255 a file or directory containing permitted certificates for servers,
25256 for use when setting up an encrypted connection.
25257
25258 The "system" value for the option will use a location compiled into the SSL library.
25259 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25260 is taken as empty and an explicit location
25261 must be specified.
25262
25263 The use of a directory for the option value is not available for GnuTLS versions
25264 preceding 3.3.6 and a single file must be used.
25265
25266 With OpenSSL the certificates specified
25267 explicitly
25268 either by file or directory
25269 are added to those given by the system default location.
25270
25271 The values of &$host$& and
25272 &$host_address$& are set to the name and address of the server during the
25273 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25274
25275 For back-compatibility,
25276 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25277 (a single-colon empty list counts as being set)
25278 and certificate verification fails the TLS connection is closed.
25279
25280
25281 .option tls_verify_hosts smtp "host list&!!" unset
25282 .cindex "TLS" "server certificate verification"
25283 .cindex "certificate" "verification of server"
25284 This option gives a list of hosts for which, on encrypted connections,
25285 certificate verification must succeed.
25286 The &%tls_verify_certificates%& option must also be set.
25287 If both this option and &%tls_try_verify_hosts%& are unset
25288 operation is as if this option selected all hosts.
25289
25290 .option utf8_downconvert smtp integer!! unset
25291 .cindex utf8 "address downconversion"
25292 .cindex i18n "utf8 address downconversion"
25293 If built with internationalization support,
25294 this option controls conversion of UTF-8 in message addresses
25295 to a-label form.
25296 For details see section &<<SECTi18nMTA>>&.
25297
25298
25299
25300
25301 .section "How the limits for the number of hosts to try are used" &&&
25302          "SECTvalhosmax"
25303 .cindex "host" "maximum number to try"
25304 .cindex "limit" "hosts; maximum number tried"
25305 There are two options that are concerned with the number of hosts that are
25306 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25307 &%hosts_max_try_hardlimit%&.
25308
25309
25310 The &%hosts_max_try%& option limits the number of hosts that are tried
25311 for a single delivery. However, despite the term &"host"& in its name, the
25312 option actually applies to each IP address independently. In other words, a
25313 multihomed host is treated as several independent hosts, just as it is for
25314 retrying.
25315
25316 Many of the larger ISPs have multiple MX records which often point to
25317 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25318 created as a result of routing one of these domains.
25319
25320 Trying every single IP address on such a long list does not seem sensible; if
25321 several at the top of the list fail, it is reasonable to assume there is some
25322 problem that is likely to affect all of them. Roughly speaking, the value of
25323 &%hosts_max_try%& is the maximum number that are tried before deferring the
25324 delivery. However, the logic cannot be quite that simple.
25325
25326 Firstly, IP addresses that are skipped because their retry times have not
25327 arrived do not count, and in addition, addresses that are past their retry
25328 limits are also not counted, even when they are tried. This means that when
25329 some IP addresses are past their retry limits, more than the value of
25330 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25331 that all IP addresses are considered before timing out an email address (but
25332 see below for an exception).
25333
25334 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25335 list to see if there is a subsequent host with a different (higher valued) MX.
25336 If there is, that host is considered next, and the current IP address is used
25337 but not counted. This behaviour helps in the case of a domain with a retry rule
25338 that hardly ever delays any hosts, as is now explained:
25339
25340 Consider the case of a long list of hosts with one MX value, and a few with a
25341 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25342 hosts at the top of the list are tried at first. With the default retry rule,
25343 which specifies increasing retry times, the higher MX hosts are eventually
25344 tried when those at the top of the list are skipped because they have not
25345 reached their retry times.
25346
25347 However, it is common practice to put a fixed short retry time on domains for
25348 large ISPs, on the grounds that their servers are rarely down for very long.
25349 Unfortunately, these are exactly the domains that tend to resolve to long lists
25350 of hosts. The short retry time means that the lowest MX hosts are tried every
25351 time. The attempts may be in a different order because of random sorting, but
25352 without the special MX check, the higher MX hosts would never be tried until
25353 all the lower MX hosts had timed out (which might be several days), because
25354 there are always some lower MX hosts that have reached their retry times. With
25355 the special check, Exim considers at least one IP address from each MX value at
25356 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25357 reached.
25358
25359 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25360 particular, Exim normally eventually tries all the IP addresses before timing
25361 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25362 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25363 been set up with hundreds of IP addresses for some domains. It can
25364 take a very long time indeed for an address to time out in these cases.
25365
25366 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25367 Exim never tries more than this number of IP addresses; if it hits this limit
25368 and they are all timed out, the email address is bounced, even though not all
25369 possible IP addresses have been tried.
25370 .ecindex IIDsmttra1
25371 .ecindex IIDsmttra2
25372
25373
25374
25375
25376
25377 . ////////////////////////////////////////////////////////////////////////////
25378 . ////////////////////////////////////////////////////////////////////////////
25379
25380 .chapter "Address rewriting" "CHAPrewrite"
25381 .scindex IIDaddrew "rewriting" "addresses"
25382 There are some circumstances in which Exim automatically rewrites domains in
25383 addresses. The two most common are when an address is given without a domain
25384 (referred to as an &"unqualified address"&) or when an address contains an
25385 abbreviated domain that is expanded by DNS lookup.
25386
25387 Unqualified envelope addresses are accepted only for locally submitted
25388 messages, or for messages that are received from hosts matching
25389 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25390 appropriate. Unqualified addresses in header lines are qualified if they are in
25391 locally submitted messages, or messages from hosts that are permitted to send
25392 unqualified envelope addresses. Otherwise, unqualified addresses in header
25393 lines are neither qualified nor rewritten.
25394
25395 One situation in which Exim does &'not'& automatically rewrite a domain is
25396 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25397 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25398 do this. The new RFCs do not contain this suggestion.
25399
25400
25401 .section "Explicitly configured address rewriting" "SECID147"
25402 This chapter describes the rewriting rules that can be used in the
25403 main rewrite section of the configuration file, and also in the generic
25404 &%headers_rewrite%& option that can be set on any transport.
25405
25406 Some people believe that configured address rewriting is a Mortal Sin.
25407 Others believe that life is not possible without it. Exim provides the
25408 facility; you do not have to use it.
25409
25410 The main rewriting rules that appear in the &"rewrite"& section of the
25411 configuration file are applied to addresses in incoming messages, both envelope
25412 addresses and addresses in header lines. Each rule specifies the types of
25413 address to which it applies.
25414
25415 Whether or not addresses in header lines are rewritten depends on the origin of
25416 the headers and the type of rewriting. Global rewriting, that is, rewriting
25417 rules from the rewrite section of the configuration file, is applied only to
25418 those headers that were received with the message. Header lines that are added
25419 by ACLs or by a system filter or by individual routers or transports (which
25420 are specific to individual recipient addresses) are not rewritten by the global
25421 rules.
25422
25423 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25424 applies all headers except those added by routers and transports. That is, as
25425 well as the headers that were received with the message, it also applies to
25426 headers that were added by an ACL or a system filter.
25427
25428
25429 In general, rewriting addresses from your own system or domain has some
25430 legitimacy. Rewriting other addresses should be done only with great care and
25431 in special circumstances. The author of Exim believes that rewriting should be
25432 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25433 Although it can sometimes be used as a routing tool, this is very strongly
25434 discouraged.
25435
25436 There are two commonly encountered circumstances where rewriting is used, as
25437 illustrated by these examples:
25438
25439 .ilist
25440 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25441 exchange mail with each other behind a firewall, but there is only a single
25442 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25443 &'hitch.fict.example'& when sending mail off-site.
25444 .next
25445 A host rewrites the local parts of its own users so that, for example,
25446 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25447 .endlist
25448
25449
25450
25451 .section "When does rewriting happen?" "SECID148"
25452 .cindex "rewriting" "timing of"
25453 .cindex "&ACL;" "rewriting addresses in"
25454 Configured address rewriting can take place at several different stages of a
25455 message's processing.
25456
25457 .vindex "&$sender_address$&"
25458 At the start of an ACL for MAIL, the sender address may have been rewritten
25459 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25460 ordinary rewrite rules have yet been applied. If, however, the sender address
25461 is verified in the ACL, it is rewritten before verification, and remains
25462 rewritten thereafter. The subsequent value of &$sender_address$& is the
25463 rewritten address. This also applies if sender verification happens in a
25464 RCPT ACL. Otherwise, when the sender address is not verified, it is
25465 rewritten as soon as a message's header lines have been received.
25466
25467 .vindex "&$domain$&"
25468 .vindex "&$local_part$&"
25469 Similarly, at the start of an ACL for RCPT, the current recipient's address
25470 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25471 rewrite rules have yet been applied to it. However, the behaviour is different
25472 from the sender address when a recipient is verified. The address is rewritten
25473 for the verification, but the rewriting is not remembered at this stage. The
25474 value of &$local_part$& and &$domain$& after verification are always the same
25475 as they were before (that is, they contain the unrewritten &-- except for
25476 SMTP-time rewriting &-- address).
25477
25478 As soon as a message's header lines have been received, all the envelope
25479 recipient addresses are permanently rewritten, and rewriting is also applied to
25480 the addresses in the header lines (if configured). This happens before adding
25481 any header lines that were specified in MAIL or RCPT ACLs, and
25482 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25483 before the DATA ACL and &[local_scan()]& functions are run.
25484
25485 When an address is being routed, either for delivery or for verification,
25486 rewriting is applied immediately to child addresses that are generated by
25487 redirection, unless &%no_rewrite%& is set on the router.
25488
25489 .cindex "envelope from"
25490 .cindex "envelope sender" "rewriting at transport time"
25491 .cindex "rewriting" "at transport time"
25492 .cindex "header lines" "rewriting at transport time"
25493 At transport time, additional rewriting of addresses in header lines can be
25494 specified by setting the generic &%headers_rewrite%& option on a transport.
25495 This option contains rules that are identical in form to those in the rewrite
25496 section of the configuration file. They are applied to the original message
25497 header lines and any that were added by ACLs or a system filter. They are not
25498 applied to header lines that are added by routers or the transport.
25499
25500 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25501 transport option. However, it is not possible to rewrite envelope recipients at
25502 transport time.
25503
25504
25505
25506
25507 .section "Testing the rewriting rules that apply on input" "SECID149"
25508 .cindex "rewriting" "testing"
25509 .cindex "testing" "rewriting"
25510 Exim's input rewriting configuration appears in a part of the runtime
25511 configuration file headed by &"begin rewrite"&. It can be tested by the
25512 &%-brw%& command line option. This takes an address (which can be a full RFC
25513 2822 address) as its argument. The output is a list of how the address would be
25514 transformed by the rewriting rules for each of the different places it might
25515 appear in an incoming message, that is, for each different header and for the
25516 envelope sender and recipient fields. For example,
25517 .code
25518 exim -brw ph10@exim.workshop.example
25519 .endd
25520 might produce the output
25521 .code
25522 sender: Philip.Hazel@exim.workshop.example
25523 from: Philip.Hazel@exim.workshop.example
25524 to: ph10@exim.workshop.example
25525 cc: ph10@exim.workshop.example
25526 bcc: ph10@exim.workshop.example
25527 reply-to: Philip.Hazel@exim.workshop.example
25528 env-from: Philip.Hazel@exim.workshop.example
25529 env-to: ph10@exim.workshop.example
25530 .endd
25531 which shows that rewriting has been set up for that address when used in any of
25532 the source fields, but not when it appears as a recipient address. At the
25533 present time, there is no equivalent way of testing rewriting rules that are
25534 set for a particular transport.
25535
25536
25537 .section "Rewriting rules" "SECID150"
25538 .cindex "rewriting" "rules"
25539 The rewrite section of the configuration file consists of lines of rewriting
25540 rules in the form
25541 .display
25542 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25543 .endd
25544 Rewriting rules that are specified for the &%headers_rewrite%& generic
25545 transport option are given as a colon-separated list. Each item in the list
25546 takes the same form as a line in the main rewriting configuration (except that
25547 any colons must be doubled, of course).
25548
25549 The formats of source patterns and replacement strings are described below.
25550 Each is terminated by white space, unless enclosed in double quotes, in which
25551 case normal quoting conventions apply inside the quotes. The flags are single
25552 characters which may appear in any order. Spaces and tabs between them are
25553 ignored.
25554
25555 For each address that could potentially be rewritten, the rules are scanned in
25556 order, and replacements for the address from earlier rules can themselves be
25557 replaced by later rules (but see the &"q"& and &"R"& flags).
25558
25559 The order in which addresses are rewritten is undefined, may change between
25560 releases, and must not be relied on, with one exception: when a message is
25561 received, the envelope sender is always rewritten first, before any header
25562 lines are rewritten. For example, the replacement string for a rewrite of an
25563 address in &'To:'& must not assume that the message's address in &'From:'& has
25564 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25565 that the envelope sender has already been rewritten.
25566
25567 .vindex "&$domain$&"
25568 .vindex "&$local_part$&"
25569 The variables &$local_part$& and &$domain$& can be used in the replacement
25570 string to refer to the address that is being rewritten. Note that lookup-driven
25571 rewriting can be done by a rule of the form
25572 .code
25573 *@*   ${lookup ...
25574 .endd
25575 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25576 refer to the address that is being rewritten.
25577
25578
25579 .section "Rewriting patterns" "SECID151"
25580 .cindex "rewriting" "patterns"
25581 .cindex "address list" "in a rewriting pattern"
25582 The source pattern in a rewriting rule is any item which may appear in an
25583 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25584 single-item address list, which means that it is expanded before being tested
25585 against the address. As always, if you use a regular expression as a pattern,
25586 you must take care to escape dollar and backslash characters, or use the &`\N`&
25587 facility to suppress string expansion within the regular expression.
25588
25589 Domains in patterns should be given in lower case. Local parts in patterns are
25590 case-sensitive. If you want to do case-insensitive matching of local parts, you
25591 can use a regular expression that starts with &`^(?i)`&.
25592
25593 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25594 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25595 depending on the type of match which occurred. These can be used in the
25596 replacement string to insert portions of the incoming address. &$0$& always
25597 refers to the complete incoming address. When a regular expression is used, the
25598 numerical variables are set from its capturing subexpressions. For other types
25599 of pattern they are set as follows:
25600
25601 .ilist
25602 If a local part or domain starts with an asterisk, the numerical variables
25603 refer to the character strings matched by asterisks, with &$1$& associated with
25604 the first asterisk, and &$2$& with the second, if present. For example, if the
25605 pattern
25606 .code
25607 *queen@*.fict.example
25608 .endd
25609 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25610 .code
25611 $0 = hearts-queen@wonderland.fict.example
25612 $1 = hearts-
25613 $2 = wonderland
25614 .endd
25615 Note that if the local part does not start with an asterisk, but the domain
25616 does, it is &$1$& that contains the wild part of the domain.
25617
25618 .next
25619 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25620 of the domain are placed in the next available numerical variables. Suppose,
25621 for example, that the address &'foo@bar.baz.example'& is processed by a
25622 rewriting rule of the form
25623 .display
25624 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25625 .endd
25626 and the key in the file that matches the domain is &`*.baz.example`&. Then
25627 .code
25628 $1 = foo
25629 $2 = bar
25630 $3 = baz.example
25631 .endd
25632 If the address &'foo@baz.example'& is looked up, this matches the same
25633 wildcard file entry, and in this case &$2$& is set to the empty string, but
25634 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25635 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25636 whole domain. For non-partial domain lookups, no numerical variables are set.
25637 .endlist
25638
25639
25640 .section "Rewriting replacements" "SECID152"
25641 .cindex "rewriting" "replacements"
25642 If the replacement string for a rule is a single asterisk, addresses that
25643 match the pattern and the flags are &'not'& rewritten, and no subsequent
25644 rewriting rules are scanned. For example,
25645 .code
25646 hatta@lookingglass.fict.example  *  f
25647 .endd
25648 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25649 &'From:'& headers.
25650
25651 .vindex "&$domain$&"
25652 .vindex "&$local_part$&"
25653 If the replacement string is not a single asterisk, it is expanded, and must
25654 yield a fully qualified address. Within the expansion, the variables
25655 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25656 Any letters they contain retain their original case &-- they are not lower
25657 cased. The numerical variables are set up according to the type of pattern that
25658 matched the address, as described above. If the expansion is forced to fail by
25659 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25660 current rule is abandoned, but subsequent rules may take effect. Any other
25661 expansion failure causes the entire rewriting operation to be abandoned, and an
25662 entry written to the panic log.
25663
25664
25665
25666 .section "Rewriting flags" "SECID153"
25667 There are three different kinds of flag that may appear on rewriting rules:
25668
25669 .ilist
25670 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25671 c, f, h, r, s, t.
25672 .next
25673 A flag that specifies rewriting at SMTP time: S.
25674 .next
25675 Flags that control the rewriting process: Q, q, R, w.
25676 .endlist
25677
25678 For rules that are part of the &%headers_rewrite%& generic transport option,
25679 E, F, T, and S are not permitted.
25680
25681
25682
25683 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25684          "SECID154"
25685 .cindex "rewriting" "flags"
25686 If none of the following flag letters, nor the &"S"& flag (see section
25687 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25688 and to both the sender and recipient fields of the envelope, whereas a
25689 transport-time rewriting rule just applies to all headers. Otherwise, the
25690 rewriting rule is skipped unless the relevant addresses are being processed.
25691 .display
25692 &`E`&       rewrite all envelope fields
25693 &`F`&       rewrite the envelope From field
25694 &`T`&       rewrite the envelope To field
25695 &`b`&       rewrite the &'Bcc:'& header
25696 &`c`&       rewrite the &'Cc:'& header
25697 &`f`&       rewrite the &'From:'& header
25698 &`h`&       rewrite all headers
25699 &`r`&       rewrite the &'Reply-To:'& header
25700 &`s`&       rewrite the &'Sender:'& header
25701 &`t`&       rewrite the &'To:'& header
25702 .endd
25703 "All headers" means all of the headers listed above that can be selected
25704 individually, plus their &'Resent-'& versions. It does not include
25705 other headers such as &'Subject:'& etc.
25706
25707 You should be particularly careful about rewriting &'Sender:'& headers, and
25708 restrict this to special known cases in your own domains.
25709
25710
25711 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25712 .cindex "SMTP" "rewriting malformed addresses"
25713 .cindex "RCPT" "rewriting argument of"
25714 .cindex "MAIL" "rewriting argument of"
25715 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25716 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25717 before any other processing; even before syntax checking. The pattern is
25718 required to be a regular expression, and it is matched against the whole of the
25719 data for the command, including any surrounding angle brackets.
25720
25721 .vindex "&$domain$&"
25722 .vindex "&$local_part$&"
25723 This form of rewrite rule allows for the handling of addresses that are not
25724 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25725 input). Because the input is not required to be a syntactically valid address,
25726 the variables &$local_part$& and &$domain$& are not available during the
25727 expansion of the replacement string. The result of rewriting replaces the
25728 original address in the MAIL or RCPT command.
25729
25730
25731 .section "Flags controlling the rewriting process" "SECID155"
25732 There are four flags which control the way the rewriting process works. These
25733 take effect only when a rule is invoked, that is, when the address is of the
25734 correct type (matches the flags) and matches the pattern:
25735
25736 .ilist
25737 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25738 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25739 absence of &"Q"& the rewritten address must always include a domain.
25740 .next
25741 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25742 even if no rewriting actually takes place because of a &"fail"& in the
25743 expansion. The &"q"& flag is not effective if the address is of the wrong type
25744 (does not match the flags) or does not match the pattern.
25745 .next
25746 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25747 address, up to ten times. It can be combined with the &"q"& flag, to stop
25748 rewriting once it fails to match (after at least one successful rewrite).
25749 .next
25750 .cindex "rewriting" "whole addresses"
25751 When an address in a header is rewritten, the rewriting normally applies only
25752 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25753 left unchanged. For example, rewriting might change
25754 .code
25755 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25756 .endd
25757 into
25758 .code
25759 From: Ford Prefect <prefectf@hitch.fict.example>
25760 .endd
25761 .cindex "RFC 2047"
25762 Sometimes there is a need to replace the whole address item, and this can be
25763 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25764 causes an address in a header line to be rewritten, the entire address is
25765 replaced, not just the working part. The replacement must be a complete RFC
25766 2822 address, including the angle brackets if necessary. If text outside angle
25767 brackets contains a character whose value is greater than 126 or less than 32
25768 (except for tab), the text is encoded according to RFC 2047. The character set
25769 is taken from &%headers_charset%&, which gets its default at build time.
25770
25771 When the &"w"& flag is set on a rule that causes an envelope address to be
25772 rewritten, all but the working part of the replacement address is discarded.
25773 .endlist
25774
25775
25776 .section "Rewriting examples" "SECID156"
25777 Here is an example of the two common rewriting paradigms:
25778 .code
25779 *@*.hitch.fict.example  $1@hitch.fict.example
25780 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25781                      {$value}fail}@hitch.fict.example bctfrF
25782 .endd
25783 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25784 the string expansion to fail if the lookup does not succeed. In this context it
25785 has the effect of leaving the original address unchanged, but Exim goes on to
25786 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25787 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25788 explicitly, which would cause the rewritten address to be the same as before,
25789 at the cost of a small bit of processing. Not supplying either of these is an
25790 error, since the rewritten address would then contain no local part.
25791
25792 The first example above replaces the domain with a superior, more general
25793 domain. This may not be desirable for certain local parts. If the rule
25794 .code
25795 root@*.hitch.fict.example  *
25796 .endd
25797 were inserted before the first rule, rewriting would be suppressed for the
25798 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25799
25800 Rewriting can be made conditional on a number of tests, by making use of
25801 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25802 messages that originate outside the local host:
25803 .code
25804 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25805                          {$1@hitch.fict.example}fail}"
25806 .endd
25807 The replacement string is quoted in this example because it contains white
25808 space.
25809
25810 .cindex "rewriting" "bang paths"
25811 .cindex "bang paths" "rewriting"
25812 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25813 an address it treats it as an unqualified local part which it qualifies with
25814 the local qualification domain (if the source of the message is local or if the
25815 remote host is permitted to send unqualified addresses). Rewriting can
25816 sometimes be used to handle simple bang paths with a fixed number of
25817 components. For example, the rule
25818 .code
25819 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25820 .endd
25821 rewrites a two-component bang path &'host.name!user'& as the domain address
25822 &'user@host.name'&. However, there is a security implication in using this as
25823 a global rewriting rule for envelope addresses. It can provide a backdoor
25824 method for using your system as a relay, because the incoming addresses appear
25825 to be local. If the bang path addresses are received via SMTP, it is safer to
25826 use the &"S"& flag to rewrite them as they are received, so that relay checking
25827 can be done on the rewritten addresses.
25828 .ecindex IIDaddrew
25829
25830
25831
25832
25833
25834 . ////////////////////////////////////////////////////////////////////////////
25835 . ////////////////////////////////////////////////////////////////////////////
25836
25837 .chapter "Retry configuration" "CHAPretry"
25838 .scindex IIDretconf1 "retry" "configuration, description of"
25839 .scindex IIDregconf2 "configuration file" "retry section"
25840 The &"retry"& section of the runtime configuration file contains a list of
25841 retry rules that control how often Exim tries to deliver messages that cannot
25842 be delivered at the first attempt. If there are no retry rules (the section is
25843 empty or not present), there are no retries. In this situation, temporary
25844 errors are treated as permanent. The default configuration contains a single,
25845 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25846 line option can be used to test which retry rule will be used for a given
25847 address, domain and error.
25848
25849 The most common cause of retries is temporary failure to deliver to a remote
25850 host because the host is down, or inaccessible because of a network problem.
25851 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25852 address) basis, not on a per-message basis. Thus, if one message has recently
25853 been delayed, delivery of a new message to the same host is not immediately
25854 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25855 log selector is set, the message
25856 .cindex "retry" "time not reached"
25857 &"retry time not reached"& is written to the main log whenever a delivery is
25858 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25859 the handling of errors during remote deliveries.
25860
25861 Retry processing applies to routing as well as to delivering, except as covered
25862 in the next paragraph. The retry rules do not distinguish between these
25863 actions. It is not possible, for example, to specify different behaviour for
25864 failures to route the domain &'snark.fict.example'& and failures to deliver to
25865 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25866 added complication, so did not implement it. However, although they share the
25867 same retry rule, the actual retry times for routing and transporting a given
25868 domain are maintained independently.
25869
25870 When a delivery is not part of a queue run (typically an immediate delivery on
25871 receipt of a message), the routers are always run, and local deliveries are
25872 always attempted, even if retry times are set for them. This makes for better
25873 behaviour if one particular message is causing problems (for example, causing
25874 quota overflow, or provoking an error in a filter file). If such a delivery
25875 suffers a temporary failure, the retry data is updated as normal, and
25876 subsequent delivery attempts from queue runs occur only when the retry time for
25877 the local address is reached.
25878
25879 .section "Changing retry rules" "SECID157"
25880 If you change the retry rules in your configuration, you should consider
25881 whether or not to delete the retry data that is stored in Exim's spool area in
25882 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25883 always safe; that is why they are called &"hints"&.
25884
25885 The hints retry data contains suggested retry times based on the previous
25886 rules. In the case of a long-running problem with a remote host, it might
25887 record the fact that the host has timed out. If your new rules increase the
25888 timeout time for such a host, you should definitely remove the old retry data
25889 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25890 messages that it should now be retaining.
25891
25892
25893
25894 .section "Format of retry rules" "SECID158"
25895 .cindex "retry" "rules"
25896 Each retry rule occupies one line and consists of three or four parts,
25897 separated by white space: a pattern, an error name, an optional list of sender
25898 addresses, and a list of retry parameters. The pattern and sender lists must be
25899 enclosed in double quotes if they contain white space. The rules are searched
25900 in order until one is found where the pattern, error name, and sender list (if
25901 present) match the failing host or address, the error that occurred, and the
25902 message's sender, respectively.
25903
25904
25905 The pattern is any single item that may appear in an address list (see section
25906 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25907 which means that it is expanded before being tested against the address that
25908 has been delayed. A negated address list item is permitted. Address
25909 list processing treats a plain domain name as if it were preceded by &"*@"&,
25910 which makes it possible for many retry rules to start with just a domain. For
25911 example,
25912 .code
25913 lookingglass.fict.example        *  F,24h,30m;
25914 .endd
25915 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25916 whereas
25917 .code
25918 alice@lookingglass.fict.example  *  F,24h,30m;
25919 .endd
25920 applies only to temporary failures involving the local part &%alice%&.
25921 In practice, almost all rules start with a domain name pattern without a local
25922 part.
25923
25924 .cindex "regular expressions" "in retry rules"
25925 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25926 must match a complete address, not just a domain, because that is how regular
25927 expressions work in address lists.
25928 .display
25929 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25930 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25931 .endd
25932
25933
25934 .section "Choosing which retry rule to use for address errors" "SECID159"
25935 When Exim is looking for a retry rule after a routing attempt has failed (for
25936 example, after a DNS timeout), each line in the retry configuration is tested
25937 against the complete address only if &%retry_use_local_part%& is set for the
25938 router. Otherwise, only the domain is used, except when matching against a
25939 regular expression, when the local part of the address is replaced with &"*"&.
25940 A domain on its own can match a domain pattern, or a pattern that starts with
25941 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25942 &%check_local_user%& is true, and false for other routers.
25943
25944 Similarly, when Exim is looking for a retry rule after a local delivery has
25945 failed (for example, after a mailbox full error), each line in the retry
25946 configuration is tested against the complete address only if
25947 &%retry_use_local_part%& is set for the transport (it defaults true for all
25948 local transports).
25949
25950 .cindex "4&'xx'& responses" "retry rules for"
25951 However, when Exim is looking for a retry rule after a remote delivery attempt
25952 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25953 whole address is always used as the key when searching the retry rules. The
25954 rule that is found is used to create a retry time for the combination of the
25955 failing address and the message's sender. It is the combination of sender and
25956 recipient that is delayed in subsequent queue runs until its retry time is
25957 reached. You can delay the recipient without regard to the sender by setting
25958 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25959 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25960 commands.
25961
25962
25963
25964 .section "Choosing which retry rule to use for host and message errors" &&&
25965          "SECID160"
25966 For a temporary error that is not related to an individual address (for
25967 example, a connection timeout), each line in the retry configuration is checked
25968 twice. First, the name of the remote host is used as a domain name (preceded by
25969 &"*@"& when matching a regular expression). If this does not match the line,
25970 the domain from the email address is tried in a similar fashion. For example,
25971 suppose the MX records for &'a.b.c.example'& are
25972 .code
25973 a.b.c.example  MX  5  x.y.z.example
25974                MX  6  p.q.r.example
25975                MX  7  m.n.o.example
25976 .endd
25977 and the retry rules are
25978 .code
25979 p.q.r.example    *      F,24h,30m;
25980 a.b.c.example    *      F,4d,45m;
25981 .endd
25982 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25983 first rule matches neither the host nor the domain, so Exim looks at the second
25984 rule. This does not match the host, but it does match the domain, so it is used
25985 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25986 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25987 first retry rule is used, because it matches the host.
25988
25989 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25990 first rule to determine retry times, but for all the other hosts for the domain
25991 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25992 routing to &'a.b.c.example'& suffers a temporary failure.
25993
25994 &*Note*&: The host name is used when matching the patterns, not its IP address.
25995 However, if a message is routed directly to an IP address without the use of a
25996 host name, for example, if a &(manualroute)& router contains a setting such as:
25997 .code
25998 route_list = *.a.example  192.168.34.23
25999 .endd
26000 then the &"host name"& that is used when searching for a retry rule is the
26001 textual form of the IP address.
26002
26003 .section "Retry rules for specific errors" "SECID161"
26004 .cindex "retry" "specific errors; specifying"
26005 The second field in a retry rule is the name of a particular error, or an
26006 asterisk, which matches any error. The errors that can be tested for are:
26007
26008 .vlist
26009 .vitem &%auth_failed%&
26010 Authentication failed when trying to send to a host in the
26011 &%hosts_require_auth%& list in an &(smtp)& transport.
26012
26013 .vitem &%data_4xx%&
26014 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26015 after the command, or after sending the message's data.
26016
26017 .vitem &%mail_4xx%&
26018 A 4&'xx'& error was received for an outgoing MAIL command.
26019
26020 .vitem &%rcpt_4xx%&
26021 A 4&'xx'& error was received for an outgoing RCPT command.
26022 .endlist
26023
26024 For the three 4&'xx'& errors, either the first or both of the x's can be given
26025 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26026 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26027 and have retries every ten minutes with a one-hour timeout, you could set up a
26028 retry rule of this form:
26029 .code
26030 the.domain.name  rcpt_452   F,1h,10m
26031 .endd
26032 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26033 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26034
26035 .vlist
26036 .vitem &%lost_connection%&
26037 A server unexpectedly closed the SMTP connection. There may, of course,
26038 legitimate reasons for this (host died, network died), but if it repeats a lot
26039 for the same host, it indicates something odd.
26040
26041 .vitem &%lookup%&
26042 A DNS lookup for a host failed.
26043 Note that a &%dnslookup%& router will need to have matched
26044 its &%fail_defer_domains%& option for this retry type to be usable.
26045 Also note that a &%manualroute%& router will probably need
26046 its &%host_find_failed%& option set to &%defer%&.
26047
26048 .vitem &%refused_MX%&
26049 A connection to a host obtained from an MX record was refused.
26050
26051 .vitem &%refused_A%&
26052 A connection to a host not obtained from an MX record was refused.
26053
26054 .vitem &%refused%&
26055 A connection was refused.
26056
26057 .vitem &%timeout_connect_MX%&
26058 A connection attempt to a host obtained from an MX record timed out.
26059
26060 .vitem &%timeout_connect_A%&
26061 A connection attempt to a host not obtained from an MX record timed out.
26062
26063 .vitem &%timeout_connect%&
26064 A connection attempt timed out.
26065
26066 .vitem &%timeout_MX%&
26067 There was a timeout while connecting or during an SMTP session with a host
26068 obtained from an MX record.
26069
26070 .vitem &%timeout_A%&
26071 There was a timeout while connecting or during an SMTP session with a host not
26072 obtained from an MX record.
26073
26074 .vitem &%timeout%&
26075 There was a timeout while connecting or during an SMTP session.
26076
26077 .vitem &%tls_required%&
26078 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26079 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26080 to STARTTLS, or there was a problem setting up the TLS connection.
26081
26082 .vitem &%quota%&
26083 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26084 transport.
26085
26086 .vitem &%quota_%&<&'time'&>
26087 .cindex "quota" "error testing in retry rule"
26088 .cindex "retry" "quota error testing"
26089 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26090 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26091 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26092 for four days.
26093 .endlist
26094
26095 .cindex "mailbox" "time of last read"
26096 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26097 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26098 it should be based on the last time that the user accessed the mailbox.
26099 However, it is not always possible to determine this. Exim uses the following
26100 heuristic rules:
26101
26102 .ilist
26103 If the mailbox is a single file, the time of last access (the &"atime"&) is
26104 used. As no new messages are being delivered (because the mailbox is over
26105 quota), Exim does not access the file, so this is the time of last user access.
26106 .next
26107 .cindex "maildir format" "time of last read"
26108 For a maildir delivery, the time of last modification of the &_new_&
26109 subdirectory is used. As the mailbox is over quota, no new files are created in
26110 the &_new_& subdirectory, because no new messages are being delivered. Any
26111 change to the &_new_& subdirectory is therefore assumed to be the result of an
26112 MUA moving a new message to the &_cur_& directory when it is first read. The
26113 time that is used is therefore the last time that the user read a new message.
26114 .next
26115 For other kinds of multi-file mailbox, the time of last access cannot be
26116 obtained, so a retry rule that uses this type of error field is never matched.
26117 .endlist
26118
26119 The quota errors apply both to system-enforced quotas and to Exim's own quota
26120 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26121 when a local delivery is deferred because a partition is full (the ENOSPC
26122 error).
26123
26124
26125
26126 .section "Retry rules for specified senders" "SECID162"
26127 .cindex "retry" "rules; sender-specific"
26128 You can specify retry rules that apply only when the failing message has a
26129 specific sender. In particular, this can be used to define retry rules that
26130 apply only to bounce messages. The third item in a retry rule can be of this
26131 form:
26132 .display
26133 &`senders=`&<&'address list'&>
26134 .endd
26135 The retry timings themselves are then the fourth item. For example:
26136 .code
26137 *   rcpt_4xx   senders=:   F,1h,30m
26138 .endd
26139 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26140 host. If the address list contains white space, it must be enclosed in quotes.
26141 For example:
26142 .code
26143 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26144 .endd
26145 &*Warning*&: This facility can be unhelpful if it is used for host errors
26146 (which do not depend on the recipient). The reason is that the sender is used
26147 only to match the retry rule. Once the rule has been found for a host error,
26148 its contents are used to set a retry time for the host, and this will apply to
26149 all messages, not just those with specific senders.
26150
26151 When testing retry rules using &%-brt%&, you can supply a sender using the
26152 &%-f%& command line option, like this:
26153 .code
26154 exim -f "" -brt user@dom.ain
26155 .endd
26156 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26157 list is never matched.
26158
26159
26160
26161
26162
26163 .section "Retry parameters" "SECID163"
26164 .cindex "retry" "parameters in rules"
26165 The third (or fourth, if a senders list is present) field in a retry rule is a
26166 sequence of retry parameter sets, separated by semicolons. Each set consists of
26167 .display
26168 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26169 .endd
26170 The letter identifies the algorithm for computing a new retry time; the cutoff
26171 time is the time beyond which this algorithm no longer applies, and the
26172 arguments vary the algorithm's action. The cutoff time is measured from the
26173 time that the first failure for the domain (combined with the local part if
26174 relevant) was detected, not from the time the message was received.
26175
26176 .cindex "retry" "algorithms"
26177 .cindex "retry" "fixed intervals"
26178 .cindex "retry" "increasing intervals"
26179 .cindex "retry" "random intervals"
26180 The available algorithms are:
26181
26182 .ilist
26183 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26184 the interval.
26185 .next
26186 &'G'&: retry at geometrically increasing intervals. The first argument
26187 specifies a starting value for the interval, and the second a multiplier, which
26188 is used to increase the size of the interval at each retry.
26189 .next
26190 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26191 retry, the previous interval is multiplied by the factor in order to get a
26192 maximum for the next interval. The minimum interval is the first argument of
26193 the parameter, and an actual interval is chosen randomly between them. Such a
26194 rule has been found to be helpful in cluster configurations when all the
26195 members of the cluster restart at once, and may therefore synchronize their
26196 queue processing times.
26197 .endlist
26198
26199 When computing the next retry time, the algorithm definitions are scanned in
26200 order until one whose cutoff time has not yet passed is reached. This is then
26201 used to compute a new retry time that is later than the current time. In the
26202 case of fixed interval retries, this simply means adding the interval to the
26203 current time. For geometrically increasing intervals, retry intervals are
26204 computed from the rule's parameters until one that is greater than the previous
26205 interval is found. The main configuration variable
26206 .cindex "limit" "retry interval"
26207 .cindex "retry" "interval, maximum"
26208 .oindex "&%retry_interval_max%&"
26209 &%retry_interval_max%& limits the maximum interval between retries. It
26210 cannot be set greater than &`24h`&, which is its default value.
26211
26212 A single remote domain may have a number of hosts associated with it, and each
26213 host may have more than one IP address. Retry algorithms are selected on the
26214 basis of the domain name, but are applied to each IP address independently. If,
26215 for example, a host has two IP addresses and one is unusable, Exim will
26216 generate retry times for it and will not try to use it until its next retry
26217 time comes. Thus the good IP address is likely to be tried first most of the
26218 time.
26219
26220 .cindex "hints database" "use for retrying"
26221 Retry times are hints rather than promises. Exim does not make any attempt to
26222 run deliveries exactly at the computed times. Instead, a queue runner process
26223 starts delivery processes for delayed messages periodically, and these attempt
26224 new deliveries only for those addresses that have passed their next retry time.
26225 If a new message arrives for a deferred address, an immediate delivery attempt
26226 occurs only if the address has passed its retry time. In the absence of new
26227 messages, the minimum time between retries is the interval between queue runner
26228 processes. There is not much point in setting retry times of five minutes if
26229 your queue runners happen only once an hour, unless there are a significant
26230 number of incoming messages (which might be the case on a system that is
26231 sending everything to a smart host, for example).
26232
26233 The data in the retry hints database can be inspected by using the
26234 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26235 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26236 &'exinext'& utility script can be used to find out what the next retry times
26237 are for the hosts associated with a particular mail domain, and also for local
26238 deliveries that have been deferred.
26239
26240
26241 .section "Retry rule examples" "SECID164"
26242 Here are some example retry rules:
26243 .code
26244 alice@wonderland.fict.example quota_5d  F,7d,3h
26245 wonderland.fict.example       quota_5d
26246 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26247 lookingglass.fict.example     *         F,24h,30m;
26248 *                 refused_A   F,2h,20m;
26249 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26250 .endd
26251 The first rule sets up special handling for mail to
26252 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26253 mailbox has not been read for at least 5 days. Retries continue every three
26254 hours for 7 days. The second rule handles over-quota errors for all other local
26255 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26256 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26257 fail are bounced immediately if the mailbox has not been read for at least 5
26258 days.
26259
26260 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26261 happen every 15 minutes for an hour, then with geometrically increasing
26262 intervals until two days have passed since a delivery first failed. After the
26263 first hour there is a delay of one hour, then two hours, then four hours, and
26264 so on (this is a rather extreme example).
26265
26266 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26267 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26268 all other domains, with special action for connection refusal from hosts that
26269 were not obtained from an MX record.
26270
26271 The final rule in a retry configuration should always have asterisks in the
26272 first two fields so as to provide a general catch-all for any addresses that do
26273 not have their own special handling. This example tries every 15 minutes for 2
26274 hours, then with intervals starting at one hour and increasing by a factor of
26275 1.5 up to 16 hours, then every 8 hours up to 5 days.
26276
26277
26278
26279 .section "Timeout of retry data" "SECID165"
26280 .cindex "timeout" "of retry data"
26281 .oindex "&%retry_data_expire%&"
26282 .cindex "hints database" "data expiry"
26283 .cindex "retry" "timeout of data"
26284 Exim timestamps the data that it writes to its retry hints database. When it
26285 consults the data during a delivery it ignores any that is older than the value
26286 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26287 been tried for 7 days, Exim will try to deliver to it immediately a message
26288 arrives, and if that fails, it will calculate a retry time as if it were
26289 failing for the first time.
26290
26291 This improves the behaviour for messages routed to rarely-used hosts such as MX
26292 backups. If such a host was down at one time, and happens to be down again when
26293 Exim tries a month later, using the old retry data would imply that it had been
26294 down all the time, which is not a justified assumption.
26295
26296 If a host really is permanently dead, this behaviour causes a burst of retries
26297 every now and again, but only if messages routed to it are rare. If there is a
26298 message at least once every 7 days the retry data never expires.
26299
26300
26301
26302
26303 .section "Long-term failures" "SECID166"
26304 .cindex "delivery failure, long-term"
26305 .cindex "retry" "after long-term failure"
26306 Special processing happens when an email address has been failing for so long
26307 that the cutoff time for the last algorithm is reached. For example, using the
26308 default retry rule:
26309 .code
26310 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26311 .endd
26312 the cutoff time is four days. Reaching the retry cutoff is independent of how
26313 long any specific message has been failing; it is the length of continuous
26314 failure for the recipient address that counts.
26315
26316 When the cutoff time is reached for a local delivery, or for all the IP
26317 addresses associated with a remote delivery, a subsequent delivery failure
26318 causes Exim to give up on the address, and a bounce message is generated.
26319 In order to cater for new messages that use the failing address, a next retry
26320 time is still computed from the final algorithm, and is used as follows:
26321
26322 For local deliveries, one delivery attempt is always made for any subsequent
26323 messages. If this delivery fails, the address fails immediately. The
26324 post-cutoff retry time is not used.
26325
26326 .cindex "final cutoff" "retries, controlling"
26327 .cindex retry "final cutoff"
26328 If the delivery is remote, there are two possibilities, controlled by the
26329 .oindex "&%delay_after_cutoff%&"
26330 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26331 default. Until the post-cutoff retry time for one of the IP addresses,
26332 as set by the &%retry_data_expire%& option, is
26333 reached, the failing email address is bounced immediately, without a delivery
26334 attempt taking place. After that time, one new delivery attempt is made to
26335 those IP addresses that are past their retry times, and if that still fails,
26336 the address is bounced and new retry times are computed.
26337
26338 In other words, when all the hosts for a given email address have been failing
26339 for a long time, Exim bounces rather then defers until one of the hosts' retry
26340 times is reached. Then it tries once, and bounces if that attempt fails. This
26341 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26342 to a broken destination, but if the host does recover, Exim will eventually
26343 notice.
26344
26345 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26346 addresses are past their final cutoff time, Exim tries to deliver to those IP
26347 addresses that have not been tried since the message arrived. If there are
26348 no suitable IP addresses, or if they all fail, the address is bounced. In other
26349 words, it does not delay when a new message arrives, but tries the expired
26350 addresses immediately, unless they have been tried since the message arrived.
26351 If there is a continuous stream of messages for the failing domains, setting
26352 &%delay_after_cutoff%& false means that there will be many more attempts to
26353 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26354 true.
26355
26356 .section "Deliveries that work intermittently" "SECID167"
26357 .cindex "retry" "intermittently working deliveries"
26358 Some additional logic is needed to cope with cases where a host is
26359 intermittently available, or when a message has some attribute that prevents
26360 its delivery when others to the same address get through. In this situation,
26361 because some messages are successfully delivered, the &"retry clock"& for the
26362 host or address keeps getting reset by the successful deliveries, and so
26363 failing messages remain in the queue for ever because the cutoff time is never
26364 reached.
26365
26366 Two exceptional actions are applied to prevent this happening. The first
26367 applies to errors that are related to a message rather than a remote host.
26368 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26369 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26370 commands, and quota failures. For this type of error, if a message's arrival
26371 time is earlier than the &"first failed"& time for the error, the earlier time
26372 is used when scanning the retry rules to decide when to try next and when to
26373 time out the address.
26374
26375 The exceptional second action applies in all cases. If a message has been on
26376 the queue for longer than the cutoff time of any applicable retry rule for a
26377 given address, a delivery is attempted for that address, even if it is not yet
26378 time, and if this delivery fails, the address is timed out. A new retry time is
26379 not computed in this case, so that other messages for the same address are
26380 considered immediately.
26381 .ecindex IIDretconf1
26382 .ecindex IIDregconf2
26383
26384
26385
26386
26387
26388
26389 . ////////////////////////////////////////////////////////////////////////////
26390 . ////////////////////////////////////////////////////////////////////////////
26391
26392 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26393 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26394 .scindex IIDauthconf2 "authentication"
26395 The &"authenticators"& section of Exim's runtime configuration is concerned
26396 with SMTP authentication. This facility is an extension to the SMTP protocol,
26397 described in RFC 2554, which allows a client SMTP host to authenticate itself
26398 to a server. This is a common way for a server to recognize clients that are
26399 permitted to use it as a relay. SMTP authentication is not of relevance to the
26400 transfer of mail between servers that have no managerial connection with each
26401 other.
26402
26403 .cindex "AUTH" "description of"
26404 Very briefly, the way SMTP authentication works is as follows:
26405
26406 .ilist
26407 The server advertises a number of authentication &'mechanisms'& in response to
26408 the client's EHLO command.
26409 .next
26410 The client issues an AUTH command, naming a specific mechanism. The command
26411 may, optionally, contain some authentication data.
26412 .next
26413 The server may issue one or more &'challenges'&, to which the client must send
26414 appropriate responses. In simple authentication mechanisms, the challenges are
26415 just prompts for user names and passwords. The server does not have to issue
26416 any challenges &-- in some mechanisms the relevant data may all be transmitted
26417 with the AUTH command.
26418 .next
26419 The server either accepts or denies authentication.
26420 .next
26421 If authentication succeeds, the client may optionally make use of the AUTH
26422 option on the MAIL command to pass an authenticated sender in subsequent
26423 mail transactions. Authentication lasts for the remainder of the SMTP
26424 connection.
26425 .next
26426 If authentication fails, the client may give up, or it may try a different
26427 authentication mechanism, or it may try transferring mail over the
26428 unauthenticated connection.
26429 .endlist
26430
26431 If you are setting up a client, and want to know which authentication
26432 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26433 SMTP port) on the server, and issue an EHLO command. The response to this
26434 includes the list of supported mechanisms. For example:
26435 .display
26436 &`$ `&&*&`telnet server.example 25`&*&
26437 &`Trying 192.168.34.25...`&
26438 &`Connected to server.example.`&
26439 &`Escape character is &#x0027;^]&#x0027;.`&
26440 &`220 server.example ESMTP Exim 4.20 ...`&
26441 &*&`ehlo client.example`&*&
26442 &`250-server.example Hello client.example [10.8.4.5]`&
26443 &`250-SIZE 52428800`&
26444 &`250-PIPELINING`&
26445 &`250-AUTH PLAIN`&
26446 &`250 HELP`&
26447 .endd
26448 The second-last line of this example output shows that the server supports
26449 authentication using the PLAIN mechanism. In Exim, the different authentication
26450 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26451 routers and transports, which authenticators are included in the binary is
26452 controlled by build-time definitions. The following are currently available,
26453 included by setting
26454 .code
26455 AUTH_CRAM_MD5=yes
26456 AUTH_CYRUS_SASL=yes
26457 AUTH_DOVECOT=yes
26458 AUTH_EXTERNAL=yes
26459 AUTH_GSASL=yes
26460 AUTH_HEIMDAL_GSSAPI=yes
26461 AUTH_PLAINTEXT=yes
26462 AUTH_SPA=yes
26463 AUTH_TLS=yes
26464 .endd
26465 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26466 authentication mechanism (RFC 2195), and the second provides an interface to
26467 the Cyrus SASL authentication library.
26468 The third is an interface to Dovecot's authentication system, delegating the
26469 work via a socket interface.
26470 .new
26471 The fourth provides for negotiation of authentication done via non-SMTP means,
26472 as defined by RFC 4422 Appendix A.
26473 .wen
26474 The fifth provides an interface to the GNU SASL authentication library, which
26475 provides mechanisms but typically not data sources.
26476 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26477 supporting setting a server keytab.
26478 The seventh can be configured to support
26479 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26480 not formally documented, but used by several MUAs.
26481 The eighth authenticator
26482 supports Microsoft's &'Secure Password Authentication'& mechanism.
26483 The last is an Exim authenticator but not an SMTP one;
26484 instead it can use information from a TLS negotiation.
26485
26486 The authenticators are configured using the same syntax as other drivers (see
26487 section &<<SECTfordricon>>&). If no authenticators are required, no
26488 authentication section need be present in the configuration file. Each
26489 authenticator can in principle have both server and client functions. When Exim
26490 is receiving SMTP mail, it is acting as a server; when it is sending out
26491 messages over SMTP, it is acting as a client. Authenticator configuration
26492 options are provided for use in both these circumstances.
26493
26494 To make it clear which options apply to which situation, the prefixes
26495 &%server_%& and &%client_%& are used on option names that are specific to
26496 either the server or the client function, respectively. Server and client
26497 functions are disabled if none of their options are set. If an authenticator is
26498 to be used for both server and client functions, a single definition, using
26499 both sets of options, is required. For example:
26500 .code
26501 cram:
26502   driver = cram_md5
26503   public_name = CRAM-MD5
26504   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26505   client_name = ph10
26506   client_secret = secret2
26507 .endd
26508 The &%server_%& option is used when Exim is acting as a server, and the
26509 &%client_%& options when it is acting as a client.
26510
26511 Descriptions of the individual authenticators are given in subsequent chapters.
26512 The remainder of this chapter covers the generic options for the
26513 authenticators, followed by general discussion of the way authentication works
26514 in Exim.
26515
26516 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26517 per-mechanism basis.  Please read carefully to determine which variables hold
26518 account labels such as usercodes and which hold passwords or other
26519 authenticating data.
26520
26521 Note that some mechanisms support two different identifiers for accounts: the
26522 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26523 and &'authz'& are commonly encountered.  The American spelling is standard here.
26524 Conceptually, authentication data such as passwords are tied to the identifier
26525 used to authenticate; servers may have rules to permit one user to act as a
26526 second user, so that after login the session is treated as though that second
26527 user had logged in.  That second user is the &'authorization id'&.  A robust
26528 configuration might confirm that the &'authz'& field is empty or matches the
26529 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26530 as verified data, the &'authz'& as an unverified request which the server might
26531 choose to honour.
26532
26533 A &'realm'& is a text string, typically a domain name, presented by a server
26534 to a client to help it select an account and credentials to use.  In some
26535 mechanisms, the client and server provably agree on the realm, but clients
26536 typically can not treat the realm as secure data to be blindly trusted.
26537
26538
26539
26540 .section "Generic options for authenticators" "SECID168"
26541 .cindex "authentication" "generic options"
26542 .cindex "options" "generic; for authenticators"
26543
26544 .option client_condition authenticators string&!! unset
26545 When Exim is authenticating as a client, it skips any authenticator whose
26546 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26547 used, for example, to skip plain text authenticators when the connection is not
26548 encrypted by a setting such as:
26549 .code
26550 client_condition = ${if !eq{$tls_out_cipher}{}}
26551 .endd
26552
26553
26554 .option client_set_id authenticators string&!! unset
26555 When client authentication succeeds, this condition is expanded; the
26556 result is used in the log lines for outbound messages.
26557 Typically it will be the user name used for authentication.
26558
26559
26560 .option driver authenticators string unset
26561 This option must always be set. It specifies which of the available
26562 authenticators is to be used.
26563
26564
26565 .option public_name authenticators string unset
26566 This option specifies the name of the authentication mechanism that the driver
26567 implements, and by which it is known to the outside world. These names should
26568 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26569 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26570 defaults to the driver's instance name.
26571
26572
26573 .option server_advertise_condition authenticators string&!! unset
26574 When a server is about to advertise an authentication mechanism, the condition
26575 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26576 mechanism is not advertised.
26577 If the expansion fails, the mechanism is not advertised. If the failure was not
26578 forced, and was not caused by a lookup defer, the incident is logged.
26579 See section &<<SECTauthexiser>>& below for further discussion.
26580
26581
26582 .option server_condition authenticators string&!! unset
26583 This option must be set for a &%plaintext%& server authenticator, where it
26584 is used directly to control authentication. See section &<<SECTplainserver>>&
26585 for details.
26586
26587 For the &(gsasl)& authenticator, this option is required for various
26588 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26589
26590 For the other authenticators, &%server_condition%& can be used as an additional
26591 authentication or authorization mechanism that is applied after the other
26592 authenticator conditions succeed. If it is set, it is expanded when the
26593 authenticator would otherwise return a success code. If the expansion is forced
26594 to fail, authentication fails. Any other expansion failure causes a temporary
26595 error code to be returned. If the result of a successful expansion is an empty
26596 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26597 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26598 other result, a temporary error code is returned, with the expanded string as
26599 the error text.
26600
26601
26602 .option server_debug_print authenticators string&!! unset
26603 If this option is set and authentication debugging is enabled (see the &%-d%&
26604 command line option), the string is expanded and included in the debugging
26605 output when the authenticator is run as a server. This can help with checking
26606 out the values of variables.
26607 If expansion of the string fails, the error message is written to the debugging
26608 output, and Exim carries on processing.
26609
26610
26611 .option server_set_id authenticators string&!! unset
26612 .vindex "&$authenticated_id$&"
26613 .vindex "&$authenticated_fail_id$&"
26614 When an Exim server successfully authenticates a client, this string is
26615 expanded using data from the authentication, and preserved for any incoming
26616 messages in the variable &$authenticated_id$&. It is also included in the log
26617 lines for incoming messages. For example, a user/password authenticator
26618 configuration might preserve the user name that was used to authenticate, and
26619 refer to it subsequently during delivery of the message.
26620 On a failing authentication the expansion result is instead saved in
26621 the &$authenticated_fail_id$& variable.
26622 If expansion fails, the option is ignored.
26623
26624
26625 .option server_mail_auth_condition authenticators string&!! unset
26626 This option allows a server to discard authenticated sender addresses supplied
26627 as part of MAIL commands in SMTP connections that are authenticated by the
26628 driver on which &%server_mail_auth_condition%& is set. The option is not used
26629 as part of the authentication process; instead its (unexpanded) value is
26630 remembered for later use.
26631 How it is used is described in the following section.
26632
26633
26634
26635
26636
26637 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26638 .cindex "authentication" "sender; authenticated"
26639 .cindex "AUTH" "on MAIL command"
26640 When a client supplied an AUTH= item on a MAIL command, Exim applies
26641 the following checks before accepting it as the authenticated sender of the
26642 message:
26643
26644 .ilist
26645 If the connection is not using extended SMTP (that is, HELO was used rather
26646 than EHLO), the use of AUTH= is a syntax error.
26647 .next
26648 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26649 .next
26650 .vindex "&$authenticated_sender$&"
26651 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26652 running, the value of &$authenticated_sender$& is set to the value obtained
26653 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26654 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26655 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26656 given for the MAIL command.
26657 .next
26658 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26659 is accepted and placed in &$authenticated_sender$& only if the client has
26660 authenticated.
26661 .next
26662 If the AUTH= value was accepted by either of the two previous rules, and
26663 the client has authenticated, and the authenticator has a setting for the
26664 &%server_mail_auth_condition%&, the condition is checked at this point. The
26665 valued that was saved from the authenticator is expanded. If the expansion
26666 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26667 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26668 the value of &$authenticated_sender$& is retained and passed on with the
26669 message.
26670 .endlist
26671
26672
26673 When &$authenticated_sender$& is set for a message, it is passed on to other
26674 hosts to which Exim authenticates as a client. Do not confuse this value with
26675 &$authenticated_id$&, which is a string obtained from the authentication
26676 process, and which is not usually a complete email address.
26677
26678 .vindex "&$sender_address$&"
26679 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26680 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26681 therefore make use of &$authenticated_sender$&. The converse is not true: the
26682 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26683 ACL is run.
26684
26685
26686
26687 .section "Authentication on an Exim server" "SECTauthexiser"
26688 .cindex "authentication" "on an Exim server"
26689 When Exim receives an EHLO command, it advertises the public names of those
26690 authenticators that are configured as servers, subject to the following
26691 conditions:
26692
26693 .ilist
26694 The client host must match &%auth_advertise_hosts%& (default *).
26695 .next
26696 It the &%server_advertise_condition%& option is set, its expansion must not
26697 yield the empty string, &"0"&, &"no"&, or &"false"&.
26698 .endlist
26699
26700 The order in which the authenticators are defined controls the order in which
26701 the mechanisms are advertised.
26702
26703 Some mail clients (for example, some versions of Netscape) require the user to
26704 provide a name and password for authentication whenever AUTH is advertised,
26705 even though authentication may not in fact be needed (for example, Exim may be
26706 set up to allow unconditional relaying from the client by an IP address check).
26707 You can make such clients more friendly by not advertising AUTH to them.
26708 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26709 that runs for RCPT) to relay without authentication, you should set
26710 .code
26711 auth_advertise_hosts = ! 10.9.8.0/24
26712 .endd
26713 so that no authentication mechanisms are advertised to them.
26714
26715 The &%server_advertise_condition%& controls the advertisement of individual
26716 authentication mechanisms. For example, it can be used to restrict the
26717 advertisement of a particular mechanism to encrypted connections, by a setting
26718 such as:
26719 .code
26720 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26721 .endd
26722 .vindex "&$tls_in_cipher$&"
26723 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26724 yields &"yes"&, which allows the advertisement to happen.
26725
26726 When an Exim server receives an AUTH command from a client, it rejects it
26727 immediately if AUTH was not advertised in response to an earlier EHLO
26728 command. This is the case if
26729
26730 .ilist
26731 The client host does not match &%auth_advertise_hosts%&; or
26732 .next
26733 No authenticators are configured with server options; or
26734 .next
26735 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26736 server authenticators.
26737 .endlist
26738
26739
26740 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26741 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26742 AUTH is accepted from any client host.
26743
26744 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26745 server authentication mechanism that was advertised in response to EHLO and
26746 that matches the one named in the AUTH command. If it finds one, it runs
26747 the appropriate authentication protocol, and authentication either succeeds or
26748 fails. If there is no matching advertised mechanism, the AUTH command is
26749 rejected with a 504 error.
26750
26751 .vindex "&$received_protocol$&"
26752 .vindex "&$sender_host_authenticated$&"
26753 When a message is received from an authenticated host, the value of
26754 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26755 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26756 public name) of the authenticator driver that successfully authenticated the
26757 client from which the message was received. This variable is empty if there was
26758 no successful authentication.
26759
26760 .cindex authentication "expansion item"
26761 Successful authentication sets up information used by the
26762 &%authresults%& expansion item.
26763
26764
26765
26766
26767 .section "Testing server authentication" "SECID169"
26768 .cindex "authentication" "testing a server"
26769 .cindex "AUTH" "testing a server"
26770 .cindex "base64 encoding" "creating authentication test data"
26771 Exim's &%-bh%& option can be useful for testing server authentication
26772 configurations. The data for the AUTH command has to be sent using base64
26773 encoding. A quick way to produce such data for testing is the following Perl
26774 script:
26775 .code
26776 use MIME::Base64;
26777 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26778 .endd
26779 .cindex "binary zero" "in authentication data"
26780 This interprets its argument as a Perl string, and then encodes it. The
26781 interpretation as a Perl string allows binary zeros, which are required for
26782 some kinds of authentication, to be included in the data. For example, a
26783 command line to run this script on such data might be
26784 .code
26785 encode '\0user\0password'
26786 .endd
26787 Note the use of single quotes to prevent the shell interpreting the
26788 backslashes, so that they can be interpreted by Perl to specify characters
26789 whose code value is zero.
26790
26791 &*Warning 1*&: If either of the user or password strings starts with an octal
26792 digit, you must use three zeros instead of one after the leading backslash. If
26793 you do not, the octal digit that starts your string will be incorrectly
26794 interpreted as part of the code for the first character.
26795
26796 &*Warning 2*&: If there are characters in the strings that Perl interprets
26797 specially, you must use a Perl escape to prevent them being misinterpreted. For
26798 example, a command such as
26799 .code
26800 encode '\0user@domain.com\0pas$$word'
26801 .endd
26802 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26803
26804 If you have the &%mimencode%& command installed, another way to do produce
26805 base64-encoded strings is to run the command
26806 .code
26807 echo -e -n `\0user\0password' | mimencode
26808 .endd
26809 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26810 in the argument, and the &%-n%& option specifies no newline at the end of its
26811 output. However, not all versions of &%echo%& recognize these options, so you
26812 should check your version before relying on this suggestion.
26813
26814
26815
26816 .section "Authentication by an Exim client" "SECID170"
26817 .cindex "authentication" "on an Exim client"
26818 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26819 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26820 announces support for authentication, and the host matches an entry in either
26821 of these options, Exim (as a client) tries to authenticate as follows:
26822
26823 .ilist
26824 For each authenticator that is configured as a client, in the order in which
26825 they are defined in the configuration, it searches the authentication
26826 mechanisms announced by the server for one whose name matches the public name
26827 of the authenticator.
26828 .next
26829 .vindex "&$host$&"
26830 .vindex "&$host_address$&"
26831 When it finds one that matches, it runs the authenticator's client code. The
26832 variables &$host$& and &$host_address$& are available for any string expansions
26833 that the client might do. They are set to the server's name and IP address. If
26834 any expansion is forced to fail, the authentication attempt is abandoned, and
26835 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26836 delivery to be deferred.
26837 .next
26838 If the result of the authentication attempt is a temporary error or a timeout,
26839 Exim abandons trying to send the message to the host for the moment. It will
26840 try again later. If there are any backup hosts available, they are tried in the
26841 usual way.
26842 .next
26843 If the response to authentication is a permanent error (5&'xx'& code), Exim
26844 carries on searching the list of authenticators and tries another one if
26845 possible. If all authentication attempts give permanent errors, or if there are
26846 no attempts because no mechanisms match (or option expansions force failure),
26847 what happens depends on whether the host matches &%hosts_require_auth%& or
26848 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26849 delivery is deferred. The error can be detected in the retry rules, and thereby
26850 turned into a permanent error if you wish. In the second case, Exim tries to
26851 deliver the message unauthenticated.
26852 .endlist
26853
26854 Note that the hostlist test for whether to do authentication can be
26855 confused if name-IP lookups change between the time the peer is decided
26856 upon and the time that the transport runs.  For example, with a manualroute
26857 router given a host name, and with DNS "round-robin" used by that name: if
26858 the local resolver cache times out between the router and the transport
26859 running, the transport may get an IP for the name for its authentication
26860 check which does not match the connection peer IP.
26861 No authentication will then be done, despite the names being identical.
26862
26863 For such cases use a separate transport which always authenticates.
26864
26865 .cindex "AUTH" "on MAIL command"
26866 When Exim has authenticated itself to a remote server, it adds the AUTH
26867 parameter to the MAIL commands it sends, if it has an authenticated sender for
26868 the message. If the message came from a remote host, the authenticated sender
26869 is the one that was receiving on an incoming MAIL command, provided that the
26870 incoming connection was authenticated and the &%server_mail_auth%& condition
26871 allowed the authenticated sender to be retained. If a local process calls Exim
26872 to send a message, the sender address that is built from the login name and
26873 &%qualify_domain%& is treated as authenticated. However, if the
26874 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26875 the authenticated sender that was received with the message.
26876 .ecindex IIDauthconf1
26877 .ecindex IIDauthconf2
26878
26879
26880
26881
26882
26883
26884 . ////////////////////////////////////////////////////////////////////////////
26885 . ////////////////////////////////////////////////////////////////////////////
26886
26887 .chapter "The plaintext authenticator" "CHAPplaintext"
26888 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26889 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26890 The &(plaintext)& authenticator can be configured to support the PLAIN and
26891 LOGIN authentication mechanisms, both of which transfer authentication data as
26892 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26893 security risk; you are strongly advised to insist on the use of SMTP encryption
26894 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26895 use unencrypted plain text, you should not use the same passwords for SMTP
26896 connections as you do for login accounts.
26897
26898 .section "Plaintext options" "SECID171"
26899 .cindex "options" "&(plaintext)& authenticator (server)"
26900 When configured as a server, &(plaintext)& uses the following options:
26901
26902 .option server_condition authenticators string&!! unset
26903 This is actually a global authentication option, but it must be set in order to
26904 configure the &(plaintext)& driver as a server. Its use is described below.
26905
26906 .option server_prompts plaintext string&!! unset
26907 The contents of this option, after expansion, must be a colon-separated list of
26908 prompt strings. If expansion fails, a temporary authentication rejection is
26909 given.
26910
26911 .section "Using plaintext in a server" "SECTplainserver"
26912 .cindex "AUTH" "in &(plaintext)& authenticator"
26913 .cindex "binary zero" "in &(plaintext)& authenticator"
26914 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26915         "in &(plaintext)& authenticator"
26916 .vindex "&$auth1$&, &$auth2$&, etc"
26917 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26918
26919 When running as a server, &(plaintext)& performs the authentication test by
26920 expanding a string. The data sent by the client with the AUTH command, or in
26921 response to subsequent prompts, is base64 encoded, and so may contain any byte
26922 values when decoded. If any data is supplied with the command, it is treated as
26923 a list of strings, separated by NULs (binary zeros), the first three of which
26924 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26925 (neither LOGIN nor PLAIN uses more than three strings).
26926
26927 For compatibility with previous releases of Exim, the values are also placed in
26928 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26929 variables for this purpose is now deprecated, as it can lead to confusion in
26930 string expansions that also use them for other things.
26931
26932 If there are more strings in &%server_prompts%& than the number of strings
26933 supplied with the AUTH command, the remaining prompts are used to obtain more
26934 data. Each response from the client may be a list of NUL-separated strings.
26935
26936 .vindex "&$authenticated_id$&"
26937 Once a sufficient number of data strings have been received,
26938 &%server_condition%& is expanded. If the expansion is forced to fail,
26939 authentication fails. Any other expansion failure causes a temporary error code
26940 to be returned. If the result of a successful expansion is an empty string,
26941 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26942 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26943 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26944 For any other result, a temporary error code is returned, with the expanded
26945 string as the error text.
26946
26947 &*Warning*&: If you use a lookup in the expansion to find the user's
26948 password, be sure to make the authentication fail if the user is unknown.
26949 There are good and bad examples at the end of the next section.
26950
26951
26952
26953 .section "The PLAIN authentication mechanism" "SECID172"
26954 .cindex "PLAIN authentication mechanism"
26955 .cindex "authentication" "PLAIN mechanism"
26956 .cindex "binary zero" "in &(plaintext)& authenticator"
26957 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26958 sent as one item of data (that is, one combined string containing two NUL
26959 separators). The data is sent either as part of the AUTH command, or
26960 subsequently in response to an empty prompt from the server.
26961
26962 The second and third strings are a user name and a corresponding password.
26963 Using a single fixed user name and password as an example, this could be
26964 configured as follows:
26965 .code
26966 fixed_plain:
26967   driver = plaintext
26968   public_name = PLAIN
26969   server_prompts = :
26970   server_condition = \
26971     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26972   server_set_id = $auth2
26973 .endd
26974 Note that the default result strings from &%if%& (&"true"& or an empty string)
26975 are exactly what we want here, so they need not be specified. Obviously, if the
26976 password contains expansion-significant characters such as dollar, backslash,
26977 or closing brace, they have to be escaped.
26978
26979 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26980 the end of a string list are ignored). If all the data comes as part of the
26981 AUTH command, as is commonly the case, the prompt is not used. This
26982 authenticator is advertised in the response to EHLO as
26983 .code
26984 250-AUTH PLAIN
26985 .endd
26986 and a client host can authenticate itself by sending the command
26987 .code
26988 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26989 .endd
26990 As this contains three strings (more than the number of prompts), no further
26991 data is required from the client. Alternatively, the client may just send
26992 .code
26993 AUTH PLAIN
26994 .endd
26995 to initiate authentication, in which case the server replies with an empty
26996 prompt. The client must respond with the combined data string.
26997
26998 The data string is base64 encoded, as required by the RFC. This example,
26999 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27000 represents a zero byte. This is split up into three strings, the first of which
27001 is empty. The &%server_condition%& option in the authenticator checks that the
27002 second two are &`username`& and &`mysecret`& respectively.
27003
27004 Having just one fixed user name and password, as in this example, is not very
27005 realistic, though for a small organization with only a handful of
27006 authenticating clients it could make sense.
27007
27008 A more sophisticated instance of this authenticator could use the user name in
27009 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27010 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27011 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27012 This is an incorrect example:
27013 .code
27014 server_condition = \
27015   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27016 .endd
27017 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27018 which it then compares to the supplied password (&$auth3$&). Why is this example
27019 incorrect? It works fine for existing users, but consider what happens if a
27020 non-existent user name is given. The lookup fails, but as no success/failure
27021 strings are given for the lookup, it yields an empty string. Thus, to defeat
27022 the authentication, all a client has to do is to supply a non-existent user
27023 name and an empty password. The correct way of writing this test is:
27024 .code
27025 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27026   {${if eq{$value}{$auth3}}} {false}}
27027 .endd
27028 In this case, if the lookup succeeds, the result is checked; if the lookup
27029 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27030 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27031 always fails if its second argument is empty. However, the second way of
27032 writing the test makes the logic clearer.
27033
27034
27035 .section "The LOGIN authentication mechanism" "SECID173"
27036 .cindex "LOGIN authentication mechanism"
27037 .cindex "authentication" "LOGIN mechanism"
27038 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27039 in a number of programs. No data is sent with the AUTH command. Instead, a
27040 user name and password are supplied separately, in response to prompts. The
27041 plaintext authenticator can be configured to support this as in this example:
27042 .code
27043 fixed_login:
27044   driver = plaintext
27045   public_name = LOGIN
27046   server_prompts = User Name : Password
27047   server_condition = \
27048     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27049   server_set_id = $auth1
27050 .endd
27051 Because of the way plaintext operates, this authenticator accepts data supplied
27052 with the AUTH command (in contravention of the specification of LOGIN), but
27053 if the client does not supply it (as is the case for LOGIN clients), the prompt
27054 strings are used to obtain two data items.
27055
27056 Some clients are very particular about the precise text of the prompts. For
27057 example, Outlook Express is reported to recognize only &"Username:"& and
27058 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27059 strings. It uses the &%ldapauth%& expansion condition to check the user
27060 name and password by binding to an LDAP server:
27061 .code
27062 login:
27063   driver = plaintext
27064   public_name = LOGIN
27065   server_prompts = Username:: : Password::
27066   server_condition = ${if and{{ \
27067     !eq{}{$auth1} }{ \
27068     ldapauth{\
27069       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27070       pass=${quote:$auth2} \
27071       ldap://ldap.example.org/} }} }
27072   server_set_id = uid=$auth1,ou=people,o=example.org
27073 .endd
27074 We have to check that the username is not empty before using it, because LDAP
27075 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27076 operator to correctly quote the DN for authentication. However, the basic
27077 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27078 correct one to use for the password, because quoting is needed only to make
27079 the password conform to the Exim syntax. At the LDAP level, the password is an
27080 uninterpreted string.
27081
27082
27083 .section "Support for different kinds of authentication" "SECID174"
27084 A number of string expansion features are provided for the purpose of
27085 interfacing to different ways of user authentication. These include checking
27086 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27087 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27088 &<<SECTexpcond>>&.
27089
27090
27091
27092
27093 .section "Using plaintext in a client" "SECID175"
27094 .cindex "options" "&(plaintext)& authenticator (client)"
27095 The &(plaintext)& authenticator has two client options:
27096
27097 .option client_ignore_invalid_base64 plaintext boolean false
27098 If the client receives a server prompt that is not a valid base64 string,
27099 authentication is abandoned by default. However, if this option is set true,
27100 the error in the challenge is ignored and the client sends the response as
27101 usual.
27102
27103 .option client_send plaintext string&!! unset
27104 The string is a colon-separated list of authentication data strings. Each
27105 string is independently expanded before being sent to the server. The first
27106 string is sent with the AUTH command; any more strings are sent in response
27107 to prompts from the server. Before each string is expanded, the value of the
27108 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27109 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27110 way. Thus, the prompt that is received in response to sending the first string
27111 (with the AUTH command) can be used in the expansion of the second string, and
27112 so on. If an invalid base64 string is received when
27113 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27114 &$auth$&<&'n'&> variable.
27115
27116 &*Note*&: You cannot use expansion to create multiple strings, because
27117 splitting takes priority and happens first.
27118
27119 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27120 the data, further processing is applied to each string before it is sent. If
27121 there are any single circumflex characters in the string, they are converted to
27122 NULs. Should an actual circumflex be required as data, it must be doubled in
27123 the string.
27124
27125 This is an example of a client configuration that implements the PLAIN
27126 authentication mechanism with a fixed user name and password:
27127 .code
27128 fixed_plain:
27129   driver = plaintext
27130   public_name = PLAIN
27131   client_send = ^username^mysecret
27132 .endd
27133 The lack of colons means that the entire text is sent with the AUTH
27134 command, with the circumflex characters converted to NULs. A similar example
27135 that uses the LOGIN mechanism is:
27136 .code
27137 fixed_login:
27138   driver = plaintext
27139   public_name = LOGIN
27140   client_send = : username : mysecret
27141 .endd
27142 The initial colon means that the first string is empty, so no data is sent with
27143 the AUTH command itself. The remaining strings are sent in response to
27144 prompts.
27145 .ecindex IIDplaiauth1
27146 .ecindex IIDplaiauth2
27147
27148
27149
27150
27151 . ////////////////////////////////////////////////////////////////////////////
27152 . ////////////////////////////////////////////////////////////////////////////
27153
27154 .chapter "The cram_md5 authenticator" "CHID9"
27155 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27156 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27157 .cindex "CRAM-MD5 authentication mechanism"
27158 .cindex "authentication" "CRAM-MD5 mechanism"
27159 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27160 sends a challenge string to the client, and the response consists of a user
27161 name and the CRAM-MD5 digest of the challenge string combined with a secret
27162 string (password) which is known to both server and client. Thus, the secret
27163 is not sent over the network as plain text, which makes this authenticator more
27164 secure than &(plaintext)&. However, the downside is that the secret has to be
27165 available in plain text at either end.
27166
27167
27168 .section "Using cram_md5 as a server" "SECID176"
27169 .cindex "options" "&(cram_md5)& authenticator (server)"
27170 This authenticator has one server option, which must be set to configure the
27171 authenticator as a server:
27172
27173 .option server_secret cram_md5 string&!! unset
27174 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27175 When the server receives the client's response, the user name is placed in
27176 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27177 obtain the password for that user. The server then computes the CRAM-MD5 digest
27178 that the client should have sent, and checks that it received the correct
27179 string. If the expansion of &%server_secret%& is forced to fail, authentication
27180 fails. If the expansion fails for some other reason, a temporary error code is
27181 returned to the client.
27182
27183 For compatibility with previous releases of Exim, the user name is also placed
27184 in &$1$&. However, the use of this variables for this purpose is now
27185 deprecated, as it can lead to confusion in string expansions that also use
27186 numeric variables for other things.
27187
27188 For example, the following authenticator checks that the user name given by the
27189 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27190 user name, authentication fails.
27191 .code
27192 fixed_cram:
27193   driver = cram_md5
27194   public_name = CRAM-MD5
27195   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27196   server_set_id = $auth1
27197 .endd
27198 .vindex "&$authenticated_id$&"
27199 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27200 name in &$authenticated_id$&. A more typical configuration might look up the
27201 secret string in a file, using the user name as the key. For example:
27202 .code
27203 lookup_cram:
27204   driver = cram_md5
27205   public_name = CRAM-MD5
27206   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27207                   {$value}fail}
27208   server_set_id = $auth1
27209 .endd
27210 Note that this expansion explicitly forces failure if the lookup fails
27211 because &$auth1$& contains an unknown user name.
27212
27213 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27214 using the relevant libraries, you need to know the realm to specify in the
27215 lookup and then ask for the &"userPassword"& attribute for that user in that
27216 realm, with:
27217 .code
27218 cyrusless_crammd5:
27219   driver = cram_md5
27220   public_name = CRAM-MD5
27221   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27222                   dbmjz{/etc/sasldb2}{$value}fail}
27223   server_set_id = $auth1
27224 .endd
27225
27226 .section "Using cram_md5 as a client" "SECID177"
27227 .cindex "options" "&(cram_md5)& authenticator (client)"
27228 When used as a client, the &(cram_md5)& authenticator has two options:
27229
27230
27231
27232 .option client_name cram_md5 string&!! "the primary host name"
27233 This string is expanded, and the result used as the user name data when
27234 computing the response to the server's challenge.
27235
27236
27237 .option client_secret cram_md5 string&!! unset
27238 This option must be set for the authenticator to work as a client. Its value is
27239 expanded and the result used as the secret string when computing the response.
27240
27241
27242 .vindex "&$host$&"
27243 .vindex "&$host_address$&"
27244 Different user names and secrets can be used for different servers by referring
27245 to &$host$& or &$host_address$& in the options. Forced failure of either
27246 expansion string is treated as an indication that this authenticator is not
27247 prepared to handle this case. Exim moves on to the next configured client
27248 authenticator. Any other expansion failure causes Exim to give up trying to
27249 send the message to the current server.
27250
27251 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27252 strings, is:
27253 .code
27254 fixed_cram:
27255   driver = cram_md5
27256   public_name = CRAM-MD5
27257   client_name = ph10
27258   client_secret = secret
27259 .endd
27260 .ecindex IIDcramauth1
27261 .ecindex IIDcramauth2
27262
27263
27264
27265 . ////////////////////////////////////////////////////////////////////////////
27266 . ////////////////////////////////////////////////////////////////////////////
27267
27268 .chapter "The cyrus_sasl authenticator" "CHID10"
27269 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27270 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27271 .cindex "Cyrus" "SASL library"
27272 .cindex "Kerberos"
27273 The code for this authenticator was provided by Matthew Byng-Maddick while
27274 at A L Digital Ltd.
27275
27276 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27277 library implementation of the RFC 2222 (&"Simple Authentication and Security
27278 Layer"&). This library supports a number of authentication mechanisms,
27279 including PLAIN and LOGIN, but also several others that Exim does not support
27280 directly. In particular, there is support for Kerberos authentication.
27281
27282 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27283 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27284 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27285 name of the driver to determine which mechanism to support.
27286
27287 Where access to some kind of secret file is required, for example, in GSSAPI
27288 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27289 user, and that the Cyrus SASL library has no way of escalating privileges
27290 by default. You may also find you need to set environment variables,
27291 depending on the driver you are using.
27292
27293 The application name provided by Exim is &"exim"&, so various SASL options may
27294 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27295 Kerberos, note that because of limitations in the GSSAPI interface,
27296 changing the server keytab might need to be communicated down to the Kerberos
27297 layer independently. The mechanism for doing so is dependent upon the Kerberos
27298 implementation.
27299
27300 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27301 may be set to point to an alternative keytab file. Exim will pass this
27302 variable through from its own inherited environment when started as root or the
27303 Exim user. The keytab file needs to be readable by the Exim user.
27304 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27305 environment variable.  In practice, for those releases, the Cyrus authenticator
27306 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27307 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27308
27309
27310 .section "Using cyrus_sasl as a server" "SECID178"
27311 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27312 (on a successful authentication) into &$auth1$&. For compatibility with
27313 previous releases of Exim, the username is also placed in &$1$&. However, the
27314 use of this variable for this purpose is now deprecated, as it can lead to
27315 confusion in string expansions that also use numeric variables for other
27316 things.
27317
27318
27319 .option server_hostname cyrus_sasl string&!! "see below"
27320 This option selects the hostname that is used when communicating with the
27321 library. The default value is &`$primary_hostname`&. It is up to the underlying
27322 SASL plug-in what it does with this data.
27323
27324
27325 .option server_mech cyrus_sasl string "see below"
27326 This option selects the authentication mechanism this driver should use. The
27327 default is the value of the generic &%public_name%& option. This option allows
27328 you to use a different underlying mechanism from the advertised name. For
27329 example:
27330 .code
27331 sasl:
27332   driver = cyrus_sasl
27333   public_name = X-ANYTHING
27334   server_mech = CRAM-MD5
27335   server_set_id = $auth1
27336 .endd
27337
27338 .option server_realm cyrus_sasl string&!! unset
27339 This specifies the SASL realm that the server claims to be in.
27340
27341
27342 .option server_service cyrus_sasl string &`smtp`&
27343 This is the SASL service that the server claims to implement.
27344
27345
27346 For straightforward cases, you do not need to set any of the authenticator's
27347 private options. All you need to do is to specify an appropriate mechanism as
27348 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27349 PLAIN, you could have two authenticators as follows:
27350 .code
27351 sasl_cram_md5:
27352   driver = cyrus_sasl
27353   public_name = CRAM-MD5
27354   server_set_id = $auth1
27355
27356 sasl_plain:
27357   driver = cyrus_sasl
27358   public_name = PLAIN
27359   server_set_id = $auth2
27360 .endd
27361 Cyrus SASL does implement the LOGIN authentication method, even though it is
27362 not a standard method. It is disabled by default in the source distribution,
27363 but it is present in many binary distributions.
27364 .ecindex IIDcyrauth1
27365 .ecindex IIDcyrauth2
27366
27367
27368
27369
27370 . ////////////////////////////////////////////////////////////////////////////
27371 . ////////////////////////////////////////////////////////////////////////////
27372 .chapter "The dovecot authenticator" "CHAPdovecot"
27373 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27374 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27375 This authenticator is an interface to the authentication facility of the
27376 Dovecot POP/IMAP server, which can support a number of authentication methods.
27377 Note that Dovecot must be configured to use auth-client not auth-userdb.
27378 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27379 to use the same mechanisms for SMTP authentication. This is a server
27380 authenticator only. There is only one option:
27381
27382 .option server_socket dovecot string unset
27383
27384 This option must specify the UNIX socket that is the interface to Dovecot
27385 authentication. The &%public_name%& option must specify an authentication
27386 mechanism that Dovecot is configured to support. You can have several
27387 authenticators for different mechanisms. For example:
27388 .code
27389 dovecot_plain:
27390   driver = dovecot
27391   public_name = PLAIN
27392   server_socket = /var/run/dovecot/auth-client
27393   server_set_id = $auth1
27394
27395 dovecot_ntlm:
27396   driver = dovecot
27397   public_name = NTLM
27398   server_socket = /var/run/dovecot/auth-client
27399   server_set_id = $auth1
27400 .endd
27401 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27402 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27403 option is passed in the Dovecot authentication command. If, for a TLS
27404 connection, a client certificate has been verified, the &"valid-client-cert"&
27405 option is passed. When authentication succeeds, the identity of the user
27406 who authenticated is placed in &$auth1$&.
27407 .ecindex IIDdcotauth1
27408 .ecindex IIDdcotauth2
27409
27410
27411 . ////////////////////////////////////////////////////////////////////////////
27412 . ////////////////////////////////////////////////////////////////////////////
27413 .chapter "The gsasl authenticator" "CHAPgsasl"
27414 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27415 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27416 .cindex "authentication" "GNU SASL"
27417 .cindex "authentication" "SASL"
27418 .cindex "authentication" "EXTERNAL"
27419 .cindex "authentication" "ANONYMOUS"
27420 .cindex "authentication" "PLAIN"
27421 .cindex "authentication" "LOGIN"
27422 .cindex "authentication" "DIGEST-MD5"
27423 .cindex "authentication" "CRAM-MD5"
27424 .cindex "authentication" "SCRAM-SHA-1"
27425 The &(gsasl)& authenticator provides server integration for the GNU SASL
27426 library and the mechanisms it provides.  This is new as of the 4.80 release
27427 and there are a few areas where the library does not let Exim smoothly
27428 scale to handle future authentication mechanisms, so no guarantee can be
27429 made that any particular new authentication mechanism will be supported
27430 without code changes in Exim.
27431
27432 Exim's &(gsasl)& authenticator does not have client-side support at this
27433 time; only the server-side support is implemented.  Patches welcome.
27434
27435
27436 .option server_channelbinding gsasl boolean false
27437 Do not set this true without consulting a cryptographic engineer.
27438
27439 Some authentication mechanisms are able to use external context at both ends
27440 of the session to bind the authentication to that context, and fail the
27441 authentication process if that context differs.  Specifically, some TLS
27442 ciphersuites can provide identifying information about the cryptographic
27443 context.
27444
27445 This should have meant that certificate identity and verification becomes a
27446 non-issue, as a man-in-the-middle attack will cause the correct client and
27447 server to see different identifiers and authentication will fail.
27448
27449 This is currently only supported when using the GnuTLS library.  This is
27450 only usable by mechanisms which support "channel binding"; at time of
27451 writing, that's the SCRAM family.
27452
27453 This defaults off to ensure smooth upgrade across Exim releases, in case
27454 this option causes some clients to start failing.  Some future release
27455 of Exim might have switched the default to be true.
27456
27457 However, Channel Binding in TLS has proven to be broken in current versions.
27458 Do not plan to rely upon this feature for security, ever, without consulting
27459 with a subject matter expert (a cryptographic engineer).
27460
27461
27462 .option server_hostname gsasl string&!! "see below"
27463 This option selects the hostname that is used when communicating with the
27464 library. The default value is &`$primary_hostname`&.
27465 Some mechanisms will use this data.
27466
27467
27468 .option server_mech gsasl string "see below"
27469 This option selects the authentication mechanism this driver should use. The
27470 default is the value of the generic &%public_name%& option. This option allows
27471 you to use a different underlying mechanism from the advertised name. For
27472 example:
27473 .code
27474 sasl:
27475   driver = gsasl
27476   public_name = X-ANYTHING
27477   server_mech = CRAM-MD5
27478   server_set_id = $auth1
27479 .endd
27480
27481
27482 .option server_password gsasl string&!! unset
27483 Various mechanisms need access to the cleartext password on the server, so
27484 that proof-of-possession can be demonstrated on the wire, without sending
27485 the password itself.
27486
27487 The data available for lookup varies per mechanism.
27488 In all cases, &$auth1$& is set to the &'authentication id'&.
27489 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27490 if available, else the empty string.
27491 The &$auth3$& variable will always be the &'realm'& if available,
27492 else the empty string.
27493
27494 A forced failure will cause authentication to defer.
27495
27496 If using this option, it may make sense to set the &%server_condition%&
27497 option to be simply "true".
27498
27499
27500 .option server_realm gsasl string&!! unset
27501 This specifies the SASL realm that the server claims to be in.
27502 Some mechanisms will use this data.
27503
27504
27505 .option server_scram_iter gsasl string&!! unset
27506 This option provides data for the SCRAM family of mechanisms.
27507 &$auth1$& is not available at evaluation time.
27508 (This may change, as we receive feedback on use)
27509
27510
27511 .option server_scram_salt gsasl string&!! unset
27512 This option provides data for the SCRAM family of mechanisms.
27513 &$auth1$& is not available at evaluation time.
27514 (This may change, as we receive feedback on use)
27515
27516
27517 .option server_service gsasl string &`smtp`&
27518 This is the SASL service that the server claims to implement.
27519 Some mechanisms will use this data.
27520
27521
27522 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27523 .vindex "&$auth1$&, &$auth2$&, etc"
27524 These may be set when evaluating specific options, as detailed above.
27525 They will also be set when evaluating &%server_condition%&.
27526
27527 Unless otherwise stated below, the &(gsasl)& integration will use the following
27528 meanings for these variables:
27529
27530 .ilist
27531 .vindex "&$auth1$&"
27532 &$auth1$&: the &'authentication id'&
27533 .next
27534 .vindex "&$auth2$&"
27535 &$auth2$&: the &'authorization id'&
27536 .next
27537 .vindex "&$auth3$&"
27538 &$auth3$&: the &'realm'&
27539 .endlist
27540
27541 On a per-mechanism basis:
27542
27543 .ilist
27544 .cindex "authentication" "EXTERNAL"
27545 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27546 the &%server_condition%& option must be present.
27547 .next
27548 .cindex "authentication" "ANONYMOUS"
27549 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27550 the &%server_condition%& option must be present.
27551 .next
27552 .cindex "authentication" "GSSAPI"
27553 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27554 &$auth2$& will be set to the &'authorization id'&,
27555 the &%server_condition%& option must be present.
27556 .endlist
27557
27558 An &'anonymous token'& is something passed along as an unauthenticated
27559 identifier; this is analogous to FTP anonymous authentication passing an
27560 email address, or software-identifier@, as the "password".
27561
27562
27563 An example showing the password having the realm specified in the callback
27564 and demonstrating a Cyrus SASL to GSASL migration approach is:
27565 .code
27566 gsasl_cyrusless_crammd5:
27567   driver = gsasl
27568   public_name = CRAM-MD5
27569   server_realm = imap.example.org
27570   server_password = ${lookup{$auth1:$auth3:userPassword}\
27571                     dbmjz{/etc/sasldb2}{$value}fail}
27572   server_set_id = ${quote:$auth1}
27573   server_condition = yes
27574 .endd
27575
27576
27577 . ////////////////////////////////////////////////////////////////////////////
27578 . ////////////////////////////////////////////////////////////////////////////
27579
27580 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27581 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27582 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27583 .cindex "authentication" "GSSAPI"
27584 .cindex "authentication" "Kerberos"
27585 The &(heimdal_gssapi)& authenticator provides server integration for the
27586 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27587 reliably.
27588
27589 .option server_hostname heimdal_gssapi string&!! "see below"
27590 This option selects the hostname that is used, with &%server_service%&,
27591 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27592 identifier.  The default value is &`$primary_hostname`&.
27593
27594 .option server_keytab heimdal_gssapi string&!! unset
27595 If set, then Heimdal will not use the system default keytab (typically
27596 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27597 The value should be a pathname, with no &"file:"& prefix.
27598
27599 .option server_service heimdal_gssapi string&!! "smtp"
27600 This option specifies the service identifier used, in conjunction with
27601 &%server_hostname%&, for building the identifier for finding credentials
27602 from the keytab.
27603
27604
27605 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27606 Beware that these variables will typically include a realm, thus will appear
27607 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27608 not verified, so a malicious client can set it to anything.
27609
27610 The &$auth1$& field should be safely trustable as a value from the Key
27611 Distribution Center.  Note that these are not quite email addresses.
27612 Each identifier is for a role, and so the left-hand-side may include a
27613 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27614
27615 .vindex "&$auth1$&, &$auth2$&, etc"
27616 .ilist
27617 .vindex "&$auth1$&"
27618 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27619 .next
27620 .vindex "&$auth2$&"
27621 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27622 authentication.  If that was empty, this will also be set to the
27623 GSS Display Name.
27624 .endlist
27625
27626
27627 . ////////////////////////////////////////////////////////////////////////////
27628 . ////////////////////////////////////////////////////////////////////////////
27629
27630 .chapter "The spa authenticator" "CHAPspa"
27631 .scindex IIDspaauth1 "&(spa)& authenticator"
27632 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27633 .cindex "authentication" "Microsoft Secure Password"
27634 .cindex "authentication" "NTLM"
27635 .cindex "Microsoft Secure Password Authentication"
27636 .cindex "NTLM authentication"
27637 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27638 Password Authentication'& mechanism,
27639 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27640 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27641 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27642 server side was subsequently contributed by Tom Kistner. The mechanism works as
27643 follows:
27644
27645 .ilist
27646 After the AUTH command has been accepted, the client sends an SPA
27647 authentication request based on the user name and optional domain.
27648 .next
27649 The server sends back a challenge.
27650 .next
27651 The client builds a challenge response which makes use of the user's password
27652 and sends it to the server, which then accepts or rejects it.
27653 .endlist
27654
27655 Encryption is used to protect the password in transit.
27656
27657
27658
27659 .section "Using spa as a server" "SECID179"
27660 .cindex "options" "&(spa)& authenticator (server)"
27661 The &(spa)& authenticator has just one server option:
27662
27663 .option server_password spa string&!! unset
27664 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27665 This option is expanded, and the result must be the cleartext password for the
27666 authenticating user, whose name is at this point in &$auth1$&. For
27667 compatibility with previous releases of Exim, the user name is also placed in
27668 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27669 it can lead to confusion in string expansions that also use numeric variables
27670 for other things. For example:
27671 .code
27672 spa:
27673   driver = spa
27674   public_name = NTLM
27675   server_password = \
27676     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27677 .endd
27678 If the expansion is forced to fail, authentication fails. Any other expansion
27679 failure causes a temporary error code to be returned.
27680
27681
27682
27683
27684
27685 .section "Using spa as a client" "SECID180"
27686 .cindex "options" "&(spa)& authenticator (client)"
27687 The &(spa)& authenticator has the following client options:
27688
27689
27690
27691 .option client_domain spa string&!! unset
27692 This option specifies an optional domain for the authentication.
27693
27694
27695 .option client_password spa string&!! unset
27696 This option specifies the user's password, and must be set.
27697
27698
27699 .option client_username spa string&!! unset
27700 This option specifies the user name, and must be set. Here is an example of a
27701 configuration of this authenticator for use with the mail servers at
27702 &'msn.com'&:
27703 .code
27704 msn:
27705   driver = spa
27706   public_name = MSN
27707   client_username = msn/msn_username
27708   client_password = msn_plaintext_password
27709   client_domain = DOMAIN_OR_UNSET
27710 .endd
27711 .ecindex IIDspaauth1
27712 .ecindex IIDspaauth2
27713
27714
27715
27716
27717
27718 . ////////////////////////////////////////////////////////////////////////////
27719 . ////////////////////////////////////////////////////////////////////////////
27720
27721 .chapter "The external authenticator" "CHAPexternauth"
27722 .scindex IIDexternauth1 "&(external)& authenticator"
27723 .scindex IIDexternauth2 "authenticators" "&(external)&"
27724 .cindex "authentication" "Client Certificate"
27725 .cindex "authentication" "X509"
27726 .cindex "Certificate-based authentication"
27727 The &(external)& authenticator provides support for
27728 authentication based on non-SMTP information.
27729 The specification is in RFC 4422 Appendix A
27730 (&url(https://tools.ietf.org/html/rfc4422)).
27731 It is only a transport and negotiation mechanism;
27732 the process of authentication is entirely controlled
27733 by the server configuration.
27734
27735 The client presents an identity in-clear.
27736 It is probably wise for a server to only advertise,
27737 and for clients to only attempt,
27738 this authentication method on a secure (eg. under TLS) connection.
27739
27740 One possible use, compatible with the
27741 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27742 is for using X509 client certificates.
27743
27744 It thus overlaps in function with the TLS authenticator
27745 (see &<<CHAPtlsauth>>&)
27746 but is a full SMTP SASL authenticator
27747 rather than being implicit for TLS-connection carried
27748 client certificates only.
27749
27750 The examples and discussion in this chapter assume that
27751 client-certificate authentication is being done.
27752
27753 The client must present a certificate,
27754 for which it must have been requested via the
27755 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27756 (see &<<CHAPTLS>>&).
27757 For authentication to be effective the certificate should be
27758 verifiable against a trust-anchor certificate known to the server.
27759
27760 .section "External options" "SECTexternsoptions"
27761 .cindex "options" "&(external)& authenticator (server)"
27762 The &(external)& authenticator has two server options:
27763
27764 .option server_param2 external string&!! unset
27765 .option server_param3 external string&!! unset
27766 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27767 These options are expanded before the &%server_condition%& option
27768 and the result are placed in &$auth2$& and &$auth3$& resectively.
27769 If the expansion is forced to fail, authentication fails. Any other expansion
27770 failure causes a temporary error code to be returned.
27771
27772 They can be used to clarify the coding of a complex &%server_condition%&.
27773
27774 .section "Using external in a server" "SECTexternserver"
27775 .cindex "AUTH" "in &(external)& authenticator"
27776 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27777         "in &(external)& authenticator"
27778 .vindex "&$auth1$&, &$auth2$&, etc"
27779 .cindex "base64 encoding" "in &(external)& authenticator"
27780
27781 When running as a server, &(external)& performs the authentication test by
27782 expanding a string. The data sent by the client with the AUTH command, or in
27783 response to subsequent prompts, is base64 encoded, and so may contain any byte
27784 values when decoded. The decoded value is treated as
27785 an identity for authentication and
27786 placed in the expansion variable &$auth1$&.
27787
27788 For compatibility with previous releases of Exim, the value is also placed in
27789 the expansion variable &$1$&. However, the use of this
27790 variable for this purpose is now deprecated, as it can lead to confusion in
27791 string expansions that also use them for other things.
27792
27793 .vindex "&$authenticated_id$&"
27794 Once an identity has been received,
27795 &%server_condition%& is expanded. If the expansion is forced to fail,
27796 authentication fails. Any other expansion failure causes a temporary error code
27797 to be returned. If the result of a successful expansion is an empty string,
27798 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27799 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27800 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27801 For any other result, a temporary error code is returned, with the expanded
27802 string as the error text.
27803
27804 Example:
27805 .code
27806 ext_ccert_san_mail:
27807   driver =            external
27808   public_name =       EXTERNAL
27809
27810   server_advertise_condition = $tls_in_certificate_verified
27811   server_param2 =     ${certextract {subj_altname,mail,>:} \
27812                                     {$tls_in_peercert}}
27813   server_condition =  ${if forany {$auth2} \
27814                             {eq {$item}{$auth1}}}
27815   server_set_id =     $auth1
27816 .endd
27817 This accepts a client certificate that is verifiable against any
27818 of your configured trust-anchors
27819 (which usually means the full set of public CAs)
27820 and which has a mail-SAN matching the claimed identity sent by the client.
27821
27822 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27823 The account name is therefore guessable by an opponent.
27824 TLS 1.3 protects both server and client certificates, and is not vulnerable
27825 in this way.
27826 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27827
27828
27829 .section "Using external in a client" "SECTexternclient"
27830 .cindex "options" "&(external)& authenticator (client)"
27831 The &(external)& authenticator has one client option:
27832
27833 .option client_send external string&!! unset
27834 This option is expanded and sent with the AUTH command as the
27835 identity being asserted.
27836
27837 Example:
27838 .code
27839 ext_ccert:
27840   driver =      external
27841   public_name = EXTERNAL
27842
27843   client_condition = ${if !eq{$tls_out_cipher}{}}
27844   client_send = myaccount@smarthost.example.net
27845 .endd
27846
27847
27848 .ecindex IIDexternauth1
27849 .ecindex IIDexternauth2
27850
27851
27852
27853
27854
27855 . ////////////////////////////////////////////////////////////////////////////
27856 . ////////////////////////////////////////////////////////////////////////////
27857
27858 .chapter "The tls authenticator" "CHAPtlsauth"
27859 .scindex IIDtlsauth1 "&(tls)& authenticator"
27860 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27861 .cindex "authentication" "Client Certificate"
27862 .cindex "authentication" "X509"
27863 .cindex "Certificate-based authentication"
27864 The &(tls)& authenticator provides server support for
27865 authentication based on client certificates.
27866
27867 It is not an SMTP authentication mechanism and is not
27868 advertised by the server as part of the SMTP EHLO response.
27869 It is an Exim authenticator in the sense that it affects
27870 the protocol element of the log line, can be tested for
27871 by the &%authenticated%& ACL condition, and can set
27872 the &$authenticated_id$& variable.
27873
27874 The client must present a verifiable certificate,
27875 for which it must have been requested via the
27876 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27877 (see &<<CHAPTLS>>&).
27878
27879 If an authenticator of this type is configured it is
27880 run before any SMTP-level communication is done,
27881 and can authenticate the connection.
27882 If it does, SMTP authentication is not offered.
27883
27884 A maximum of one authenticator of this type may be present.
27885
27886
27887 .cindex "options" "&(tls)& authenticator (server)"
27888 The &(tls)& authenticator has three server options:
27889
27890 .option server_param1 tls string&!! unset
27891 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27892 This option is expanded after the TLS negotiation and
27893 the result is placed in &$auth1$&.
27894 If the expansion is forced to fail, authentication fails. Any other expansion
27895 failure causes a temporary error code to be returned.
27896
27897 .option server_param2 tls string&!! unset
27898 .option server_param3 tls string&!! unset
27899 As above, for &$auth2$& and &$auth3$&.
27900
27901 &%server_param1%& may also be spelled &%server_param%&.
27902
27903
27904 Example:
27905 .code
27906 tls:
27907   driver = tls
27908   server_param1 =     ${certextract {subj_altname,mail,>:} \
27909                                     {$tls_in_peercert}}
27910   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27911                                  {forany {$auth1} \
27912                             {!= {0} \
27913                                 {${lookup ldap{ldap:///\
27914                          mailname=${quote_ldap_dn:${lc:$item}},\
27915                          ou=users,LDAP_DC?mailid} {$value}{0} \
27916                        }    }  } }}}
27917   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27918 .endd
27919 This accepts a client certificate that is verifiable against any
27920 of your configured trust-anchors
27921 (which usually means the full set of public CAs)
27922 and which has a SAN with a good account name.
27923
27924 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27925 The account name is therefore guessable by an opponent.
27926 TLS 1.3 protects both server and client certificates, and is not vulnerable
27927 in this way.
27928 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27929
27930 . An alternative might use
27931 . .code
27932 .   server_param1 = ${sha256:$tls_in_peercert}
27933 . .endd
27934 . to require one of a set of specific certs that define a given account
27935 . (the verification is still required, but mostly irrelevant).
27936 . This would help for per-device use.
27937 .
27938 . However, for the future we really need support for checking a
27939 . user cert in LDAP - which probably wants a base-64 DER.
27940
27941 .ecindex IIDtlsauth1
27942 .ecindex IIDtlsauth2
27943
27944
27945 Note that because authentication is traditionally an SMTP operation,
27946 the &%authenticated%& ACL condition cannot be used in
27947 a connect- or helo-ACL.
27948
27949
27950
27951 . ////////////////////////////////////////////////////////////////////////////
27952 . ////////////////////////////////////////////////////////////////////////////
27953
27954 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27955          "Encrypted SMTP connections"
27956 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27957 .scindex IIDencsmtp2 "SMTP" "encryption"
27958 .cindex "TLS" "on SMTP connection"
27959 .cindex "OpenSSL"
27960 .cindex "GnuTLS"
27961 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27962 Sockets Layer), is implemented by making use of the OpenSSL library or the
27963 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27964 cryptographic code in the Exim distribution itself for implementing TLS. In
27965 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27966 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27967 You also need to understand the basic concepts of encryption at a managerial
27968 level, and in particular, the way that public keys, private keys, and
27969 certificates are used.
27970
27971 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27972 connection is established, the client issues a STARTTLS command. If the
27973 server accepts this, the client and the server negotiate an encryption
27974 mechanism. If the negotiation succeeds, the data that subsequently passes
27975 between them is encrypted.
27976
27977 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27978 and if so, what cipher suite is in use, whether the client supplied a
27979 certificate, and whether or not that certificate was verified. This makes it
27980 possible for an Exim server to deny or accept certain commands based on the
27981 encryption state.
27982
27983 &*Warning*&: Certain types of firewall and certain anti-virus products can
27984 disrupt TLS connections. You need to turn off SMTP scanning for these products
27985 in order to get TLS to work.
27986
27987
27988
27989 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27990          "SECID284"
27991 .cindex "submissions protocol"
27992 .cindex "ssmtp protocol"
27993 .cindex "smtps protocol"
27994 .cindex "SMTP" "submissions protocol"
27995 .cindex "SMTP" "ssmtp protocol"
27996 .cindex "SMTP" "smtps protocol"
27997 The history of port numbers for TLS in SMTP is a little messy and has been
27998 contentious.  As of RFC 8314, the common practice of using the historically
27999 allocated port 465 for "email submission but with TLS immediately upon connect
28000 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28001 by them in preference to STARTTLS.
28002
28003 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28004 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28005 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28006
28007 This approach was, for a while, officially abandoned when encrypted SMTP was
28008 standardized, but many clients kept using it, even as the TCP port number was
28009 reassigned for other use.
28010 Thus you may encounter guidance claiming that you shouldn't enable use of
28011 this port.
28012 In practice, a number of mail-clients have only ever supported submissions,
28013 not submission with STARTTLS upgrade.
28014 Ideally, offer both submission (587) and submissions (465) service.
28015
28016 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28017 global option. Its value must be a list of port numbers;
28018 the most common use is expected to be:
28019 .code
28020 tls_on_connect_ports = 465
28021 .endd
28022 The port numbers specified by this option apply to all SMTP connections, both
28023 via the daemon and via &'inetd'&. You still need to specify all the ports that
28024 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28025 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28026 an extra port &-- rather, it specifies different behaviour on a port that is
28027 defined elsewhere.
28028
28029 There is also a &%-tls-on-connect%& command line option. This overrides
28030 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28031
28032
28033
28034
28035
28036
28037 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28038 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28039 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
28040 followed later, when the first versions of GnuTLS were released. To build Exim
28041 to use GnuTLS, you need to set
28042 .code
28043 USE_GNUTLS=yes
28044 .endd
28045 in Local/Makefile
28046 you must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28047 include files and libraries for GnuTLS can be found.
28048
28049 There are some differences in usage when using GnuTLS instead of OpenSSL:
28050
28051 .ilist
28052 The &%tls_verify_certificates%& option
28053 cannot be the path of a directory
28054 for GnuTLS versions before 3.3.6
28055 (for later versions, or OpenSSL, it can be either).
28056 .next
28057 The default value for &%tls_dhparam%& differs for historical reasons.
28058 .next
28059 .vindex "&$tls_in_peerdn$&"
28060 .vindex "&$tls_out_peerdn$&"
28061 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28062 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28063 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28064 .next
28065 OpenSSL identifies cipher suites using hyphens as separators, for example:
28066 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28067 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28068 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28069 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28070 to handle its own older variants) when processing lists of cipher suites in the
28071 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28072 option).
28073 .next
28074 The &%tls_require_ciphers%& options operate differently, as described in the
28075 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28076 .next
28077 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28078 When using OpenSSL, this option is ignored.
28079 (If an API is found to let OpenSSL be configured in this way,
28080 let the Exim Maintainers know and we'll likely use it).
28081 .next
28082 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28083 main option, it must be ordered to match the &%tls_certificate%& list.
28084 .next
28085 Some other recently added features may only be available in one or the other.
28086 This should be documented with the feature.  If the documentation does not
28087 explicitly state that the feature is infeasible in the other TLS
28088 implementation, then patches are welcome.
28089 .endlist
28090
28091
28092 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28093 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28094 an explicit path; if the latter, then the text about generation still applies,
28095 but not the chosen filename.
28096 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28097 See the documentation of &%tls_dhparam%& for more information.
28098
28099 GnuTLS uses D-H parameters that may take a substantial amount of time
28100 to compute. It is unreasonable to re-compute them for every TLS session.
28101 Therefore, Exim keeps this data in a file in its spool directory, called
28102 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28103 of bits requested.
28104 The file is owned by the Exim user and is readable only by
28105 its owner. Every Exim process that start up GnuTLS reads the D-H
28106 parameters from this file. If the file does not exist, the first Exim process
28107 that needs it computes the data and writes it to a temporary file which is
28108 renamed once it is complete. It does not matter if several Exim processes do
28109 this simultaneously (apart from wasting a few resources). Once a file is in
28110 place, new Exim processes immediately start using it.
28111
28112 For maximum security, the parameters that are stored in this file should be
28113 recalculated periodically, the frequency depending on your paranoia level.
28114 If you are avoiding using the fixed D-H primes published in RFCs, then you
28115 are concerned about some advanced attacks and will wish to do this; if you do
28116 not regenerate then you might as well stick to the standard primes.
28117
28118 Arranging this is easy in principle; just delete the file when you want new
28119 values to be computed. However, there may be a problem. The calculation of new
28120 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28121 If the system is not very active, &_/dev/random_& may delay returning data
28122 until enough randomness (entropy) is available. This may cause Exim to hang for
28123 a substantial amount of time, causing timeouts on incoming connections.
28124
28125 The solution is to generate the parameters externally to Exim. They are stored
28126 in &_gnutls-params-N_& in PEM format, which means that they can be
28127 generated externally using the &(certtool)& command that is part of GnuTLS.
28128
28129 To replace the parameters with new ones, instead of deleting the file
28130 and letting Exim re-create it, you can generate new parameters using
28131 &(certtool)& and, when this has been done, replace Exim's cache file by
28132 renaming. The relevant commands are something like this:
28133 .code
28134 # ls
28135 [ look for file; assume gnutls-params-2236 is the most recent ]
28136 # rm -f new-params
28137 # touch new-params
28138 # chown exim:exim new-params
28139 # chmod 0600 new-params
28140 # certtool --generate-dh-params --bits 2236 >>new-params
28141 # openssl dhparam -noout -text -in new-params | head
28142 [ check the first line, make sure it's not more than 2236;
28143   if it is, then go back to the start ("rm") and repeat
28144   until the size generated is at most the size requested ]
28145 # chmod 0400 new-params
28146 # mv new-params gnutls-params-2236
28147 .endd
28148 If Exim never has to generate the parameters itself, the possibility of
28149 stalling is removed.
28150
28151 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28152 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28153 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28154 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28155 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28156 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28157 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28158 which applies to all D-H usage, client or server.  If the value returned by
28159 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28160 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28161 limit, which is still much higher than Exim historically used.
28162
28163 The filename and bits used will change as the GnuTLS maintainers change the
28164 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28165 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28166 2432 bits, while NSS is limited to 2236 bits.
28167
28168 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28169 increase the chance of the generated prime actually being within acceptable
28170 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28171 procedure above.  There is no sane procedure available to Exim to double-check
28172 the size of the generated prime, so it might still be too large.
28173
28174
28175 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28176 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28177 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28178 There is a function in the OpenSSL library that can be passed a list of cipher
28179 suites before the cipher negotiation takes place. This specifies which ciphers
28180 are acceptable for TLS versions prior to 1.3.
28181 The list is colon separated and may contain names like
28182 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28183 directly to this function call.
28184 Many systems will install the OpenSSL manual-pages, so you may have
28185 &'ciphers(1)'& available to you.
28186 The following quotation from the OpenSSL
28187 documentation specifies what forms of item are allowed in the cipher string:
28188
28189 .ilist
28190 It can consist of a single cipher suite such as RC4-SHA.
28191 .next
28192 It can represent a list of cipher suites containing a certain algorithm,
28193 or cipher suites of a certain type. For example SHA1 represents all
28194 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28195 SSL v3 algorithms.
28196 .next
28197 Lists of cipher suites can be combined in a single cipher string using
28198 the + character. This is used as a logical and operation. For example
28199 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28200 algorithms.
28201 .endlist
28202
28203 Each cipher string can be optionally preceded by one of the characters &`!`&,
28204 &`-`& or &`+`&.
28205 .ilist
28206 If &`!`& is used, the ciphers are permanently deleted from the list. The
28207 ciphers deleted can never reappear in the list even if they are explicitly
28208 stated.
28209 .next
28210 If &`-`& is used, the ciphers are deleted from the list, but some or all
28211 of the ciphers can be added again by later options.
28212 .next
28213 If &`+`& is used, the ciphers are moved to the end of the list. This
28214 option does not add any new ciphers; it just moves matching existing ones.
28215 .endlist
28216
28217 If none of these characters is present, the string is interpreted as
28218 a list of ciphers to be appended to the current preference list. If the list
28219 includes any ciphers already present they will be ignored: that is, they will
28220 not be moved to the end of the list.
28221 .endlist
28222
28223 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28224 string:
28225 .code
28226 # note single-quotes to get ! past any shell history expansion
28227 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28228 .endd
28229
28230 This example will let the library defaults be permitted on the MX port, where
28231 there's probably no identity verification anyway, but ups the ante on the
28232 submission ports where the administrator might have some influence on the
28233 choice of clients used:
28234 .code
28235 # OpenSSL variant; see man ciphers(1)
28236 tls_require_ciphers = ${if =={$received_port}{25}\
28237                            {DEFAULT}\
28238                            {HIGH:!MD5:!SHA1}}
28239 .endd
28240
28241 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28242 .code
28243 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28244 .endd
28245
28246 For TLS version 1.3 the control available is less fine-grained
28247 and Exim does not provide access to it at present.
28248 The value of the &%tls_require_ciphers%& option is ignored when
28249 TLS version 1.3 is negotiated.
28250
28251 As of writing the library default cipher suite list for TLSv1.3 is
28252 .code
28253 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28254 .endd
28255
28256
28257 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28258          "SECTreqciphgnu"
28259 .cindex "GnuTLS" "specifying parameters for"
28260 .cindex "TLS" "specifying ciphers (GnuTLS)"
28261 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28262 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28263 .cindex "TLS" "specifying protocols (GnuTLS)"
28264 .cindex "TLS" "specifying priority string (GnuTLS)"
28265 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28266 The GnuTLS library allows the caller to provide a "priority string", documented
28267 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28268 ciphersuite specification in OpenSSL.
28269
28270 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28271 and controls both protocols and ciphers.
28272
28273 The &%tls_require_ciphers%& option is available both as an global option,
28274 controlling how Exim behaves as a server, and also as an option of the
28275 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28276 the value is string expanded.  The resulting string is not an Exim list and
28277 the string is given to the GnuTLS library, so that Exim does not need to be
28278 aware of future feature enhancements of GnuTLS.
28279
28280 Documentation of the strings accepted may be found in the GnuTLS manual, under
28281 "Priority strings".  This is online as
28282 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28283 but beware that this relates to GnuTLS 3, which may be newer than the version
28284 installed on your system.  If you are using GnuTLS 3,
28285 then the example code
28286 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28287 on that site can be used to test a given string.
28288
28289 For example:
28290 .code
28291 # Disable older versions of protocols
28292 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28293 .endd
28294
28295 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28296 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28297 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28298
28299 This example will let the library defaults be permitted on the MX port, where
28300 there's probably no identity verification anyway, and lowers security further
28301 by increasing compatibility; but this ups the ante on the submission ports
28302 where the administrator might have some influence on the choice of clients
28303 used:
28304 .code
28305 # GnuTLS variant
28306 tls_require_ciphers = ${if =={$received_port}{25}\
28307                            {NORMAL:%COMPAT}\
28308                            {SECURE128}}
28309 .endd
28310
28311
28312 .section "Configuring an Exim server to use TLS" "SECID182"
28313 .cindex "TLS" "configuring an Exim server"
28314 When Exim has been built with TLS support, it advertises the availability of
28315 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28316 but not to any others. The default value of this option is *, which means
28317 that STARTTLS is always advertised.  Set it to blank to never advertise;
28318 this is reasonable for systems that want to use TLS only as a client.
28319
28320 If STARTTLS is to be used you
28321 need to set some other options in order to make TLS available.
28322
28323 If a client issues a STARTTLS command and there is some configuration
28324 problem in the server, the command is rejected with a 454 error. If the client
28325 persists in trying to issue SMTP commands, all except QUIT are rejected
28326 with the error
28327 .code
28328 554 Security failure
28329 .endd
28330 If a STARTTLS command is issued within an existing TLS session, it is
28331 rejected with a 554 error code.
28332
28333 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28334 must be set to match some hosts. The default is * which matches all hosts.
28335
28336 If this is all you do, TLS encryption will be enabled but not authentication -
28337 meaning that the peer has no assurance it is actually you he is talking to.
28338 You gain protection from a passive sniffer listening on the wire but not
28339 from someone able to intercept the communication.
28340
28341 Further protection requires some further configuration at the server end.
28342
28343 To make TLS work you need to set, in the server,
28344 .code
28345 tls_certificate = /some/file/name
28346 tls_privatekey = /some/file/name
28347 .endd
28348 These options are, in fact, expanded strings, so you can make them depend on
28349 the identity of the client that is connected if you wish. The first file
28350 contains the server's X509 certificate, and the second contains the private key
28351 that goes with it. These files need to be
28352 PEM format and readable by the Exim user, and must
28353 always be given as full path names.
28354 The key must not be password-protected.
28355 They can be the same file if both the
28356 certificate and the key are contained within it. If &%tls_privatekey%& is not
28357 set, or if its expansion is forced to fail or results in an empty string, this
28358 is assumed to be the case. The certificate file may also contain intermediate
28359 certificates that need to be sent to the client to enable it to authenticate
28360 the server's certificate.
28361
28362 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28363 colon-separated lists of file paths.  Ciphers using given authentication
28364 algorithms require the presence of a suitable certificate to supply the
28365 public-key.  The server selects among the certificates to present to the
28366 client depending on the selected cipher, hence the priority ordering for
28367 ciphers will affect which certificate is used.
28368
28369 If you do not understand about certificates and keys, please try to find a
28370 source of this background information, which is not Exim-specific. (There are a
28371 few comments below in section &<<SECTcerandall>>&.)
28372
28373 &*Note*&: These options do not apply when Exim is operating as a client &--
28374 they apply only in the case of a server. If you need to use a certificate in an
28375 Exim client, you must set the options of the same names in an &(smtp)&
28376 transport.
28377
28378 With just these options, an Exim server will be able to use TLS. It does not
28379 require the client to have a certificate (but see below for how to insist on
28380 this). There is one other option that may be needed in other situations. If
28381 .code
28382 tls_dhparam = /some/file/name
28383 .endd
28384 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28385 with the parameters contained in the file.
28386 Set this to &`none`& to disable use of DH entirely, by making no prime
28387 available:
28388 .code
28389 tls_dhparam = none
28390 .endd
28391 This may also be set to a string identifying a standard prime to be used for
28392 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28393 used is &`ike23`&.  There are a few standard primes available, see the
28394 documentation for &%tls_dhparam%& for the complete list.
28395
28396 See the command
28397 .code
28398 openssl dhparam
28399 .endd
28400 for a way of generating file data.
28401
28402 The strings supplied for these three options are expanded every time a client
28403 host connects. It is therefore possible to use different certificates and keys
28404 for different hosts, if you so wish, by making use of the client's IP address
28405 in &$sender_host_address$& to control the expansion. If a string expansion is
28406 forced to fail, Exim behaves as if the option is not set.
28407
28408 .cindex "cipher" "logging"
28409 .cindex "log" "TLS cipher"
28410 .vindex "&$tls_in_cipher$&"
28411 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28412 an incoming TLS connection. It is included in the &'Received:'& header of an
28413 incoming message (by default &-- you can, of course, change this), and it is
28414 also included in the log line that records a message's arrival, keyed by
28415 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28416 condition can be used to test for specific cipher suites in ACLs.
28417
28418 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28419 can check the name of the cipher suite and vary their actions accordingly. The
28420 cipher suite names vary, depending on which TLS library is being used. For
28421 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28422 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28423 documentation for more details.
28424
28425 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28426 (again depending on the &%tls_cipher%& log selector).
28427
28428
28429 .section "Requesting and verifying client certificates" "SECID183"
28430 .cindex "certificate" "verification of client"
28431 .cindex "TLS" "client certificate verification"
28432 If you want an Exim server to request a certificate when negotiating a TLS
28433 session with a client, you must set either &%tls_verify_hosts%& or
28434 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28435 apply to all TLS connections. For any host that matches one of these options,
28436 Exim requests a certificate as part of the setup of the TLS session. The
28437 contents of the certificate are verified by comparing it with a list of
28438 expected trust-anchors or certificates.
28439 These may be the system default set (depending on library version),
28440 an explicit file or,
28441 depending on library version, a directory, identified by
28442 &%tls_verify_certificates%&.
28443
28444 A file can contain multiple certificates, concatenated end to end. If a
28445 directory is used
28446 (OpenSSL only),
28447 each certificate must be in a separate file, with a name (or a symbolic link)
28448 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28449 certificate. You can compute the relevant hash by running the command
28450 .code
28451 openssl x509 -hash -noout -in /cert/file
28452 .endd
28453 where &_/cert/file_& contains a single certificate.
28454
28455 There is no checking of names of the client against the certificate
28456 Subject Name or Subject Alternate Names.
28457
28458 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28459 what happens if the client does not supply a certificate, or if the certificate
28460 does not match any of the certificates in the collection named by
28461 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28462 attempt to set up a TLS session is aborted, and the incoming connection is
28463 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28464 session continues. ACLs that run for subsequent SMTP commands can detect the
28465 fact that no certificate was verified, and vary their actions accordingly. For
28466 example, you can insist on a certificate before accepting a message for
28467 relaying, but not when the message is destined for local delivery.
28468
28469 .vindex "&$tls_in_peerdn$&"
28470 When a client supplies a certificate (whether it verifies or not), the value of
28471 the Distinguished Name of the certificate is made available in the variable
28472 &$tls_in_peerdn$& during subsequent processing of the message.
28473
28474 .cindex "log" "distinguished name"
28475 Because it is often a long text string, it is not included in the log line or
28476 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28477 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28478 &%received_header_text%& to change the &'Received:'& header. When no
28479 certificate is supplied, &$tls_in_peerdn$& is empty.
28480
28481
28482 .section "Revoked certificates" "SECID184"
28483 .cindex "TLS" "revoked certificates"
28484 .cindex "revocation list"
28485 .cindex "certificate" "revocation list"
28486 .cindex "OCSP" "stapling"
28487 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28488 certificates are revoked. If you have such a list, you can pass it to an Exim
28489 server using the global option called &%tls_crl%& and to an Exim client using
28490 an identically named option for the &(smtp)& transport. In each case, the value
28491 of the option is expanded and must then be the name of a file that contains a
28492 CRL in PEM format.
28493 The downside is that clients have to periodically re-download a potentially huge
28494 file from every certificate authority they know of.
28495
28496 The way with most moving parts at query time is Online Certificate
28497 Status Protocol (OCSP), where the client verifies the certificate
28498 against an OCSP server run by the CA.  This lets the CA track all
28499 usage of the certs.  It requires running software with access to the
28500 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28501 is based on HTTP and can be proxied accordingly.
28502
28503 The only widespread OCSP server implementation (known to this writer)
28504 comes as part of OpenSSL and aborts on an invalid request, such as
28505 connecting to the port and then disconnecting.  This requires
28506 re-entering the passphrase each time some random client does this.
28507
28508 The third way is OCSP Stapling; in this, the server using a certificate
28509 issued by the CA periodically requests an OCSP proof of validity from
28510 the OCSP server, then serves it up inline as part of the TLS
28511 negotiation.   This approach adds no extra round trips, does not let the
28512 CA track users, scales well with number of certs issued by the CA and is
28513 resilient to temporary OCSP server failures, as long as the server
28514 starts retrying to fetch an OCSP proof some time before its current
28515 proof expires.  The downside is that it requires server support.
28516
28517 Unless Exim is built with the support disabled,
28518 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28519 support for OCSP stapling is included.
28520
28521 There is a global option called &%tls_ocsp_file%&.
28522 The file specified therein is expected to be in DER format, and contain
28523 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28524 option will be re-expanded for SNI, if the &%tls_certificate%& option
28525 contains &`tls_in_sni`&, as per other TLS options.
28526
28527 Exim does not at this time implement any support for fetching a new OCSP
28528 proof.  The burden is on the administrator to handle this, outside of
28529 Exim.  The file specified should be replaced atomically, so that the
28530 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28531 on each connection, so a new file will be handled transparently on the
28532 next connection.
28533
28534 When built with OpenSSL Exim will check for a valid next update timestamp
28535 in the OCSP proof; if not present, or if the proof has expired, it will be
28536 ignored.
28537
28538 For the client to be able to verify the stapled OCSP the server must
28539 also supply, in its stapled information, any intermediate
28540 certificates for the chain leading to the OCSP proof from the signer
28541 of the server certificate.  There may be zero or one such. These
28542 intermediate certificates should be added to the server OCSP stapling
28543 file named by &%tls_ocsp_file%&.
28544
28545 Note that the proof only covers the terminal server certificate,
28546 not any of the chain from CA to it.
28547
28548 There is no current way to staple a proof for a client certificate.
28549
28550 .code
28551   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28552   OCSP server is supplied.  The server URL may be included in the
28553   server certificate, if the CA is helpful.
28554
28555   One failure mode seen was the OCSP Signer cert expiring before the end
28556   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28557   noted this as invalid overall, but the re-fetch script did not.
28558 .endd
28559
28560
28561
28562
28563 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28564 .cindex "cipher" "logging"
28565 .cindex "log" "TLS cipher"
28566 .cindex "log" "distinguished name"
28567 .cindex "TLS" "configuring an Exim client"
28568 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28569 deliveries as well as to incoming, the latter one causing logging of the
28570 server certificate's DN. The remaining client configuration for TLS is all
28571 within the &(smtp)& transport.
28572
28573 It is not necessary to set any options to have TLS work in the &(smtp)&
28574 transport. If Exim is built with TLS support, and TLS is advertised by a
28575 server, the &(smtp)& transport always tries to start a TLS session. However,
28576 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28577 transport) to a list of server hosts for which TLS should not be used.
28578
28579 If you do not want Exim to attempt to send messages unencrypted when an attempt
28580 to set up an encrypted connection fails in any way, you can set
28581 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28582 those hosts, delivery is always deferred if an encrypted connection cannot be
28583 set up. If there are any other hosts for the address, they are tried in the
28584 usual way.
28585
28586 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28587 the message unencrypted. It always does this if the response to STARTTLS is
28588 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28589 session after a success response code, what happens is controlled by the
28590 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28591 delivery to this host is deferred, and other hosts (if available) are tried. If
28592 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28593 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28594 negotiation fails, Exim closes the current connection (because it is in an
28595 unknown state), opens a new one to the same host, and then tries the delivery
28596 unencrypted.
28597
28598 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28599 transport provide the client with a certificate, which is passed to the server
28600 if it requests it. If the server is Exim, it will request a certificate only if
28601 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28602
28603 .new
28604 Do not use a certificate which has the OCSP-must-staple extension,
28605 for client use (they are usable for server use).
28606 As TLS has no means for the client to staple before TLS 1.3 it will result
28607 in failed connections.
28608 .wen
28609
28610 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28611 specifies a collection of expected server certificates.
28612 These may be
28613 the system default set (depending on library version),
28614 a file,
28615 or (depending on library version) a directory.
28616 The client verifies the server's certificate
28617 against this collection, taking into account any revoked certificates that are
28618 in the list defined by &%tls_crl%&.
28619 Failure to verify fails the TLS connection unless either of the
28620 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28621
28622 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28623 certificate verification to the listed servers.  Verification either must
28624 or need not succeed respectively.
28625
28626 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28627 checks are made: that the host name (the one in the DNS A record)
28628 is valid for the certificate.
28629 The option defaults to always checking.
28630
28631 The &(smtp)& transport has two OCSP-related options:
28632 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28633 is requested and required for the connection to proceed.  The default
28634 value is empty.
28635 &%hosts_request_ocsp%&; a host-list for which (additionally)
28636 a Certificate Status is requested (but not necessarily verified).  The default
28637 value is "*" meaning that requests are made unless configured
28638 otherwise.
28639
28640 The host(s) should also be in &%hosts_require_tls%&, and
28641 &%tls_verify_certificates%& configured for the transport,
28642 for OCSP to be relevant.
28643
28644 If
28645 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28646 list of permitted cipher suites. If either of these checks fails, delivery to
28647 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28648 alternative hosts, if any.
28649
28650  &*Note*&:
28651 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28652 is operating as a client. Exim does not assume that a server certificate (set
28653 by the global options of the same name) should also be used when operating as a
28654 client.
28655
28656 .vindex "&$host$&"
28657 .vindex "&$host_address$&"
28658 All the TLS options in the &(smtp)& transport are expanded before use, with
28659 &$host$& and &$host_address$& containing the name and address of the server to
28660 which the client is connected. Forced failure of an expansion causes Exim to
28661 behave as if the relevant option were unset.
28662
28663 .vindex &$tls_out_bits$&
28664 .vindex &$tls_out_cipher$&
28665 .vindex &$tls_out_peerdn$&
28666 .vindex &$tls_out_sni$&
28667 Before an SMTP connection is established, the
28668 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28669 variables are emptied. (Until the first connection, they contain the values
28670 that were set when the message was received.) If STARTTLS is subsequently
28671 successfully obeyed, these variables are set to the relevant values for the
28672 outgoing connection.
28673
28674
28675
28676 .section "Use of TLS Server Name Indication" "SECTtlssni"
28677 .cindex "TLS" "Server Name Indication"
28678 .vindex "&$tls_in_sni$&"
28679 .oindex "&%tls_in_sni%&"
28680 With TLS1.0 or above, there is an extension mechanism by which extra
28681 information can be included at various points in the protocol.  One of these
28682 extensions, documented in RFC 6066 (and before that RFC 4366) is
28683 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28684 client in the initial handshake, so that the server can examine the servername
28685 within and possibly choose to use different certificates and keys (and more)
28686 for this session.
28687
28688 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28689 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28690 address.
28691
28692 With SMTP to MX, there are the same problems here as in choosing the identity
28693 against which to validate a certificate: you can't rely on insecure DNS to
28694 provide the identity which you then cryptographically verify.  So this will
28695 be of limited use in that environment.
28696
28697 With SMTP to Submission, there is a well-defined hostname which clients are
28698 connecting to and can validate certificates against.  Thus clients &*can*&
28699 choose to include this information in the TLS negotiation.  If this becomes
28700 wide-spread, then hosters can choose to present different certificates to
28701 different clients.  Or even negotiate different cipher suites.
28702
28703 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28704 if not empty, will be sent on a TLS session as part of the handshake.  There's
28705 nothing more to it.  Choosing a sensible value not derived insecurely is the
28706 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28707 for the lifetime of the client connection (including during authentication).
28708
28709 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28710 received from a client.
28711 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28712
28713 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28714 option (prior to expansion) then the following options will be re-expanded
28715 during TLS session handshake, to permit alternative values to be chosen:
28716
28717 .ilist
28718 &%tls_certificate%&
28719 .next
28720 &%tls_crl%&
28721 .next
28722 &%tls_privatekey%&
28723 .next
28724 &%tls_verify_certificates%&
28725 .next
28726 &%tls_ocsp_file%&
28727 .endlist
28728
28729 Great care should be taken to deal with matters of case, various injection
28730 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28731 can always be referenced; it is important to remember that &$tls_in_sni$& is
28732 arbitrary unverified data provided prior to authentication.
28733 Further, the initial certificate is loaded before SNI has arrived, so
28734 an expansion for &%tls_certificate%& must have a default which is used
28735 when &$tls_in_sni$& is empty.
28736
28737 The Exim developers are proceeding cautiously and so far no other TLS options
28738 are re-expanded.
28739
28740 When Exim is built against OpenSSL, OpenSSL must have been built with support
28741 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28742 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28743 see &`-servername`& in the output, then OpenSSL has support.
28744
28745 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28746 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28747 built, then you have SNI support).
28748
28749
28750
28751 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28752          "SECTmulmessam"
28753 .cindex "multiple SMTP deliveries with TLS"
28754 .cindex "TLS" "multiple message deliveries"
28755 Exim sends multiple messages down the same TCP/IP connection by starting up
28756 an entirely new delivery process for each message, passing the socket from
28757 one process to the next. This implementation does not fit well with the use
28758 of TLS, because there is quite a lot of state information associated with a TLS
28759 connection, not just a socket identification. Passing all the state information
28760 to a new process is not feasible. Consequently, for sending using TLS Exim
28761 starts an additional proxy process for handling the encryption, piping the
28762 unencrypted data stream from and to the delivery processes.
28763
28764 An older mode of operation can be enabled on a per-host basis by the
28765 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28766 this list the proxy process described above is not used; instead Exim
28767 shuts down an existing TLS session being run by the delivery process
28768 before passing the socket to a new process. The new process may then
28769 try to start a new TLS session, and if successful, may try to re-authenticate
28770 if AUTH is in use, before sending the next message.
28771
28772 The RFC is not clear as to whether or not an SMTP session continues in clear
28773 after TLS has been shut down, or whether TLS may be restarted again later, as
28774 just described. However, if the server is Exim, this shutdown and
28775 reinitialization works. It is not known which (if any) other servers operate
28776 successfully if the client closes a TLS session and continues with unencrypted
28777 SMTP, but there are certainly some that do not work. For such servers, Exim
28778 should not pass the socket to another process, because the failure of the
28779 subsequent attempt to use it would cause Exim to record a temporary host error,
28780 and delay other deliveries to that host.
28781
28782 To test for this case, Exim sends an EHLO command to the server after
28783 closing down the TLS session. If this fails in any way, the connection is
28784 closed instead of being passed to a new delivery process, but no retry
28785 information is recorded.
28786
28787 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28788 &(smtp)& transport to match those hosts for which Exim should not pass
28789 connections to new processes if TLS has been used.
28790
28791
28792
28793
28794 .section "Certificates and all that" "SECTcerandall"
28795 .cindex "certificate" "references to discussion"
28796 In order to understand fully how TLS works, you need to know about
28797 certificates, certificate signing, and certificate authorities.
28798 This is a large topic and an introductory guide is unsuitable for the Exim
28799 reference manual, so instead we provide pointers to existing documentation.
28800
28801 The Apache web-server was for a long time the canonical guide, so their
28802 documentation is a good place to start; their SSL module's Introduction
28803 document is currently at
28804 .display
28805 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28806 .endd
28807 and their FAQ is at
28808 .display
28809 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28810 .endd
28811
28812 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28813 0-201-61598-3) in 2001, contains both introductory and more in-depth
28814 descriptions.
28815 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28816 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28817 Ivan is the author of the popular TLS testing tools at
28818 &url(https://www.ssllabs.com/).
28819
28820
28821 .section "Certificate chains" "SECID186"
28822 The file named by &%tls_certificate%& may contain more than one
28823 certificate. This is useful in the case where the certificate that is being
28824 sent is validated by an intermediate certificate which the other end does
28825 not have. Multiple certificates must be in the correct order in the file.
28826 First the host's certificate itself, then the first intermediate
28827 certificate to validate the issuer of the host certificate, then the next
28828 intermediate certificate to validate the issuer of the first intermediate
28829 certificate, and so on, until finally (optionally) the root certificate.
28830 The root certificate must already be trusted by the recipient for
28831 validation to succeed, of course, but if it's not preinstalled, sending the
28832 root certificate along with the rest makes it available for the user to
28833 install if the receiving end is a client MUA that can interact with a user.
28834
28835 Note that certificates using MD5 are unlikely to work on today's Internet;
28836 even if your libraries allow loading them for use in Exim when acting as a
28837 server, increasingly clients will not accept such certificates.  The error
28838 diagnostics in such a case can be frustratingly vague.
28839
28840
28841
28842 .section "Self-signed certificates" "SECID187"
28843 .cindex "certificate" "self-signed"
28844 You can create a self-signed certificate using the &'req'& command provided
28845 with OpenSSL, like this:
28846 . ==== Do not shorten the duration here without reading and considering
28847 . ==== the text below.  Please leave it at 9999 days.
28848 .code
28849 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28850             -days 9999 -nodes
28851 .endd
28852 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28853 delimited and so can be identified independently. The &%-days%& option
28854 specifies a period for which the certificate is valid. The &%-nodes%& option is
28855 important: if you do not set it, the key is encrypted with a passphrase
28856 that you are prompted for, and any use that is made of the key causes more
28857 prompting for the passphrase. This is not helpful if you are going to use
28858 this certificate and key in an MTA, where prompting is not possible.
28859
28860 . ==== I expect to still be working 26 years from now.  The less technical
28861 . ==== debt I create, in terms of storing up trouble for my later years, the
28862 . ==== happier I will be then.  We really have reached the point where we
28863 . ==== should start, at the very least, provoking thought and making folks
28864 . ==== pause before proceeding, instead of leaving all the fixes until two
28865 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28866 . ==== -pdp, 2012
28867 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28868 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28869 the above command might produce a date in the past.  Think carefully about
28870 the lifetime of the systems you're deploying, and either reduce the duration
28871 of the certificate or reconsider your platform deployment.  (At time of
28872 writing, reducing the duration is the most likely choice, but the inexorable
28873 progression of time takes us steadily towards an era where this will not
28874 be a sensible resolution).
28875
28876 A self-signed certificate made in this way is sufficient for testing, and
28877 may be adequate for all your requirements if you are mainly interested in
28878 encrypting transfers, and not in secure identification.
28879
28880 However, many clients require that the certificate presented by the server be a
28881 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28882 certificate. In this situation, the self-signed certificate described above
28883 must be installed on the client host as a trusted root &'certification
28884 authority'& (CA), and the certificate used by Exim must be a user certificate
28885 signed with that self-signed certificate.
28886
28887 For information on creating self-signed CA certificates and using them to sign
28888 user certificates, see the &'General implementation overview'& chapter of the
28889 Open-source PKI book, available online at
28890 &url(https://sourceforge.net/projects/ospkibook/).
28891 .ecindex IIDencsmtp1
28892 .ecindex IIDencsmtp2
28893
28894
28895
28896 .section DANE "SECDANE"
28897 .cindex DANE
28898 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28899 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28900 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28901 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28902 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28903 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28904
28905 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28906 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28907 by (a) is thought to be smaller than that of the set of root CAs.
28908
28909 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28910 fail to pass on a server's STARTTLS.
28911
28912 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28913 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28914 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28915
28916 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28917 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28918 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28919 DNSSEC.
28920 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28921 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28922
28923 There are no changes to Exim specific to server-side operation of DANE.
28924 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28925 in &_Local/Makefile_&.
28926 If it has been included, the macro "_HAVE_DANE" will be defined.
28927
28928 A TLSA record consist of 4 fields, the "Certificate Usage", the
28929 "Selector", the "Matching type", and the "Certificate Association Data".
28930 For a detailed description of the TLSA record see
28931 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
28932
28933 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
28934 These are the "Trust Anchor" and "End Entity" variants.
28935 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28936 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28937 this is appropriate for a single system, using a self-signed certificate.
28938 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28939 well-known one.
28940 A private CA at simplest is just a self-signed certificate (with certain
28941 attributes) which is used to sign server certificates, but running one securely
28942 does require careful arrangement.
28943 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28944 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28945 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28946 all of which point to a single TLSA record.
28947 DANE-TA and DANE-EE can both be used together.
28948
28949 Our recommendation is to use DANE with a certificate from a public CA,
28950 because this enables a variety of strategies for remote clients to verify
28951 your certificate.
28952 You can then publish information both via DANE and another technology,
28953 "MTA-STS", described below.
28954
28955 When you use DANE-TA to publish trust anchor information, you ask entities
28956 outside your administrative control to trust the Certificate Authority for
28957 connections to you.
28958 If using a private CA then you should expect others to still apply the
28959 technical criteria they'd use for a public CA to your certificates.
28960 In particular, you should probably try to follow current best practices for CA
28961 operation around hash algorithms and key sizes.
28962 Do not expect other organizations to lower their security expectations just
28963 because a particular profile might be reasonable for your own internal use.
28964
28965 When this text was last updated, this in practice means to avoid use of SHA-1
28966 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28967 than 4096, for interoperability); to use keyUsage fields correctly; to use
28968 random serial numbers.
28969 The list of requirements is subject to change as best practices evolve.
28970 If you're not already using a private CA, or it doesn't meet these
28971 requirements, then we encourage you to avoid all these issues and use a public
28972 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28973
28974 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
28975 a "Matching Type" (3rd) field of SHA2-512(2).
28976
28977 For the "Certificate Authority Data" (4th) field, commands like
28978
28979 .code
28980   openssl x509 -pubkey -noout <certificate.pem \
28981   | openssl rsa -outform der -pubin 2>/dev/null \
28982   | openssl sha512 \
28983   | awk '{print $2}'
28984 .endd
28985
28986 are workable to create a hash of the certificate's public key.
28987
28988 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
28989
28990 .code
28991   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
28992 .endd
28993
28994 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28995 is useful for quickly generating TLSA records.
28996
28997
28998 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28999
29000 The Certificate issued by the CA published in the DANE-TA model should be
29001 issued using a strong hash algorithm.
29002 Exim, and importantly various other MTAs sending to you, will not
29003 re-enable hash algorithms which have been disabled by default in TLS
29004 libraries.
29005 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29006 interoperability (and probably the maximum too, in 2018).
29007
29008 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29009 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29010 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29011
29012 .code
29013   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29014                                  {= {4}{$tls_out_tlsa_usage}} } \
29015                          {*}{}}
29016 .endd
29017
29018 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29019 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29020 found. If the definition of &%hosts_request_ocsp%& includes the
29021 string "tls_out_tlsa_usage", they are re-expanded in time to
29022 control the OCSP request.
29023
29024 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29025 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29026
29027
29028 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29029 and &%dane_require_tls_ciphers%&.
29030 The require variant will result in failure if the target host is not
29031 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29032 the &%dnssec_request_domains%& router or transport option.
29033
29034 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29035
29036 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29037 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29038 will be required for the host.  If it does not, the host will not
29039 be used; there is no fallback to non-DANE or non-TLS.
29040
29041 If DANE is requested and usable, then the TLS cipher list configuration
29042 prefers to use the option &%dane_require_tls_ciphers%& and falls
29043 back to &%tls_require_ciphers%& only if that is unset.
29044 This lets you configure "decent crypto" for DANE and "better than nothing
29045 crypto" as the default.  Note though that while GnuTLS lets the string control
29046 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29047 limited to ciphersuite constraints.
29048
29049 If DANE is requested and useable (see above) the following transport options are ignored:
29050 .code
29051   hosts_require_tls
29052   tls_verify_hosts
29053   tls_try_verify_hosts
29054   tls_verify_certificates
29055   tls_crl
29056   tls_verify_cert_hostnames
29057 .endd
29058
29059 If DANE is not usable, whether requested or not, and CA-anchored
29060 verification evaluation is wanted, the above variables should be set appropriately.
29061
29062 The router and transport option &%dnssec_request_domains%& must not be
29063 set to "never" and &%dnssec_require_domains%& is ignored.
29064
29065 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29066
29067 There is a new variable &$tls_out_dane$& which will have "yes" if
29068 verification succeeded using DANE and "no" otherwise (only useful
29069 in combination with events; see &<<CHAPevents>>&),
29070 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29071
29072 .cindex DANE reporting
29073 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29074 to achieve DANE-verified connection, if one was either requested and offered, or
29075 required.  This is intended to support TLS-reporting as defined in
29076 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29077 The &$event_data$& will be one of the Result Types defined in
29078 Section 4.3 of that document.
29079
29080 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29081
29082 DANE is specified in published RFCs and decouples certificate authority trust
29083 selection from a "race to the bottom" of "you must trust everything for mail
29084 to get through".  There is an alternative technology called MTA-STS, which
29085 instead publishes MX trust anchor information on an HTTPS website.  At the
29086 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29087 Exim has no support for MTA-STS as a client, but Exim mail server operators
29088 can choose to publish information describing their TLS configuration using
29089 MTA-STS to let those clients who do use that protocol derive trust
29090 information.
29091
29092 The MTA-STS design requires a certificate from a public Certificate Authority
29093 which is recognized by clients sending to you.
29094 That selection of which CAs are trusted by others is outside your control.
29095
29096 The most interoperable course of action is probably to use
29097 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29098 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29099 records for DANE clients (such as Exim and Postfix) and to publish anchor
29100 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29101 domain itself (with caveats around occasionally broken MTA-STS because of
29102 incompatible specification changes prior to reaching RFC status).
29103
29104
29105
29106 . ////////////////////////////////////////////////////////////////////////////
29107 . ////////////////////////////////////////////////////////////////////////////
29108
29109 .chapter "Access control lists" "CHAPACL"
29110 .scindex IIDacl "&ACL;" "description"
29111 .cindex "control of incoming mail"
29112 .cindex "message" "controlling incoming"
29113 .cindex "policy control" "access control lists"
29114 Access Control Lists (ACLs) are defined in a separate section of the runtime
29115 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29116 name, terminated by a colon. Here is a complete ACL section that contains just
29117 one very small ACL:
29118 .code
29119 begin acl
29120 small_acl:
29121   accept   hosts = one.host.only
29122 .endd
29123 You can have as many lists as you like in the ACL section, and the order in
29124 which they appear does not matter. The lists are self-terminating.
29125
29126 The majority of ACLs are used to control Exim's behaviour when it receives
29127 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29128 when a local process submits a message using SMTP by specifying the &%-bs%&
29129 option. The most common use is for controlling which recipients are accepted
29130 in incoming messages. In addition, you can define an ACL that is used to check
29131 local non-SMTP messages. The default configuration file contains an example of
29132 a realistic ACL for checking RCPT commands. This is discussed in chapter
29133 &<<CHAPdefconfil>>&.
29134
29135
29136 .section "Testing ACLs" "SECID188"
29137 The &%-bh%& command line option provides a way of testing your ACL
29138 configuration locally by running a fake SMTP session with which you interact.
29139
29140
29141 .section "Specifying when ACLs are used" "SECID189"
29142 .cindex "&ACL;" "options for specifying"
29143 In order to cause an ACL to be used, you have to name it in one of the relevant
29144 options in the main part of the configuration. These options are:
29145 .cindex "AUTH" "ACL for"
29146 .cindex "DATA" "ACLs for"
29147 .cindex "ETRN" "ACL for"
29148 .cindex "EXPN" "ACL for"
29149 .cindex "HELO" "ACL for"
29150 .cindex "EHLO" "ACL for"
29151 .cindex "DKIM" "ACL for"
29152 .cindex "MAIL" "ACL for"
29153 .cindex "QUIT, ACL for"
29154 .cindex "RCPT" "ACL for"
29155 .cindex "STARTTLS, ACL for"
29156 .cindex "VRFY" "ACL for"
29157 .cindex "SMTP" "connection, ACL for"
29158 .cindex "non-SMTP messages" "ACLs for"
29159 .cindex "MIME content scanning" "ACL for"
29160 .cindex "PRDR" "ACL for"
29161
29162 .table2 140pt
29163 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29164 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29165 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29166 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29167 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29168 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29169 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29170 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29171 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29172 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29173 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29174 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29175 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29176 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29177 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29178 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29179 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29180 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29181 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29182 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29183 .endtable
29184
29185 For example, if you set
29186 .code
29187 acl_smtp_rcpt = small_acl
29188 .endd
29189 the little ACL defined above is used whenever Exim receives a RCPT command
29190 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29191 done when RCPT commands arrive. A rejection of RCPT should cause the
29192 sending MTA to give up on the recipient address contained in the RCPT
29193 command, whereas rejection at other times may cause the client MTA to keep on
29194 trying to deliver the message. It is therefore recommended that you do as much
29195 testing as possible at RCPT time.
29196
29197
29198 .section "The non-SMTP ACLs" "SECID190"
29199 .cindex "non-SMTP messages" "ACLs for"
29200 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29201 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29202 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29203 the state of the SMTP connection such as encryption and authentication) are not
29204 relevant and are forbidden in these ACLs. However, the sender and recipients
29205 are known, so the &%senders%& and &%sender_domains%& conditions and the
29206 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29207 &$authenticated_sender$& are also available. You can specify added header lines
29208 in any of these ACLs.
29209
29210 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29211 non-SMTP message, before any of the message has been read. (This is the
29212 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29213 batched SMTP input, it runs after the DATA command has been reached. The
29214 result of this ACL is ignored; it cannot be used to reject a message. If you
29215 really need to, you could set a value in an ACL variable here and reject based
29216 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29217 controls, and in particular, it can be used to set
29218 .code
29219 control = suppress_local_fixups
29220 .endd
29221 This cannot be used in the other non-SMTP ACLs because by the time they are
29222 run, it is too late.
29223
29224 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29225 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29226
29227 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29228 kind of rejection is treated as permanent, because there is no way of sending a
29229 temporary error for these kinds of message.
29230
29231
29232 .section "The SMTP connect ACL" "SECID191"
29233 .cindex "SMTP" "connection, ACL for"
29234 .oindex &%smtp_banner%&
29235 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29236 session, after the test specified by &%host_reject_connection%& (which is now
29237 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29238 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29239 the message override the banner message that is otherwise specified by the
29240 &%smtp_banner%& option.
29241
29242
29243 .section "The EHLO/HELO ACL" "SECID192"
29244 .cindex "EHLO" "ACL for"
29245 .cindex "HELO" "ACL for"
29246 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29247 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29248 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29249 Note that a client may issue more than one EHLO or HELO command in an SMTP
29250 session, and indeed is required to issue a new EHLO or HELO after successfully
29251 setting up encryption following a STARTTLS command.
29252
29253 Note also that a deny neither forces the client to go away nor means that
29254 mail will be refused on the connection.  Consider checking for
29255 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29256
29257 If the command is accepted by an &%accept%& verb that has a &%message%&
29258 modifier, the message may not contain more than one line (it will be truncated
29259 at the first newline and a panic logged if it does). Such a message cannot
29260 affect the EHLO options that are listed on the second and subsequent lines of
29261 an EHLO response.
29262
29263
29264 .section "The DATA ACLs" "SECID193"
29265 .cindex "DATA" "ACLs for"
29266 Two ACLs are associated with the DATA command, because it is two-stage
29267 command, with two responses being sent to the client.
29268 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29269 is obeyed. This gives you control after all the RCPT commands, but before
29270 the message itself is received. It offers the opportunity to give a negative
29271 response to the DATA command before the data is transmitted. Header lines
29272 added by MAIL or RCPT ACLs are not visible at this time, but any that
29273 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29274
29275 You cannot test the contents of the message, for example, to verify addresses
29276 in the headers, at RCPT time or when the DATA command is received. Such
29277 tests have to appear in the ACL that is run after the message itself has been
29278 received, before the final response to the DATA command is sent. This is
29279 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29280 associated with the DATA command.
29281
29282 .cindex CHUNKING "BDAT command"
29283 .cindex BDAT "SMTP command"
29284 .cindex "RFC 3030" CHUNKING
29285 If CHUNKING was advertised and a BDAT command sequence is received,
29286 the &%acl_smtp_predata%& ACL is not run.
29287 . XXX why not?  It should be possible, for the first BDAT.
29288 The &%acl_smtp_data%& is run after the last BDAT command and all of
29289 the data specified is received.
29290
29291 For both of these ACLs, it is not possible to reject individual recipients. An
29292 error response rejects the entire message. Unfortunately, it is known that some
29293 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29294 before or after the data) correctly &-- they keep the message on their queues
29295 and try again later, but that is their problem, though it does waste some of
29296 your resources.
29297
29298 The &%acl_smtp_data%& ACL is run after
29299 the &%acl_smtp_data_prdr%&,
29300 the &%acl_smtp_dkim%&
29301 and the &%acl_smtp_mime%& ACLs.
29302
29303 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29304 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29305 enabled (which is the default).
29306
29307 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29308 received, and is executed for each DKIM signature found in a message.  If not
29309 otherwise specified, the default action is to accept.
29310
29311 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29312
29313 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29314
29315
29316 .section "The SMTP MIME ACL" "SECID194"
29317 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29318 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29319
29320 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29321
29322
29323 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29324 .cindex "PRDR" "ACL for"
29325 .oindex "&%prdr_enable%&"
29326 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29327 with PRDR support enabled (which is the default).
29328 It becomes active only when the PRDR feature is negotiated between
29329 client and server for a message, and more than one recipient
29330 has been accepted.
29331
29332 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29333 has been received, and is executed once for each recipient of the message
29334 with &$local_part$& and &$domain$& valid.
29335 The test may accept, defer or deny for individual recipients.
29336 The &%acl_smtp_data%& will still be called after this ACL and
29337 can reject the message overall, even if this ACL has accepted it
29338 for some or all recipients.
29339
29340 PRDR may be used to support per-user content filtering.  Without it
29341 one must defer any recipient after the first that has a different
29342 content-filter configuration.  With PRDR, the RCPT-time check
29343 .cindex "PRDR" "variable for"
29344 for this can be disabled when the variable &$prdr_requested$&
29345 is &"yes"&.
29346 Any required difference in behaviour of the main DATA-time
29347 ACL should however depend on the PRDR-time ACL having run, as Exim
29348 will avoid doing so in some situations (e.g. single-recipient mails).
29349
29350 See also the &%prdr_enable%& global option
29351 and the &%hosts_try_prdr%& smtp transport option.
29352
29353 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29354 If the ACL is not defined, processing completes as if
29355 the feature was not requested by the client.
29356
29357 .section "The QUIT ACL" "SECTQUITACL"
29358 .cindex "QUIT, ACL for"
29359 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29360 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29361 does not in fact control any access.
29362 For this reason, it may only accept
29363 or warn as its final result.
29364
29365 This ACL can be used for tasks such as custom logging at the end of an SMTP
29366 session. For example, you can use ACL variables in other ACLs to count
29367 messages, recipients, etc., and log the totals at QUIT time using one or
29368 more &%logwrite%& modifiers on a &%warn%& verb.
29369
29370 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29371 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29372
29373 You do not need to have a final &%accept%&, but if you do, you can use a
29374 &%message%& modifier to specify custom text that is sent as part of the 221
29375 response to QUIT.
29376
29377 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29378 failure (for example, failure to open a log file, or when Exim is bombing out
29379 because it has detected an unrecoverable error), all SMTP commands from the
29380 client are given temporary error responses until QUIT is received or the
29381 connection is closed. In these special cases, the QUIT ACL does not run.
29382
29383
29384 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29385 .vindex &$acl_smtp_notquit$&
29386 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29387 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29388 trouble, such as being unable to write to its log files, this ACL is not run,
29389 because it might try to do things (such as write to log files) that make the
29390 situation even worse.
29391
29392 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29393 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29394 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29395 and &%warn%&.
29396
29397 .vindex &$smtp_notquit_reason$&
29398 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29399 to a string that indicates the reason for the termination of the SMTP
29400 connection. The possible values are:
29401 .table2
29402 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29403 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29404 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29405 .irow &`connection-lost`&          "The SMTP connection has been lost"
29406 .irow &`data-timeout`&             "Timeout while reading message data"
29407 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29408 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29409 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29410 .irow &`synchronization-error`&    "SMTP synchronization error"
29411 .irow &`tls-failed`&               "TLS failed to start"
29412 .endtable
29413 In most cases when an SMTP connection is closed without having received QUIT,
29414 Exim sends an SMTP response message before actually closing the connection.
29415 With the exception of the &`acl-drop`& case, the default message can be
29416 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29417 &%drop%& verb in another ACL, it is the message from the other ACL that is
29418 used.
29419
29420
29421 .section "Finding an ACL to use" "SECID195"
29422 .cindex "&ACL;" "finding which to use"
29423 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29424 you can use different ACLs in different circumstances. For example,
29425 .code
29426 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29427                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29428 .endd
29429 In the default configuration file there are some example settings for
29430 providing an RFC 4409 message &"submission"& service on port 587 and
29431 an RFC 8314 &"submissions"& service on port 465. You can use a string
29432 expansion like this to choose an ACL for MUAs on these ports which is
29433 more appropriate for this purpose than the default ACL on port 25.
29434
29435 The expanded string does not have to be the name of an ACL in the
29436 configuration file; there are other possibilities. Having expanded the
29437 string, Exim searches for an ACL as follows:
29438
29439 .ilist
29440 If the string begins with a slash, Exim uses it as a filename, and reads its
29441 contents as an ACL. The lines are processed in the same way as lines in the
29442 Exim configuration file. In particular, continuation lines are supported, blank
29443 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29444 If the file does not exist or cannot be read, an error occurs (typically
29445 causing a temporary failure of whatever caused the ACL to be run). For example:
29446 .code
29447 acl_smtp_data = /etc/acls/\
29448   ${lookup{$sender_host_address}lsearch\
29449   {/etc/acllist}{$value}{default}}
29450 .endd
29451 This looks up an ACL file to use on the basis of the host's IP address, falling
29452 back to a default if the lookup fails. If an ACL is successfully read from a
29453 file, it is retained in memory for the duration of the Exim process, so that it
29454 can be re-used without having to re-read the file.
29455 .next
29456 If the string does not start with a slash, and does not contain any spaces,
29457 Exim searches the ACL section of the configuration for an ACL whose name
29458 matches the string.
29459 .next
29460 If no named ACL is found, or if the string contains spaces, Exim parses
29461 the string as an inline ACL. This can save typing in cases where you just
29462 want to have something like
29463 .code
29464 acl_smtp_vrfy = accept
29465 .endd
29466 in order to allow free use of the VRFY command. Such a string may contain
29467 newlines; it is processed in the same way as an ACL that is read from a file.
29468 .endlist
29469
29470
29471
29472
29473 .section "ACL return codes" "SECID196"
29474 .cindex "&ACL;" "return codes"
29475 Except for the QUIT ACL, which does not affect the SMTP return code (see
29476 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29477 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29478 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29479 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29480 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29481 This also causes a 4&'xx'& return code.
29482
29483 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29484 &"deny"&, because there is no mechanism for passing temporary errors to the
29485 submitters of non-SMTP messages.
29486
29487
29488 ACLs that are relevant to message reception may also return &"discard"&. This
29489 has the effect of &"accept"&, but causes either the entire message or an
29490 individual recipient address to be discarded. In other words, it is a
29491 blackholing facility. Use it with care.
29492
29493 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29494 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29495 RCPT ACL is to discard just the one recipient address. If there are no
29496 recipients left when the message's data is received, the DATA ACL is not
29497 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29498 remaining recipients. The &"discard"& return is not permitted for the
29499 &%acl_smtp_predata%& ACL.
29500
29501 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29502 is done on the address and the result determines the SMTP response.
29503
29504
29505 .cindex "&[local_scan()]& function" "when all recipients discarded"
29506 The &[local_scan()]& function is always run, even if there are no remaining
29507 recipients; it may create new recipients.
29508
29509
29510
29511 .section "Unset ACL options" "SECID197"
29512 .cindex "&ACL;" "unset options"
29513 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29514 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29515 not defined at all. For any defined ACL, the default action when control
29516 reaches the end of the ACL statements is &"deny"&.
29517
29518 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29519 these two are ACLs that are used only for their side effects. They cannot be
29520 used to accept or reject anything.
29521
29522 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29523 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29524 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29525 when the ACL is not defined is &"accept"&.
29526
29527 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29528 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29529 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29530 messages over an SMTP connection. For an example, see the ACL in the default
29531 configuration file.
29532
29533
29534
29535
29536 .section "Data for message ACLs" "SECID198"
29537 .cindex "&ACL;" "data for message ACL"
29538 .vindex &$domain$&
29539 .vindex &$local_part$&
29540 .vindex &$sender_address$&
29541 .vindex &$sender_host_address$&
29542 .vindex &$smtp_command$&
29543 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29544 that contain information about the host and the message's sender (for example,
29545 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29546 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29547 &$local_part$& are set from the argument address. The entire SMTP command
29548 is available in &$smtp_command$&.
29549
29550 When an ACL for the AUTH parameter of MAIL is running, the variables that
29551 contain information about the host are set, but &$sender_address$& is not yet
29552 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29553 how it is used.
29554
29555 .vindex "&$message_size$&"
29556 The &$message_size$& variable is set to the value of the SIZE parameter on
29557 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29558 that parameter is not given. The value is updated to the true message size by
29559 the time the final DATA ACL is run (after the message data has been
29560 received).
29561
29562 .vindex "&$rcpt_count$&"
29563 .vindex "&$recipients_count$&"
29564 The &$rcpt_count$& variable increases by one for each RCPT command received.
29565 The &$recipients_count$& variable increases by one each time a RCPT command is
29566 accepted, so while an ACL for RCPT is being processed, it contains the number
29567 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29568 &$rcpt_count$& contains the total number of RCPT commands, and
29569 &$recipients_count$& contains the total number of accepted recipients.
29570
29571
29572
29573
29574
29575 .section "Data for non-message ACLs" "SECTdatfornon"
29576 .cindex "&ACL;" "data for non-message ACL"
29577 .vindex &$smtp_command_argument$&
29578 .vindex &$smtp_command$&
29579 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29580 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29581 and the entire SMTP command is available in &$smtp_command$&.
29582 These variables can be tested using a &%condition%& condition. For example,
29583 here is an ACL for use with AUTH, which insists that either the session is
29584 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29585 does not permit authentication methods that use cleartext passwords on
29586 unencrypted connections.
29587 .code
29588 acl_check_auth:
29589   accept encrypted = *
29590   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29591                      {CRAM-MD5}}
29592   deny   message   = TLS encryption or CRAM-MD5 required
29593 .endd
29594 (Another way of applying this restriction is to arrange for the authenticators
29595 that use cleartext passwords not to be advertised when the connection is not
29596 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29597 option to do this.)
29598
29599
29600
29601 .section "Format of an ACL" "SECID199"
29602 .cindex "&ACL;" "format of"
29603 .cindex "&ACL;" "verbs, definition of"
29604 An individual ACL consists of a number of statements. Each statement starts
29605 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29606 Modifiers can change the way the verb operates, define error and log messages,
29607 set variables, insert delays, and vary the processing of accepted messages.
29608
29609 If all the conditions are met, the verb is obeyed. The same condition may be
29610 used (with different arguments) more than once in the same statement. This
29611 provides a means of specifying an &"and"& conjunction between conditions. For
29612 example:
29613 .code
29614 deny  dnslists = list1.example
29615       dnslists = list2.example
29616 .endd
29617 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29618 the conditions and modifiers when it reaches a condition that fails. What
29619 happens then depends on the verb (and in one case, on a special modifier). Not
29620 all the conditions make sense at every testing point. For example, you cannot
29621 test a sender address in the ACL that is run for a VRFY command.
29622
29623
29624 .section "ACL verbs" "SECID200"
29625 The ACL verbs are as follows:
29626
29627 .ilist
29628 .cindex "&%accept%& ACL verb"
29629 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29630 of the conditions are not met, what happens depends on whether &%endpass%&
29631 appears among the conditions (for syntax see below). If the failing condition
29632 is before &%endpass%&, control is passed to the next ACL statement; if it is
29633 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29634 check a RCPT command:
29635 .code
29636 accept domains = +local_domains
29637        endpass
29638        verify = recipient
29639 .endd
29640 If the recipient domain does not match the &%domains%& condition, control
29641 passes to the next statement. If it does match, the recipient is verified, and
29642 the command is accepted if verification succeeds. However, if verification
29643 fails, the ACL yields &"deny"&, because the failing condition is after
29644 &%endpass%&.
29645
29646 The &%endpass%& feature has turned out to be confusing to many people, so its
29647 use is not recommended nowadays. It is always possible to rewrite an ACL so
29648 that &%endpass%& is not needed, and it is no longer used in the default
29649 configuration.
29650
29651 .cindex "&%message%& ACL modifier" "with &%accept%&"
29652 If a &%message%& modifier appears on an &%accept%& statement, its action
29653 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29654 (when an &%accept%& verb either accepts or passes control to the next
29655 statement), &%message%& can be used to vary the message that is sent when an
29656 SMTP command is accepted. For example, in a RCPT ACL you could have:
29657 .display
29658 &`accept  `&<&'some conditions'&>
29659 &`        message = OK, I will allow you through today`&
29660 .endd
29661 You can specify an SMTP response code, optionally followed by an &"extended
29662 response code"& at the start of the message, but the first digit must be the
29663 same as would be sent by default, which is 2 for an &%accept%& verb.
29664
29665 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29666 an error message that is used when access is denied. This behaviour is retained
29667 for backward compatibility, but current &"best practice"& is to avoid the use
29668 of &%endpass%&.
29669
29670
29671 .next
29672 .cindex "&%defer%& ACL verb"
29673 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29674 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29675 &%defer%& is the same as &%deny%&, because there is no way of sending a
29676 temporary error. For a RCPT command, &%defer%& is much the same as using a
29677 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29678 be used in any ACL, and even for a recipient it might be a simpler approach.
29679
29680
29681 .next
29682 .cindex "&%deny%& ACL verb"
29683 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29684 the conditions are not met, control is passed to the next ACL statement. For
29685 example,
29686 .code
29687 deny dnslists = blackholes.mail-abuse.org
29688 .endd
29689 rejects commands from hosts that are on a DNS black list.
29690
29691
29692 .next
29693 .cindex "&%discard%& ACL verb"
29694 &%discard%&: This verb behaves like &%accept%&, except that it returns
29695 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29696 that are concerned with receiving messages. When all the conditions are true,
29697 the sending entity receives a &"success"& response. However, &%discard%& causes
29698 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29699 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29700 message's recipients are discarded. Recipients that are discarded before DATA
29701 do not appear in the log line when the &%received_recipients%& log selector is set.
29702
29703 If the &%log_message%& modifier is set when &%discard%& operates,
29704 its contents are added to the line that is automatically written to the log.
29705 The &%message%& modifier operates exactly as it does for &%accept%&.
29706
29707
29708 .next
29709 .cindex "&%drop%& ACL verb"
29710 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29711 forcibly closed after the 5&'xx'& error message has been sent. For example:
29712 .code
29713 drop   message   = I don't take more than 20 RCPTs
29714        condition = ${if > {$rcpt_count}{20}}
29715 .endd
29716 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29717 The connection is always dropped after sending a 550 response.
29718
29719 .next
29720 .cindex "&%require%& ACL verb"
29721 &%require%&: If all the conditions are met, control is passed to the next ACL
29722 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29723 example, when checking a RCPT command,
29724 .code
29725 require message = Sender did not verify
29726         verify  = sender
29727 .endd
29728 passes control to subsequent statements only if the message's sender can be
29729 verified. Otherwise, it rejects the command. Note the positioning of the
29730 &%message%& modifier, before the &%verify%& condition. The reason for this is
29731 discussed in section &<<SECTcondmodproc>>&.
29732
29733 .next
29734 .cindex "&%warn%& ACL verb"
29735 &%warn%&: If all the conditions are true, a line specified by the
29736 &%log_message%& modifier is written to Exim's main log. Control always passes
29737 to the next ACL statement. If any condition is false, the log line is not
29738 written. If an identical log line is requested several times in the same
29739 message, only one copy is actually written to the log. If you want to force
29740 duplicates to be written, use the &%logwrite%& modifier instead.
29741
29742 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29743 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29744 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29745 first failing condition. There is more about adding header lines in section
29746 &<<SECTaddheadacl>>&.
29747
29748 If any condition on a &%warn%& statement cannot be completed (that is, there is
29749 some sort of defer), the log line specified by &%log_message%& is not written.
29750 This does not include the case of a forced failure from a lookup, which
29751 is considered to be a successful completion. After a defer, no further
29752 conditions or modifiers in the &%warn%& statement are processed. The incident
29753 is logged, and the ACL continues to be processed, from the next statement
29754 onwards.
29755
29756
29757 .vindex "&$acl_verify_message$&"
29758 When one of the &%warn%& conditions is an address verification that fails, the
29759 text of the verification failure message is in &$acl_verify_message$&. If you
29760 want this logged, you must set it up explicitly. For example:
29761 .code
29762 warn   !verify = sender
29763        log_message = sender verify failed: $acl_verify_message
29764 .endd
29765 .endlist
29766
29767 At the end of each ACL there is an implicit unconditional &%deny%&.
29768
29769 As you can see from the examples above, the conditions and modifiers are
29770 written one to a line, with the first one on the same line as the verb, and
29771 subsequent ones on following lines. If you have a very long condition, you can
29772 continue it onto several physical lines by the usual backslash continuation
29773 mechanism. It is conventional to align the conditions vertically.
29774
29775
29776
29777 .section "ACL variables" "SECTaclvariables"
29778 .cindex "&ACL;" "variables"
29779 There are some special variables that can be set during ACL processing. They
29780 can be used to pass information between different ACLs, different invocations
29781 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29782 transports, and filters that are used to deliver a message. The names of these
29783 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29784 an underscore, but the remainder of the name can be any sequence of
29785 alphanumeric characters and underscores that you choose. There is no limit on
29786 the number of ACL variables. The two sets act as follows:
29787 .ilist
29788 The values of those variables whose names begin with &$acl_c$& persist
29789 throughout an SMTP connection. They are never reset. Thus, a value that is set
29790 while receiving one message is still available when receiving the next message
29791 on the same SMTP connection.
29792 .next
29793 The values of those variables whose names begin with &$acl_m$& persist only
29794 while a message is being received. They are reset afterwards. They are also
29795 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29796 .endlist
29797
29798 When a message is accepted, the current values of all the ACL variables are
29799 preserved with the message and are subsequently made available at delivery
29800 time. The ACL variables are set by a modifier called &%set%&. For example:
29801 .code
29802 accept hosts = whatever
29803        set acl_m4 = some value
29804 accept authenticated = *
29805        set acl_c_auth = yes
29806 .endd
29807 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29808 be set. If you want to set a variable without taking any action, you can use a
29809 &%warn%& verb without any other modifiers or conditions.
29810
29811 .oindex &%strict_acl_vars%&
29812 What happens if a syntactically valid but undefined ACL variable is
29813 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29814 false (the default), an empty string is substituted; if it is true, an
29815 error is generated.
29816
29817 Versions of Exim before 4.64 have a limited set of numbered variables, but
29818 their names are compatible, so there is no problem with upgrading.
29819
29820
29821 .section "Condition and modifier processing" "SECTcondmodproc"
29822 .cindex "&ACL;" "conditions; processing"
29823 .cindex "&ACL;" "modifiers; processing"
29824 An exclamation mark preceding a condition negates its result. For example:
29825 .code
29826 deny   domains = *.dom.example
29827       !verify  = recipient
29828 .endd
29829 causes the ACL to return &"deny"& if the recipient domain ends in
29830 &'dom.example'& and the recipient address cannot be verified. Sometimes
29831 negation can be used on the right-hand side of a condition. For example, these
29832 two statements are equivalent:
29833 .code
29834 deny  hosts = !192.168.3.4
29835 deny !hosts =  192.168.3.4
29836 .endd
29837 However, for many conditions (&%verify%& being a good example), only left-hand
29838 side negation of the whole condition is possible.
29839
29840 The arguments of conditions and modifiers are expanded. A forced failure
29841 of an expansion causes a condition to be ignored, that is, it behaves as if the
29842 condition is true. Consider these two statements:
29843 .code
29844 accept  senders = ${lookup{$host_name}lsearch\
29845                   {/some/file}{$value}fail}
29846 accept  senders = ${lookup{$host_name}lsearch\
29847                   {/some/file}{$value}{}}
29848 .endd
29849 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29850 the returned list is searched, but if the lookup fails the behaviour is
29851 different in the two cases. The &%fail%& in the first statement causes the
29852 condition to be ignored, leaving no further conditions. The &%accept%& verb
29853 therefore succeeds. The second statement, however, generates an empty list when
29854 the lookup fails. No sender can match an empty list, so the condition fails,
29855 and therefore the &%accept%& also fails.
29856
29857 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29858 specify actions that are taken as the conditions for a statement are checked;
29859 others specify text for messages that are used when access is denied or a
29860 warning is generated. The &%control%& modifier affects the way an incoming
29861 message is handled.
29862
29863 The positioning of the modifiers in an ACL statement is important, because the
29864 processing of a verb ceases as soon as its outcome is known. Only those
29865 modifiers that have already been encountered will take effect. For example,
29866 consider this use of the &%message%& modifier:
29867 .code
29868 require message = Can't verify sender
29869         verify  = sender
29870         message = Can't verify recipient
29871         verify  = recipient
29872         message = This message cannot be used
29873 .endd
29874 If sender verification fails, Exim knows that the result of the statement is
29875 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29876 so its text is used as the error message. If sender verification succeeds, but
29877 recipient verification fails, the second message is used. If recipient
29878 verification succeeds, the third message becomes &"current"&, but is never used
29879 because there are no more conditions to cause failure.
29880
29881 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29882 modifier that is used, because all the conditions must be true for rejection to
29883 happen. Specifying more than one &%message%& modifier does not make sense, and
29884 the message can even be specified after all the conditions. For example:
29885 .code
29886 deny   hosts = ...
29887       !senders = *@my.domain.example
29888        message = Invalid sender from client host
29889 .endd
29890 The &"deny"& result does not happen until the end of the statement is reached,
29891 by which time Exim has set up the message.
29892
29893
29894
29895 .section "ACL modifiers" "SECTACLmodi"
29896 .cindex "&ACL;" "modifiers; list of"
29897 The ACL modifiers are as follows:
29898
29899 .vlist
29900 .vitem &*add_header*&&~=&~<&'text'&>
29901 This modifier specifies one or more header lines that are to be added to an
29902 incoming message, assuming, of course, that the message is ultimately
29903 accepted. For details, see section &<<SECTaddheadacl>>&.
29904
29905 .vitem &*continue*&&~=&~<&'text'&>
29906 .cindex "&%continue%& ACL modifier"
29907 .cindex "database" "updating in ACL"
29908 This modifier does nothing of itself, and processing of the ACL always
29909 continues with the next condition or modifier. The value of &%continue%& is in
29910 the side effects of expanding its argument. Typically this could be used to
29911 update a database. It is really just a syntactic tidiness, to avoid having to
29912 write rather ugly lines like this:
29913 .display
29914 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29915 .endd
29916 Instead, all you need is
29917 .display
29918 &`continue = `&<&'some expansion'&>
29919 .endd
29920
29921 .vitem &*control*&&~=&~<&'text'&>
29922 .cindex "&%control%& ACL modifier"
29923 This modifier affects the subsequent processing of the SMTP connection or of an
29924 incoming message that is accepted. The effect of the first type of control
29925 lasts for the duration of the connection, whereas the effect of the second type
29926 lasts only until the current message has been received. The message-specific
29927 controls always apply to the whole message, not to individual recipients,
29928 even if the &%control%& modifier appears in a RCPT ACL.
29929
29930 As there are now quite a few controls that can be applied, they are described
29931 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29932 in several different ways. For example:
29933
29934 . ==== As this is a nested list, any displays it contains must be indented
29935 . ==== as otherwise they are too far to the left. That comment applies only
29936 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29937 . ==== way.
29938
29939 .ilist
29940 It can be at the end of an &%accept%& statement:
29941 .code
29942     accept  ...some conditions
29943             control = queue_only
29944 .endd
29945 In this case, the control is applied when this statement yields &"accept"&, in
29946 other words, when the conditions are all true.
29947
29948 .next
29949 It can be in the middle of an &%accept%& statement:
29950 .code
29951     accept  ...some conditions...
29952             control = queue_only
29953             ...some more conditions...
29954 .endd
29955 If the first set of conditions are true, the control is applied, even if the
29956 statement does not accept because one of the second set of conditions is false.
29957 In this case, some subsequent statement must yield &"accept"& for the control
29958 to be relevant.
29959
29960 .next
29961 It can be used with &%warn%& to apply the control, leaving the
29962 decision about accepting or denying to a subsequent verb. For
29963 example:
29964 .code
29965     warn    ...some conditions...
29966             control = freeze
29967     accept  ...
29968 .endd
29969 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29970 &%logwrite%&, so it does not add anything to the message and does not write a
29971 log entry.
29972
29973 .next
29974 If you want to apply a control unconditionally, you can use it with a
29975 &%require%& verb. For example:
29976 .code
29977     require  control = no_multiline_responses
29978 .endd
29979 .endlist
29980
29981 .vitem &*delay*&&~=&~<&'time'&>
29982 .cindex "&%delay%& ACL modifier"
29983 .oindex "&%-bh%&"
29984 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29985 the time interval before proceeding. However, when testing Exim using the
29986 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29987 output instead). The time is given in the usual Exim notation, and the delay
29988 happens as soon as the modifier is processed. In an SMTP session, pending
29989 output is flushed before the delay is imposed.
29990
29991 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29992 example:
29993 .code
29994 deny    ...some conditions...
29995         delay = 30s
29996 .endd
29997 The delay happens if all the conditions are true, before the statement returns
29998 &"deny"&. Compare this with:
29999 .code
30000 deny    delay = 30s
30001         ...some conditions...
30002 .endd
30003 which waits for 30s before processing the conditions. The &%delay%& modifier
30004 can also be used with &%warn%& and together with &%control%&:
30005 .code
30006 warn    ...some conditions...
30007         delay = 2m
30008         control = freeze
30009 accept  ...
30010 .endd
30011
30012 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30013 responses to several commands are no longer buffered and sent in one packet (as
30014 they would normally be) because all output is flushed before imposing the
30015 delay. This optimization is disabled so that a number of small delays do not
30016 appear to the client as one large aggregated delay that might provoke an
30017 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30018 using a &%control%& modifier to set &%no_delay_flush%&.
30019
30020
30021 .vitem &*endpass*&
30022 .cindex "&%endpass%& ACL modifier"
30023 This modifier, which has no argument, is recognized only in &%accept%& and
30024 &%discard%& statements. It marks the boundary between the conditions whose
30025 failure causes control to pass to the next statement, and the conditions whose
30026 failure causes the ACL to return &"deny"&. This concept has proved to be
30027 confusing to some people, so the use of &%endpass%& is no longer recommended as
30028 &"best practice"&. See the description of &%accept%& above for more details.
30029
30030
30031 .vitem &*log_message*&&~=&~<&'text'&>
30032 .cindex "&%log_message%& ACL modifier"
30033 This modifier sets up a message that is used as part of the log message if the
30034 ACL denies access or a &%warn%& statement's conditions are true. For example:
30035 .code
30036 require log_message = wrong cipher suite $tls_in_cipher
30037         encrypted   = DES-CBC3-SHA
30038 .endd
30039 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30040 example:
30041 .display
30042 &`discard `&<&'some conditions'&>
30043 &`        log_message = Discarded $local_part@$domain because...`&
30044 .endd
30045 When access is denied, &%log_message%& adds to any underlying error message
30046 that may exist because of a condition failure. For example, while verifying a
30047 recipient address, a &':fail:'& redirection might have already set up a
30048 message.
30049
30050 The message may be defined before the conditions to which it applies, because
30051 the string expansion does not happen until Exim decides that access is to be
30052 denied. This means that any variables that are set by the condition are
30053 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30054 variables are set after a DNS black list lookup succeeds. If the expansion of
30055 &%log_message%& fails, or if the result is an empty string, the modifier is
30056 ignored.
30057
30058 .vindex "&$acl_verify_message$&"
30059 If you want to use a &%warn%& statement to log the result of an address
30060 verification, you can use &$acl_verify_message$& to include the verification
30061 error message.
30062
30063 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30064 the start of the logged message. If the same warning log message is requested
30065 more than once while receiving  a single email message, only one copy is
30066 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30067 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30068 is logged for a successful &%warn%& statement.
30069
30070 If &%log_message%& is not present and there is no underlying error message (for
30071 example, from the failure of address verification), but &%message%& is present,
30072 the &%message%& text is used for logging rejections. However, if any text for
30073 logging contains newlines, only the first line is logged. In the absence of
30074 both &%log_message%& and &%message%&, a default built-in message is used for
30075 logging rejections.
30076
30077
30078 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30079 .cindex "&%log_reject_target%& ACL modifier"
30080 .cindex "logging in ACL" "specifying which log"
30081 This modifier makes it possible to specify which logs are used for messages
30082 about ACL rejections. Its argument is a colon-separated list of words that can
30083 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30084 may be empty, in which case a rejection is not logged at all. For example, this
30085 ACL fragment writes no logging information when access is denied:
30086 .display
30087 &`deny `&<&'some conditions'&>
30088 &`     log_reject_target =`&
30089 .endd
30090 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30091 permanent and temporary rejections. Its effect lasts for the rest of the
30092 current ACL.
30093
30094
30095 .vitem &*logwrite*&&~=&~<&'text'&>
30096 .cindex "&%logwrite%& ACL modifier"
30097 .cindex "logging in ACL" "immediate"
30098 This modifier writes a message to a log file as soon as it is encountered when
30099 processing an ACL. (Compare &%log_message%&, which, except in the case of
30100 &%warn%& and &%discard%&, is used only if the ACL statement denies
30101 access.) The &%logwrite%& modifier can be used to log special incidents in
30102 ACLs. For example:
30103 .display
30104 &`accept `&<&'some special conditions'&>
30105 &`       control  = freeze`&
30106 &`       logwrite = froze message because ...`&
30107 .endd
30108 By default, the message is written to the main log. However, it may begin
30109 with a colon, followed by a comma-separated list of log names, and then
30110 another colon, to specify exactly which logs are to be written. For
30111 example:
30112 .code
30113 logwrite = :main,reject: text for main and reject logs
30114 logwrite = :panic: text for panic log only
30115 .endd
30116
30117
30118 .vitem &*message*&&~=&~<&'text'&>
30119 .cindex "&%message%& ACL modifier"
30120 This modifier sets up a text string that is expanded and used as a response
30121 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30122 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30123 there is some complication if &%endpass%& is involved; see the description of
30124 &%accept%& for details.)
30125
30126 The expansion of the message happens at the time Exim decides that the ACL is
30127 to end, not at the time it processes &%message%&. If the expansion fails, or
30128 generates an empty string, the modifier is ignored. Here is an example where
30129 &%message%& must be specified first, because the ACL ends with a rejection if
30130 the &%hosts%& condition fails:
30131 .code
30132 require  message = Host not recognized
30133          hosts = 10.0.0.0/8
30134 .endd
30135 (Once a condition has failed, no further conditions or modifiers are
30136 processed.)
30137
30138 .cindex "SMTP" "error codes"
30139 .oindex "&%smtp_banner%&
30140 For ACLs that are triggered by SMTP commands, the message is returned as part
30141 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30142 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30143 is accepted. In the case of the connect ACL, accepting with a message modifier
30144 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30145 accept message may not contain more than one line (otherwise it will be
30146 truncated at the first newline and a panic logged), and it cannot affect the
30147 EHLO options.
30148
30149 When SMTP is involved, the message may begin with an overriding response code,
30150 consisting of three digits optionally followed by an &"extended response code"&
30151 of the form &'n.n.n'&, each code being followed by a space. For example:
30152 .code
30153 deny  message = 599 1.2.3 Host not welcome
30154       hosts = 192.168.34.0/24
30155 .endd
30156 The first digit of the supplied response code must be the same as would be sent
30157 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30158 access, but for the predata ACL, note that the default success code is 354, not
30159 2&'xx'&.
30160
30161 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30162 the message modifier cannot override the 221 response code.
30163
30164 The text in a &%message%& modifier is literal; any quotes are taken as
30165 literals, but because the string is expanded, backslash escapes are processed
30166 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30167 response.
30168
30169 .vindex "&$acl_verify_message$&"
30170 For ACLs that are called by an &%acl =%& ACL condition, the message is
30171 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30172
30173 If &%message%& is used on a statement that verifies an address, the message
30174 specified overrides any message that is generated by the verification process.
30175 However, the original message is available in the variable
30176 &$acl_verify_message$&, so you can incorporate it into your message if you
30177 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30178 routers to be passed back as part of the SMTP response, you should either not
30179 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30180
30181 For compatibility with previous releases of Exim, a &%message%& modifier that
30182 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30183 modifier, but this usage is now deprecated. However, &%message%& acts only when
30184 all the conditions are true, wherever it appears in an ACL command, whereas
30185 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30186 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30187 effect.
30188
30189
30190 .vitem &*queue*&&~=&~<&'text'&>
30191 .cindex "&%queue%& ACL modifier"
30192 .cindex "named queues" "selecting in ACL"
30193 This modifier specifies the use of a named queue for spool files
30194 for the message.
30195 It can only be used before the message is received (i.e. not in
30196 the DATA ACL).
30197 This could be used, for example, for known high-volume burst sources
30198 of traffic, or for quarantine of messages.
30199 Separate queue-runner processes will be needed for named queues.
30200 If the text after expansion is empty, the default queue is used.
30201
30202
30203 .vitem &*remove_header*&&~=&~<&'text'&>
30204 This modifier specifies one or more header names in a colon-separated list
30205  that are to be removed from an incoming message, assuming, of course, that
30206 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30207
30208
30209 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30210 .cindex "&%set%& ACL modifier"
30211 This modifier puts a value into one of the ACL variables (see section
30212 &<<SECTaclvariables>>&).
30213
30214
30215 .vitem &*udpsend*&&~=&~<&'parameters'&>
30216 .cindex "UDP communications"
30217 This modifier sends a UDP packet, for purposes such as statistics
30218 collection or behaviour monitoring. The parameters are expanded, and
30219 the result of the expansion must be a colon-separated list consisting
30220 of a destination server, port number, and the packet contents. The
30221 server can be specified as a host name or IPv4 or IPv6 address. The
30222 separator can be changed with the usual angle bracket syntax. For
30223 example, you might want to collect information on which hosts connect
30224 when:
30225 .code
30226 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30227              $tod_zulu $sender_host_address
30228 .endd
30229 .endlist
30230
30231
30232
30233
30234 .section "Use of the control modifier" "SECTcontrols"
30235 .cindex "&%control%& ACL modifier"
30236 The &%control%& modifier supports the following settings:
30237
30238 .vlist
30239 .vitem &*control&~=&~allow_auth_unadvertised*&
30240 This modifier allows a client host to use the SMTP AUTH command even when it
30241 has not been advertised in response to EHLO. Furthermore, because there are
30242 apparently some really broken clients that do this, Exim will accept AUTH after
30243 HELO (rather than EHLO) when this control is set. It should be used only if you
30244 really need it, and you should limit its use to those broken clients that do
30245 not work without it. For example:
30246 .code
30247 warn hosts   = 192.168.34.25
30248      control = allow_auth_unadvertised
30249 .endd
30250 Normally, when an Exim server receives an AUTH command, it checks the name of
30251 the authentication mechanism that is given in the command to ensure that it
30252 matches an advertised mechanism. When this control is set, the check that a
30253 mechanism has been advertised is bypassed. Any configured mechanism can be used
30254 by the client. This control is permitted only in the connection and HELO ACLs.
30255
30256
30257 .vitem &*control&~=&~caseful_local_part*& &&&
30258        &*control&~=&~caselower_local_part*&
30259 .cindex "&ACL;" "case of local part in"
30260 .cindex "case of local parts"
30261 .vindex "&$local_part$&"
30262 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30263 (that is, during RCPT processing). By default, the contents of &$local_part$&
30264 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30265 any uppercase letters in the original local part are restored in &$local_part$&
30266 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30267 is encountered.
30268
30269 These controls affect only the current recipient. Moreover, they apply only to
30270 local part handling that takes place directly in the ACL (for example, as a key
30271 in lookups). If a test to verify the recipient is obeyed, the case-related
30272 handling of the local part during the verification is controlled by the router
30273 configuration (see the &%caseful_local_part%& generic router option).
30274
30275 This facility could be used, for example, to add a spam score to local parts
30276 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30277 spam score:
30278 .code
30279 warn  control = caseful_local_part
30280       set acl_m4 = ${eval:\
30281                      $acl_m4 + \
30282                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30283                     }
30284       control = caselower_local_part
30285 .endd
30286 Notice that we put back the lower cased version afterwards, assuming that
30287 is what is wanted for subsequent tests.
30288
30289
30290 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30291 .cindex "&ACL;" "cutthrough routing"
30292 .cindex "cutthrough" "requesting"
30293 This option requests delivery be attempted while the item is being received.
30294
30295 The option is usable in the RCPT ACL.
30296 If enabled for a message received via smtp and routed to an smtp transport,
30297 and only one transport, interface, destination host and port combination
30298 is used for all recipients of the message,
30299 then the delivery connection is made while the receiving connection is open
30300 and data is copied from one to the other.
30301
30302 An attempt to set this option for any recipient but the first
30303 for a mail will be quietly ignored.
30304 If a recipient-verify callout
30305 (with use_sender)
30306 connection is subsequently
30307 requested in the same ACL it is held open and used for
30308 any subsequent recipients and the data,
30309 otherwise one is made after the initial RCPT ACL completes.
30310
30311 Note that routers are used in verify mode,
30312 and cannot depend on content of received headers.
30313 Note also that headers cannot be
30314 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30315 Headers may be modified by routers (subject to the above) and transports.
30316 The &'Received-By:'& header is generated as soon as the body reception starts,
30317 rather than the traditional time after the full message is received;
30318 this will affect the timestamp.
30319
30320 All the usual ACLs are called; if one results in the message being
30321 rejected, all effort spent in delivery (including the costs on
30322 the ultimate destination) will be wasted.
30323 Note that in the case of data-time ACLs this includes the entire
30324 message body.
30325
30326 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30327 of outgoing messages is done, because it sends data to the ultimate destination
30328 before the entire message has been received from the source.
30329 It is not supported for messages received with the SMTP PRDR
30330 or CHUNKING
30331 options in use.
30332
30333 Should the ultimate destination system positively accept or reject the mail,
30334 a corresponding indication is given to the source system and nothing is queued.
30335 If the item is successfully delivered in cutthrough mode
30336 the delivery log lines are tagged with ">>" rather than "=>" and appear
30337 before the acceptance "<=" line.
30338
30339 If there is a temporary error the item is queued for later delivery in the
30340 usual fashion.
30341 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30342 to the control; the default value is &"spool"& and the alternate value
30343 &"pass"& copies an SMTP defer response from the target back to the initiator
30344 and does not queue the message.
30345 Note that this is independent of any recipient verify conditions in the ACL.
30346
30347 Delivery in this mode avoids the generation of a bounce mail to a
30348 (possibly faked)
30349 sender when the destination system is doing content-scan based rejection.
30350
30351
30352 .vitem &*control&~=&~debug/*&<&'options'&>
30353 .cindex "&ACL;" "enabling debug logging"
30354 .cindex "debugging" "enabling from an ACL"
30355 This control turns on debug logging, almost as though Exim had been invoked
30356 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30357 by default called &'debuglog'&.
30358 The filename can be adjusted with the &'tag'& option, which
30359 may access any variables already defined.  The logging may be adjusted with
30360 the &'opts'& option, which takes the same values as the &`-d`& command-line
30361 option.
30362 Logging started this way may be stopped, and the file removed,
30363 with the &'kill'& option.
30364 Some examples (which depend on variables that don't exist in all
30365 contexts):
30366 .code
30367       control = debug
30368       control = debug/tag=.$sender_host_address
30369       control = debug/opts=+expand+acl
30370       control = debug/tag=.$message_exim_id/opts=+expand
30371       control = debug/kill
30372 .endd
30373
30374
30375 .vitem &*control&~=&~dkim_disable_verify*&
30376 .cindex "disable DKIM verify"
30377 .cindex "DKIM" "disable verify"
30378 This control turns off DKIM verification processing entirely.  For details on
30379 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30380
30381
30382 .vitem &*control&~=&~dscp/*&<&'value'&>
30383 .cindex "&ACL;" "setting DSCP value"
30384 .cindex "DSCP" "inbound"
30385 This option causes the DSCP value associated with the socket for the inbound
30386 connection to be adjusted to a given value, given as one of a number of fixed
30387 strings or to numeric value.
30388 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30389 Common values include &`throughput`&, &`mincost`&, and on newer systems
30390 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30391
30392 The outbound packets from Exim will be marked with this value in the header
30393 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30394 that these values will have any effect, not be stripped by networking
30395 equipment, or do much of anything without cooperation with your Network
30396 Engineer and those of all network operators between the source and destination.
30397
30398
30399 .vitem &*control&~=&~enforce_sync*& &&&
30400        &*control&~=&~no_enforce_sync*&
30401 .cindex "SMTP" "synchronization checking"
30402 .cindex "synchronization checking in SMTP"
30403 These controls make it possible to be selective about when SMTP synchronization
30404 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30405 state of the switch (it is true by default). See the description of this option
30406 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30407
30408 The effect of these two controls lasts for the remainder of the SMTP
30409 connection. They can appear in any ACL except the one for the non-SMTP
30410 messages. The most straightforward place to put them is in the ACL defined by
30411 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30412 before the first synchronization check. The expected use is to turn off the
30413 synchronization checks for badly-behaved hosts that you nevertheless need to
30414 work with.
30415
30416
30417 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30418 .cindex "fake defer"
30419 .cindex "defer, fake"
30420 This control works in exactly the same way as &%fakereject%& (described below)
30421 except that it causes an SMTP 450 response after the message data instead of a
30422 550 response. You must take care when using &%fakedefer%& because it causes the
30423 messages to be duplicated when the sender retries. Therefore, you should not
30424 use &%fakedefer%& if the message is to be delivered normally.
30425
30426 .vitem &*control&~=&~fakereject/*&<&'message'&>
30427 .cindex "fake rejection"
30428 .cindex "rejection, fake"
30429 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30430 words, only when an SMTP message is being received. If Exim accepts the
30431 message, instead the final 250 response, a 550 rejection message is sent.
30432 However, Exim proceeds to deliver the message as normal. The control applies
30433 only to the current message, not to any subsequent ones that may be received in
30434 the same SMTP connection.
30435
30436 The text for the 550 response is taken from the &%control%& modifier. If no
30437 message is supplied, the following is used:
30438 .code
30439 550-Your message has been rejected but is being
30440 550-kept for evaluation.
30441 550-If it was a legitimate message, it may still be
30442 550 delivered to the target recipient(s).
30443 .endd
30444 This facility should be used with extreme caution.
30445
30446 .vitem &*control&~=&~freeze*&
30447 .cindex "frozen messages" "forcing in ACL"
30448 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30449 other words, only when a message is being received. If the message is accepted,
30450 it is placed on Exim's queue and frozen. The control applies only to the
30451 current message, not to any subsequent ones that may be received in the same
30452 SMTP connection.
30453
30454 This modifier can optionally be followed by &`/no_tell`&. If the global option
30455 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30456 is told about the freezing), provided all the &*control=freeze*& modifiers that
30457 are obeyed for the current message have the &`/no_tell`& option.
30458
30459 .vitem &*control&~=&~no_delay_flush*&
30460 .cindex "SMTP" "output flushing, disabling for delay"
30461 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30462 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30463 use. This control, as long as it is encountered before the &%delay%& modifier,
30464 disables such output flushing.
30465
30466 .vitem &*control&~=&~no_callout_flush*&
30467 .cindex "SMTP" "output flushing, disabling for callout"
30468 Exim normally flushes SMTP output before performing a callout in an ACL, to
30469 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30470 use. This control, as long as it is encountered before the &%verify%& condition
30471 that causes the callout, disables such output flushing.
30472
30473 .vitem &*control&~=&~no_mbox_unspool*&
30474 This control is available when Exim is compiled with the content scanning
30475 extension. Content scanning may require a copy of the current message, or parts
30476 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30477 or spam scanner. Normally, such copies are deleted when they are no longer
30478 needed. If this control is set, the copies are not deleted. The control applies
30479 only to the current message, not to any subsequent ones that may be received in
30480 the same SMTP connection. It is provided for debugging purposes and is unlikely
30481 to be useful in production.
30482
30483 .vitem &*control&~=&~no_multiline_responses*&
30484 .cindex "multiline responses, suppressing"
30485 This control is permitted for any ACL except the one for non-SMTP messages.
30486 It seems that there are broken clients in use that cannot handle multiline
30487 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30488
30489 If this control is set, multiline SMTP responses from ACL rejections are
30490 suppressed. One way of doing this would have been to put out these responses as
30491 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30492 (&"use multiline responses for more"& it says &-- ha!), and some of the
30493 responses might get close to that. So this facility, which is after all only a
30494 sop to broken clients, is implemented by doing two very easy things:
30495
30496 .ilist
30497 Extra information that is normally output as part of a rejection caused by
30498 sender verification failure is omitted. Only the final line (typically &"sender
30499 verification failed"&) is sent.
30500 .next
30501 If a &%message%& modifier supplies a multiline response, only the first
30502 line is output.
30503 .endlist
30504
30505 The setting of the switch can, of course, be made conditional on the
30506 calling host. Its effect lasts until the end of the SMTP connection.
30507
30508 .vitem &*control&~=&~no_pipelining*&
30509 .cindex "PIPELINING" "suppressing advertising"
30510 This control turns off the advertising of the PIPELINING extension to SMTP in
30511 the current session. To be useful, it must be obeyed before Exim sends its
30512 response to an EHLO command. Therefore, it should normally appear in an ACL
30513 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30514 &%pipelining_advertise_hosts%&.
30515
30516 .vitem &*control&~=&~queue_only*&
30517 .oindex "&%queue_only%&"
30518 .cindex "queueing incoming messages"
30519 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30520 other words, only when a message is being received. If the message is accepted,
30521 it is placed on Exim's queue and left there for delivery by a subsequent queue
30522 runner. No immediate delivery process is started. In other words, it has the
30523 effect as the &%queue_only%& global option. However, the control applies only
30524 to the current message, not to any subsequent ones that may be received in the
30525 same SMTP connection.
30526
30527 .vitem &*control&~=&~submission/*&<&'options'&>
30528 .cindex "message" "submission"
30529 .cindex "submission mode"
30530 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30531 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30532 the current message is a submission from a local MUA. In this case, Exim
30533 operates in &"submission mode"&, and applies certain fixups to the message if
30534 necessary. For example, it adds a &'Date:'& header line if one is not present.
30535 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30536 late (the message has already been created).
30537
30538 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30539 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30540 submission mode; the available options for this control are described there.
30541 The control applies only to the current message, not to any subsequent ones
30542 that may be received in the same SMTP connection.
30543
30544 .vitem &*control&~=&~suppress_local_fixups*&
30545 .cindex "submission fixups, suppressing"
30546 This control applies to locally submitted (non TCP/IP) messages, and is the
30547 complement of &`control = submission`&. It disables the fixups that are
30548 normally applied to locally-submitted messages. Specifically:
30549
30550 .ilist
30551 Any &'Sender:'& header line is left alone (in this respect, it is a
30552 dynamic version of &%local_sender_retain%&).
30553 .next
30554 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30555 .next
30556 There is no check that &'From:'& corresponds to the actual sender.
30557 .endlist ilist
30558
30559 This control may be useful when a remotely-originated message is accepted,
30560 passed to some scanning program, and then re-submitted for delivery. It can be
30561 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30562 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30563 data is read.
30564
30565 &*Note:*& This control applies only to the current message, not to any others
30566 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30567
30568 .vitem &*control&~=&~utf8_downconvert*&
30569 This control enables conversion of UTF-8 in message addresses
30570 to a-label form.
30571 For details see section &<<SECTi18nMTA>>&.
30572 .endlist vlist
30573
30574
30575 .section "Summary of message fixup control" "SECTsummesfix"
30576 All four possibilities for message fixups can be specified:
30577
30578 .ilist
30579 Locally submitted, fixups applied: the default.
30580 .next
30581 Locally submitted, no fixups applied: use
30582 &`control = suppress_local_fixups`&.
30583 .next
30584 Remotely submitted, no fixups applied: the default.
30585 .next
30586 Remotely submitted, fixups applied: use &`control = submission`&.
30587 .endlist
30588
30589
30590
30591 .section "Adding header lines in ACLs" "SECTaddheadacl"
30592 .cindex "header lines" "adding in an ACL"
30593 .cindex "header lines" "position of added lines"
30594 .cindex "&%add_header%& ACL modifier"
30595 The &%add_header%& modifier can be used to add one or more extra header lines
30596 to an incoming message, as in this example:
30597 .code
30598 warn dnslists = sbl.spamhaus.org : \
30599                 dialup.mail-abuse.org
30600      add_header = X-blacklisted-at: $dnslist_domain
30601 .endd
30602 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30603 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30604 receiving a message). The message must ultimately be accepted for
30605 &%add_header%& to have any significant effect. You can use &%add_header%& with
30606 any ACL verb, including &%deny%& (though this is potentially useful only in a
30607 RCPT ACL).
30608
30609 Headers will not be added to the message if the modifier is used in
30610 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30611
30612 Leading and trailing newlines are removed from
30613 the data for the &%add_header%& modifier; if it then
30614 contains one or more newlines that
30615 are not followed by a space or a tab, it is assumed to contain multiple header
30616 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30617 front of any line that is not a valid header line.
30618
30619 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30620 They are added to the message before processing the DATA and MIME ACLs.
30621 However, if an identical header line is requested more than once, only one copy
30622 is actually added to the message. Further header lines may be accumulated
30623 during the DATA and MIME ACLs, after which they are added to the message, again
30624 with duplicates suppressed. Thus, it is possible to add two identical header
30625 lines to an SMTP message, but only if one is added before DATA and one after.
30626 In the case of non-SMTP messages, new headers are accumulated during the
30627 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30628 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30629 are included in the entry that is written to the reject log.
30630
30631 .cindex "header lines" "added; visibility of"
30632 Header lines are not visible in string expansions
30633 of message headers
30634 until they are added to the
30635 message. It follows that header lines defined in the MAIL, RCPT, and predata
30636 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30637 header lines that are added by the DATA or MIME ACLs are not visible in those
30638 ACLs. Because of this restriction, you cannot use header lines as a way of
30639 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30640 this, you can use ACL variables, as described in section
30641 &<<SECTaclvariables>>&.
30642
30643 The list of headers yet to be added is given by the &%$headers_added%& variable.
30644
30645 The &%add_header%& modifier acts immediately as it is encountered during the
30646 processing of an ACL. Notice the difference between these two cases:
30647 .display
30648 &`accept add_header = ADDED: some text`&
30649 &`       `&<&'some condition'&>
30650
30651 &`accept `&<&'some condition'&>
30652 &`       add_header = ADDED: some text`&
30653 .endd
30654 In the first case, the header line is always added, whether or not the
30655 condition is true. In the second case, the header line is added only if the
30656 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30657 ACL statement. All those that are encountered before a condition fails are
30658 honoured.
30659
30660 .cindex "&%warn%& ACL verb"
30661 For compatibility with previous versions of Exim, a &%message%& modifier for a
30662 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30663 effect only if all the conditions are true, even if it appears before some of
30664 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30665 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30666 are present on a &%warn%& verb, both are processed according to their
30667 specifications.
30668
30669 By default, new header lines are added to a message at the end of the existing
30670 header lines. However, you can specify that any particular header line should
30671 be added right at the start (before all the &'Received:'& lines), immediately
30672 after the first block of &'Received:'& lines, or immediately before any line
30673 that is not a &'Received:'& or &'Resent-something:'& header.
30674
30675 This is done by specifying &":at_start:"&, &":after_received:"&, or
30676 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30677 header line, respectively. (Header text cannot start with a colon, as there has
30678 to be a header name first.) For example:
30679 .code
30680 warn add_header = \
30681        :after_received:X-My-Header: something or other...
30682 .endd
30683 If more than one header line is supplied in a single &%add_header%& modifier,
30684 each one is treated independently and can therefore be placed differently. If
30685 you add more than one line at the start, or after the Received: block, they end
30686 up in reverse order.
30687
30688 &*Warning*&: This facility currently applies only to header lines that are
30689 added in an ACL. It does NOT work for header lines that are added in a
30690 system filter or in a router or transport.
30691
30692
30693
30694 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30695 .cindex "header lines" "removing in an ACL"
30696 .cindex "header lines" "position of removed lines"
30697 .cindex "&%remove_header%& ACL modifier"
30698 The &%remove_header%& modifier can be used to remove one or more header lines
30699 from an incoming message, as in this example:
30700 .code
30701 warn   message        = Remove internal headers
30702        remove_header  = x-route-mail1 : x-route-mail2
30703 .endd
30704 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30705 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30706 receiving a message). The message must ultimately be accepted for
30707 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30708 with any ACL verb, including &%deny%&, though this is really not useful for
30709 any verb that doesn't result in a delivered message.
30710
30711 Headers will not be removed from the message if the modifier is used in
30712 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30713
30714 More than one header can be removed at the same time by using a colon separated
30715 list of header names. The header matching is case insensitive. Wildcards are
30716 not permitted, nor is list expansion performed, so you cannot use hostlists to
30717 create a list of headers, however both connection and message variable expansion
30718 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30719 .code
30720 warn   hosts           = +internal_hosts
30721        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30722 warn   message         = Remove internal headers
30723        remove_header   = $acl_c_ihdrs
30724 .endd
30725 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30726 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30727 If multiple header lines match, all are removed.
30728 There is no harm in attempting to remove the same header twice nor in removing
30729 a non-existent header. Further header lines to be removed may be accumulated
30730 during the DATA and MIME ACLs, after which they are removed from the message,
30731 if present. In the case of non-SMTP messages, headers to be removed are
30732 accumulated during the non-SMTP ACLs, and are removed from the message after
30733 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30734 ACL, there really is no effect because there is no logging of what headers
30735 would have been removed.
30736
30737 .cindex "header lines" "removed; visibility of"
30738 Header lines are not visible in string expansions until the DATA phase when it
30739 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30740 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30741 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30742 this restriction, you cannot use header lines as a way of controlling data
30743 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30744 you should instead use ACL variables, as described in section
30745 &<<SECTaclvariables>>&.
30746
30747 The &%remove_header%& modifier acts immediately as it is encountered during the
30748 processing of an ACL. Notice the difference between these two cases:
30749 .display
30750 &`accept remove_header = X-Internal`&
30751 &`       `&<&'some condition'&>
30752
30753 &`accept `&<&'some condition'&>
30754 &`       remove_header = X-Internal`&
30755 .endd
30756 In the first case, the header line is always removed, whether or not the
30757 condition is true. In the second case, the header line is removed only if the
30758 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30759 same ACL statement. All those that are encountered before a condition fails
30760 are honoured.
30761
30762 &*Warning*&: This facility currently applies only to header lines that are
30763 present during ACL processing. It does NOT remove header lines that are added
30764 in a system filter or in a router or transport.
30765
30766
30767
30768
30769 .section "ACL conditions" "SECTaclconditions"
30770 .cindex "&ACL;" "conditions; list of"
30771 Some of the conditions listed in this section are available only when Exim is
30772 compiled with the content-scanning extension. They are included here briefly
30773 for completeness. More detailed descriptions can be found in the discussion on
30774 content scanning in chapter &<<CHAPexiscan>>&.
30775
30776 Not all conditions are relevant in all circumstances. For example, testing
30777 senders and recipients does not make sense in an ACL that is being run as the
30778 result of the arrival of an ETRN command, and checks on message headers can be
30779 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30780 can use the same condition (with different parameters) more than once in the
30781 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30782 The conditions are as follows:
30783
30784
30785 .vlist
30786 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30787 .cindex "&ACL;" "nested"
30788 .cindex "&ACL;" "indirect"
30789 .cindex "&ACL;" "arguments"
30790 .cindex "&%acl%& ACL condition"
30791 The possible values of the argument are the same as for the
30792 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30793 &"accept"& the condition is true; if it returns &"deny"& the condition is
30794 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30795 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30796 condition false. This means that further processing of the &%warn%& verb
30797 ceases, but processing of the ACL continues.
30798
30799 If the argument is a named ACL, up to nine space-separated optional values
30800 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30801 and $acl_narg is set to the count of values.
30802 Previous values of these variables are restored after the call returns.
30803 The name and values are expanded separately.
30804 Note that spaces in complex expansions which are used as arguments
30805 will act as argument separators.
30806
30807 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30808 the connection is dropped. If it returns &"discard"&, the verb must be
30809 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30810 conditions are tested.
30811
30812 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30813 loops. This condition allows you to use different ACLs in different
30814 circumstances. For example, different ACLs can be used to handle RCPT commands
30815 for different local users or different local domains.
30816
30817 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30818 .cindex "&%authenticated%& ACL condition"
30819 .cindex "authentication" "ACL checking"
30820 .cindex "&ACL;" "testing for authentication"
30821 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30822 the name of the authenticator is tested against the list. To test for
30823 authentication by any authenticator, you can set
30824 .code
30825 authenticated = *
30826 .endd
30827
30828 .vitem &*condition&~=&~*&<&'string'&>
30829 .cindex "&%condition%& ACL condition"
30830 .cindex "customizing" "ACL condition"
30831 .cindex "&ACL;" "customized test"
30832 .cindex "&ACL;" "testing, customized"
30833 This feature allows you to make up custom conditions. If the result of
30834 expanding the string is an empty string, the number zero, or one of the strings
30835 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30836 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30837 any other value, some error is assumed to have occurred, and the ACL returns
30838 &"defer"&. However, if the expansion is forced to fail, the condition is
30839 ignored. The effect is to treat it as true, whether it is positive or
30840 negative.
30841
30842 .vitem &*decode&~=&~*&<&'location'&>
30843 .cindex "&%decode%& ACL condition"
30844 This condition is available only when Exim is compiled with the
30845 content-scanning extension, and it is allowed only in the ACL defined by
30846 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30847 If all goes well, the condition is true. It is false only if there are
30848 problems such as a syntax error or a memory shortage. For more details, see
30849 chapter &<<CHAPexiscan>>&.
30850
30851 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30852 .cindex "&%dnslists%& ACL condition"
30853 .cindex "DNS list" "in ACL"
30854 .cindex "black list (DNS)"
30855 .cindex "&ACL;" "testing a DNS list"
30856 This condition checks for entries in DNS black lists. These are also known as
30857 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30858 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30859 different variants of this condition to describe briefly here. See sections
30860 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30861
30862 .vitem &*domains&~=&~*&<&'domain&~list'&>
30863 .cindex "&%domains%& ACL condition"
30864 .cindex "domain" "ACL checking"
30865 .cindex "&ACL;" "testing a recipient domain"
30866 .vindex "&$domain_data$&"
30867 This condition is relevant only after a RCPT command. It checks that the domain
30868 of the recipient address is in the domain list. If percent-hack processing is
30869 enabled, it is done before this test is done. If the check succeeds with a
30870 lookup, the result of the lookup is placed in &$domain_data$& until the next
30871 &%domains%& test.
30872
30873 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30874 use &%domains%& in a DATA ACL.
30875
30876
30877 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30878 .cindex "&%encrypted%& ACL condition"
30879 .cindex "encryption" "checking in an ACL"
30880 .cindex "&ACL;" "testing for encryption"
30881 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30882 name of the cipher suite in use is tested against the list. To test for
30883 encryption without testing for any specific cipher suite(s), set
30884 .code
30885 encrypted = *
30886 .endd
30887
30888
30889 .vitem &*hosts&~=&~*&<&'host&~list'&>
30890 .cindex "&%hosts%& ACL condition"
30891 .cindex "host" "ACL checking"
30892 .cindex "&ACL;" "testing the client host"
30893 This condition tests that the calling host matches the host list. If you have
30894 name lookups or wildcarded host names and IP addresses in the same host list,
30895 you should normally put the IP addresses first. For example, you could have:
30896 .code
30897 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30898 .endd
30899 The lookup in this example uses the host name for its key. This is implied by
30900 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30901 and it wouldn't matter which way round you had these two items.)
30902
30903 The reason for the problem with host names lies in the left-to-right way that
30904 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30905 but when it reaches an item that requires a host name, it fails if it cannot
30906 find a host name to compare with the pattern. If the above list is given in the
30907 opposite order, the &%accept%& statement fails for a host whose name cannot be
30908 found, even if its IP address is 10.9.8.7.
30909
30910 If you really do want to do the name check first, and still recognize the IP
30911 address even if the name lookup fails, you can rewrite the ACL like this:
30912 .code
30913 accept hosts = dbm;/etc/friendly/hosts
30914 accept hosts = 10.9.8.7
30915 .endd
30916 The default action on failing to find the host name is to assume that the host
30917 is not in the list, so the first &%accept%& statement fails. The second
30918 statement can then check the IP address.
30919
30920 .vindex "&$host_data$&"
30921 If a &%hosts%& condition is satisfied by means of a lookup, the result
30922 of the lookup is made available in the &$host_data$& variable. This
30923 allows you, for example, to set up a statement like this:
30924 .code
30925 deny  hosts = net-lsearch;/some/file
30926 message = $host_data
30927 .endd
30928 which gives a custom error message for each denied host.
30929
30930 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30931 .cindex "&%local_parts%& ACL condition"
30932 .cindex "local part" "ACL checking"
30933 .cindex "&ACL;" "testing a local part"
30934 .vindex "&$local_part_data$&"
30935 This condition is relevant only after a RCPT command. It checks that the local
30936 part of the recipient address is in the list. If percent-hack processing is
30937 enabled, it is done before this test. If the check succeeds with a lookup, the
30938 result of the lookup is placed in &$local_part_data$&, which remains set until
30939 the next &%local_parts%& test.
30940
30941 .vitem &*malware&~=&~*&<&'option'&>
30942 .cindex "&%malware%& ACL condition"
30943 .cindex "&ACL;" "virus scanning"
30944 .cindex "&ACL;" "scanning for viruses"
30945 This condition is available only when Exim is compiled with the
30946 content-scanning extension
30947 and only after a DATA command.
30948 It causes the incoming message to be scanned for
30949 viruses. For details, see chapter &<<CHAPexiscan>>&.
30950
30951 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30952 .cindex "&%mime_regex%& ACL condition"
30953 .cindex "&ACL;" "testing by regex matching"
30954 This condition is available only when Exim is compiled with the
30955 content-scanning extension, and it is allowed only in the ACL defined by
30956 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30957 with any of the regular expressions. For details, see chapter
30958 &<<CHAPexiscan>>&.
30959
30960 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30961 .cindex "rate limiting"
30962 This condition can be used to limit the rate at which a user or host submits
30963 messages. Details are given in section &<<SECTratelimiting>>&.
30964
30965 .vitem &*recipients&~=&~*&<&'address&~list'&>
30966 .cindex "&%recipients%& ACL condition"
30967 .cindex "recipient" "ACL checking"
30968 .cindex "&ACL;" "testing a recipient"
30969 This condition is relevant only after a RCPT command. It checks the entire
30970 recipient address against a list of recipients.
30971
30972 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30973 .cindex "&%regex%& ACL condition"
30974 .cindex "&ACL;" "testing by regex matching"
30975 This condition is available only when Exim is compiled with the
30976 content-scanning extension, and is available only in the DATA, MIME, and
30977 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30978 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30979
30980 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30981 .cindex "&%sender_domains%& ACL condition"
30982 .cindex "sender" "ACL checking"
30983 .cindex "&ACL;" "testing a sender domain"
30984 .vindex "&$domain$&"
30985 .vindex "&$sender_address_domain$&"
30986 This condition tests the domain of the sender of the message against the given
30987 domain list. &*Note*&: The domain of the sender address is in
30988 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30989 of this condition. This is an exception to the general rule for testing domain
30990 lists. It is done this way so that, if this condition is used in an ACL for a
30991 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30992 influence the sender checking.
30993
30994 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30995 relaying, because sender addresses are easily, and commonly, forged.
30996
30997 .vitem &*senders&~=&~*&<&'address&~list'&>
30998 .cindex "&%senders%& ACL condition"
30999 .cindex "sender" "ACL checking"
31000 .cindex "&ACL;" "testing a sender"
31001 This condition tests the sender of the message against the given list. To test
31002 for a bounce message, which has an empty sender, set
31003 .code
31004 senders = :
31005 .endd
31006 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31007 relaying, because sender addresses are easily, and commonly, forged.
31008
31009 .vitem &*spam&~=&~*&<&'username'&>
31010 .cindex "&%spam%& ACL condition"
31011 .cindex "&ACL;" "scanning for spam"
31012 This condition is available only when Exim is compiled with the
31013 content-scanning extension. It causes the incoming message to be scanned by
31014 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31015
31016 .vitem &*verify&~=&~certificate*&
31017 .cindex "&%verify%& ACL condition"
31018 .cindex "TLS" "client certificate verification"
31019 .cindex "certificate" "verification of client"
31020 .cindex "&ACL;" "certificate verification"
31021 .cindex "&ACL;" "testing a TLS certificate"
31022 This condition is true in an SMTP session if the session is encrypted, and a
31023 certificate was received from the client, and the certificate was verified. The
31024 server requests a certificate only if the client matches &%tls_verify_hosts%&
31025 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31026
31027 .vitem &*verify&~=&~csa*&
31028 .cindex "CSA verification"
31029 This condition checks whether the sending host (the client) is authorized to
31030 send email. Details of how this works are given in section
31031 &<<SECTverifyCSA>>&.
31032
31033 .vitem &*verify&~=&~header_names_ascii*&
31034 .cindex "&%verify%& ACL condition"
31035 .cindex "&ACL;" "verifying header names only ASCII"
31036 .cindex "header lines" "verifying header names only ASCII"
31037 .cindex "verifying" "header names only ASCII"
31038 This condition is relevant only in an ACL that is run after a message has been
31039 received, that is, in an ACL specified by &%acl_smtp_data%& or
31040 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31041 there are no non-ASCII characters, also excluding control characters.  The
31042 allowable characters are decimal ASCII values 33 through 126.
31043
31044 Exim itself will handle headers with non-ASCII characters, but it can cause
31045 problems for downstream applications, so this option will allow their
31046 detection and rejection in the DATA ACL's.
31047
31048 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31049 .cindex "&%verify%& ACL condition"
31050 .cindex "&ACL;" "verifying sender in the header"
31051 .cindex "header lines" "verifying the sender in"
31052 .cindex "sender" "verifying in header"
31053 .cindex "verifying" "sender in header"
31054 This condition is relevant only in an ACL that is run after a message has been
31055 received, that is, in an ACL specified by &%acl_smtp_data%& or
31056 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31057 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31058 is loosely thought of as a &"sender"& address (hence the name of the test).
31059 However, an address that appears in one of these headers need not be an address
31060 that accepts bounce messages; only sender addresses in envelopes are required
31061 to accept bounces. Therefore, if you use the callout option on this check, you
31062 might want to arrange for a non-empty address in the MAIL command.
31063
31064 Details of address verification and the options are given later, starting at
31065 section &<<SECTaddressverification>>& (callouts are described in section
31066 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31067 condition to restrict it to bounce messages only:
31068 .code
31069 deny    senders = :
31070         message = A valid sender header is required for bounces
31071        !verify  = header_sender
31072 .endd
31073
31074 .vitem &*verify&~=&~header_syntax*&
31075 .cindex "&%verify%& ACL condition"
31076 .cindex "&ACL;" "verifying header syntax"
31077 .cindex "header lines" "verifying syntax"
31078 .cindex "verifying" "header syntax"
31079 This condition is relevant only in an ACL that is run after a message has been
31080 received, that is, in an ACL specified by &%acl_smtp_data%& or
31081 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31082 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31083 and &'Bcc:'&), returning true if there are no problems.
31084 Unqualified addresses (local parts without domains) are
31085 permitted only in locally generated messages and from hosts that match
31086 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31087 appropriate.
31088
31089 Note that this condition is a syntax check only. However, a common spamming
31090 ploy used to be to send syntactically invalid headers such as
31091 .code
31092 To: @
31093 .endd
31094 and this condition can be used to reject such messages, though they are not as
31095 common as they used to be.
31096
31097 .vitem &*verify&~=&~helo*&
31098 .cindex "&%verify%& ACL condition"
31099 .cindex "&ACL;" "verifying HELO/EHLO"
31100 .cindex "HELO" "verifying"
31101 .cindex "EHLO" "verifying"
31102 .cindex "verifying" "EHLO"
31103 .cindex "verifying" "HELO"
31104 This condition is true if a HELO or EHLO command has been received from the
31105 client host, and its contents have been verified. If there has been no previous
31106 attempt to verify the HELO/EHLO contents, it is carried out when this
31107 condition is encountered. See the description of the &%helo_verify_hosts%& and
31108 &%helo_try_verify_hosts%& options for details of how to request verification
31109 independently of this condition, and for detail of the verification.
31110
31111 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31112 option), this condition is always true.
31113
31114
31115 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31116 .cindex "verifying" "not blind"
31117 .cindex "bcc recipients, verifying none"
31118 This condition checks that there are no blind (bcc) recipients in the message.
31119 Every envelope recipient must appear either in a &'To:'& header line or in a
31120 &'Cc:'& header line for this condition to be true. Local parts are checked
31121 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31122 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31123 used only in a DATA or non-SMTP ACL.
31124
31125 .new
31126 There is one possible option, &`case_insensitive`&.  If this is present then
31127 local parts are checked case-insensitively.
31128 .wen
31129
31130 There are, of course, many legitimate messages that make use of blind (bcc)
31131 recipients. This check should not be used on its own for blocking messages.
31132
31133
31134 .vitem &*verify&~=&~recipient/*&<&'options'&>
31135 .cindex "&%verify%& ACL condition"
31136 .cindex "&ACL;" "verifying recipient"
31137 .cindex "recipient" "verifying"
31138 .cindex "verifying" "recipient"
31139 .vindex "&$address_data$&"
31140 This condition is relevant only after a RCPT command. It verifies the current
31141 recipient. Details of address verification are given later, starting at section
31142 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31143 of &$address_data$& is the last value that was set while routing the address.
31144 This applies even if the verification fails. When an address that is being
31145 verified is redirected to a single address, verification continues with the new
31146 address, and in that case, the subsequent value of &$address_data$& is the
31147 value for the child address.
31148
31149 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31150 .cindex "&%verify%& ACL condition"
31151 .cindex "&ACL;" "verifying host reverse lookup"
31152 .cindex "host" "verifying reverse lookup"
31153 This condition ensures that a verified host name has been looked up from the IP
31154 address of the client host. (This may have happened already if the host name
31155 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31156 Verification ensures that the host name obtained from a reverse DNS lookup, or
31157 one of its aliases, does, when it is itself looked up in the DNS, yield the
31158 original IP address.
31159
31160 There is one possible option, &`defer_ok`&.  If this is present and a
31161 DNS operation returns a temporary error, the verify condition succeeds.
31162
31163 If this condition is used for a locally generated message (that is, when there
31164 is no client host involved), it always succeeds.
31165
31166 .vitem &*verify&~=&~sender/*&<&'options'&>
31167 .cindex "&%verify%& ACL condition"
31168 .cindex "&ACL;" "verifying sender"
31169 .cindex "sender" "verifying"
31170 .cindex "verifying" "sender"
31171 This condition is relevant only after a MAIL or RCPT command, or after a
31172 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31173 the message's sender is empty (that is, this is a bounce message), the
31174 condition is true. Otherwise, the sender address is verified.
31175
31176 .vindex "&$address_data$&"
31177 .vindex "&$sender_address_data$&"
31178 If there is data in the &$address_data$& variable at the end of routing, its
31179 value is placed in &$sender_address_data$& at the end of verification. This
31180 value can be used in subsequent conditions and modifiers in the same ACL
31181 statement. It does not persist after the end of the current statement. If you
31182 want to preserve the value for longer, you can save it in an ACL variable.
31183
31184 Details of verification are given later, starting at section
31185 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31186 to avoid doing it more than once per message.
31187
31188 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31189 .cindex "&%verify%& ACL condition"
31190 This is a variation of the previous option, in which a modified address is
31191 verified as a sender.
31192
31193 Note that '/' is legal in local-parts; if the address may have such
31194 (eg. is generated from the received message)
31195 they must be protected from the options parsing by doubling:
31196 .code
31197 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31198 .endd
31199 .endlist
31200
31201
31202
31203 .section "Using DNS lists" "SECTmorednslists"
31204 .cindex "DNS list" "in ACL"
31205 .cindex "black list (DNS)"
31206 .cindex "&ACL;" "testing a DNS list"
31207 In its simplest form, the &%dnslists%& condition tests whether the calling host
31208 is on at least one of a number of DNS lists by looking up the inverted IP
31209 address in one or more DNS domains. (Note that DNS list domains are not mail
31210 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31211 special options instead.) For example, if the calling host's IP
31212 address is 192.168.62.43, and the ACL statement is
31213 .code
31214 deny dnslists = blackholes.mail-abuse.org : \
31215                 dialups.mail-abuse.org
31216 .endd
31217 the following records are looked up:
31218 .code
31219 43.62.168.192.blackholes.mail-abuse.org
31220 43.62.168.192.dialups.mail-abuse.org
31221 .endd
31222 As soon as Exim finds an existing DNS record, processing of the list stops.
31223 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31224 to test that a host is on more than one list (an &"and"& conjunction), you can
31225 use two separate conditions:
31226 .code
31227 deny dnslists = blackholes.mail-abuse.org
31228      dnslists = dialups.mail-abuse.org
31229 .endd
31230 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31231 behaves as if the host does not match the list item, that is, as if the DNS
31232 record does not exist. If there are further items in the DNS list, they are
31233 processed.
31234
31235 This is usually the required action when &%dnslists%& is used with &%deny%&
31236 (which is the most common usage), because it prevents a DNS failure from
31237 blocking mail. However, you can change this behaviour by putting one of the
31238 following special items in the list:
31239 .display
31240 &`+include_unknown `&   behave as if the item is on the list
31241 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31242 &`+defer_unknown   `&   give a temporary error
31243 .endd
31244 .cindex "&`+include_unknown`&"
31245 .cindex "&`+exclude_unknown`&"
31246 .cindex "&`+defer_unknown`&"
31247 Each of these applies to any subsequent items on the list. For example:
31248 .code
31249 deny dnslists = +defer_unknown : foo.bar.example
31250 .endd
31251 Testing the list of domains stops as soon as a match is found. If you want to
31252 warn for one list and block for another, you can use two different statements:
31253 .code
31254 deny  dnslists = blackholes.mail-abuse.org
31255 warn  message  = X-Warn: sending host is on dialups list
31256       dnslists = dialups.mail-abuse.org
31257 .endd
31258 .cindex caching "of dns lookup"
31259 .cindex DNS TTL
31260 DNS list lookups are cached by Exim for the duration of the SMTP session
31261 (but limited by the DNS return TTL value),
31262 so a lookup based on the IP address is done at most once for any incoming
31263 connection (assuming long-enough TTL).
31264 Exim does not share information between multiple incoming
31265 connections (but your local name server cache should be active).
31266
31267 There are a number of DNS lists to choose from, some commercial, some free,
31268 or free for small deployments.  An overview can be found at
31269 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31270
31271
31272
31273 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31274 .cindex "DNS list" "keyed by explicit IP address"
31275 By default, the IP address that is used in a DNS list lookup is the IP address
31276 of the calling host. However, you can specify another IP address by listing it
31277 after the domain name, introduced by a slash. For example:
31278 .code
31279 deny dnslists = black.list.tld/192.168.1.2
31280 .endd
31281 This feature is not very helpful with explicit IP addresses; it is intended for
31282 use with IP addresses that are looked up, for example, the IP addresses of the
31283 MX hosts or nameservers of an email sender address. For an example, see section
31284 &<<SECTmulkeyfor>>& below.
31285
31286
31287
31288
31289 .section "DNS lists keyed on domain names" "SECID202"
31290 .cindex "DNS list" "keyed by domain name"
31291 There are some lists that are keyed on domain names rather than inverted IP
31292 addresses (see, e.g., the &'domain based zones'& link at
31293 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31294 with these lists. You can change the name that is looked up in a DNS list by
31295 listing it after the domain name, introduced by a slash. For example,
31296 .code
31297 deny  message  = Sender's domain is listed at $dnslist_domain
31298       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31299 .endd
31300 This particular example is useful only in ACLs that are obeyed after the
31301 RCPT or DATA commands, when a sender address is available. If (for
31302 example) the message's sender is &'user@tld.example'& the name that is looked
31303 up by this example is
31304 .code
31305 tld.example.dsn.rfc-ignorant.org
31306 .endd
31307 A single &%dnslists%& condition can contain entries for both names and IP
31308 addresses. For example:
31309 .code
31310 deny dnslists = sbl.spamhaus.org : \
31311                 dsn.rfc-ignorant.org/$sender_address_domain
31312 .endd
31313 The first item checks the sending host's IP address; the second checks a domain
31314 name. The whole condition is true if either of the DNS lookups succeeds.
31315
31316
31317
31318
31319 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31320 .cindex "DNS list" "multiple keys for"
31321 The syntax described above for looking up explicitly-defined values (either
31322 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31323 name for the DNS list, what follows the slash can in fact be a list of items.
31324 As with all lists in Exim, the default separator is a colon. However, because
31325 this is a sublist within the list of DNS blacklist domains, it is necessary
31326 either to double the separators like this:
31327 .code
31328 dnslists = black.list.tld/name.1::name.2
31329 .endd
31330 or to change the separator character, like this:
31331 .code
31332 dnslists = black.list.tld/<;name.1;name.2
31333 .endd
31334 If an item in the list is an IP address, it is inverted before the DNS
31335 blacklist domain is appended. If it is not an IP address, no inversion
31336 occurs. Consider this condition:
31337 .code
31338 dnslists = black.list.tld/<;192.168.1.2;a.domain
31339 .endd
31340 The DNS lookups that occur are:
31341 .code
31342 2.1.168.192.black.list.tld
31343 a.domain.black.list.tld
31344 .endd
31345 Once a DNS record has been found (that matches a specific IP return
31346 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31347 are done. If there is a temporary DNS error, the rest of the sublist of domains
31348 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31349 only if no other DNS lookup in this sublist succeeds. In other words, a
31350 successful lookup for any of the items in the sublist overrides a temporary
31351 error for a previous item.
31352
31353 The ability to supply a list of items after the slash is in some sense just a
31354 syntactic convenience. These two examples have the same effect:
31355 .code
31356 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31357 dnslists = black.list.tld/a.domain::b.domain
31358 .endd
31359 However, when the data for the list is obtained from a lookup, the second form
31360 is usually much more convenient. Consider this example:
31361 .code
31362 deny message  = The mail servers for the domain \
31363                 $sender_address_domain \
31364                 are listed at $dnslist_domain ($dnslist_value); \
31365                 see $dnslist_text.
31366      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31367                                    ${lookup dnsdb {>|mxh=\
31368                                    $sender_address_domain} }} }
31369 .endd
31370 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31371 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31372 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31373 of expanding the condition might be something like this:
31374 .code
31375 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31376 .endd
31377 Thus, this example checks whether or not the IP addresses of the sender
31378 domain's mail servers are on the Spamhaus black list.
31379
31380 The key that was used for a successful DNS list lookup is put into the variable
31381 &$dnslist_matched$& (see section &<<SECID204>>&).
31382
31383
31384
31385
31386 .section "Data returned by DNS lists" "SECID203"
31387 .cindex "DNS list" "data returned from"
31388 DNS lists are constructed using address records in the DNS. The original RBL
31389 just used the address 127.0.0.1 on the right hand side of each record, but the
31390 RBL+ list and some other lists use a number of values with different meanings.
31391 The values used on the RBL+ list are:
31392 .display
31393 127.1.0.1  RBL
31394 127.1.0.2  DUL
31395 127.1.0.3  DUL and RBL
31396 127.1.0.4  RSS
31397 127.1.0.5  RSS and RBL
31398 127.1.0.6  RSS and DUL
31399 127.1.0.7  RSS and DUL and RBL
31400 .endd
31401 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31402 different values. Some DNS lists may return more than one address record;
31403 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31404
31405
31406 .section "Variables set from DNS lists" "SECID204"
31407 .cindex "expansion" "variables, set from DNS list"
31408 .cindex "DNS list" "variables set from"
31409 .vindex "&$dnslist_domain$&"
31410 .vindex "&$dnslist_matched$&"
31411 .vindex "&$dnslist_text$&"
31412 .vindex "&$dnslist_value$&"
31413 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31414 the name of the overall domain that matched (for example,
31415 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31416 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31417 the DNS record. When the key is an IP address, it is not reversed in
31418 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31419 cases, for example:
31420 .code
31421 deny dnslists = spamhaus.example
31422 .endd
31423 the key is also available in another variable (in this case,
31424 &$sender_host_address$&). In more complicated cases, however, this is not true.
31425 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31426 might generate a dnslists lookup like this:
31427 .code
31428 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31429 .endd
31430 If this condition succeeds, the value in &$dnslist_matched$& might be
31431 &`192.168.6.7`& (for example).
31432
31433 If more than one address record is returned by the DNS lookup, all the IP
31434 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31435 The variable &$dnslist_text$& contains the contents of any associated TXT
31436 record. For lists such as RBL+ the TXT record for a merged entry is often not
31437 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31438 information.
31439
31440 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31441 &-- although these appear before the condition in the ACL, they are not
31442 expanded until after it has failed. For example:
31443 .code
31444 deny    hosts = !+local_networks
31445         message = $sender_host_address is listed \
31446                   at $dnslist_domain
31447         dnslists = rbl-plus.mail-abuse.example
31448 .endd
31449
31450
31451
31452 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31453 .cindex "DNS list" "matching specific returned data"
31454 You can add an equals sign and an IP address after a &%dnslists%& domain name
31455 in order to restrict its action to DNS records with a matching right hand side.
31456 For example,
31457 .code
31458 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31459 .endd
31460 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31461 any address record is considered to be a match. For the moment, we assume
31462 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31463 describes how multiple records are handled.
31464
31465 More than one IP address may be given for checking, using a comma as a
31466 separator. These are alternatives &-- if any one of them matches, the
31467 &%dnslists%& condition is true. For example:
31468 .code
31469 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31470 .endd
31471 If you want to specify a constraining address list and also specify names or IP
31472 addresses to be looked up, the constraining address list must be specified
31473 first. For example:
31474 .code
31475 deny dnslists = dsn.rfc-ignorant.org\
31476                 =127.0.0.2/$sender_address_domain
31477 .endd
31478
31479 If the character &`&&`& is used instead of &`=`&, the comparison for each
31480 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31481 In other words, the listed addresses are used as bit masks. The comparison is
31482 true if all the bits in the mask are present in the address that is being
31483 tested. For example:
31484 .code
31485 dnslists = a.b.c&0.0.0.3
31486 .endd
31487 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31488 want to test whether one bit or another bit is present (as opposed to both
31489 being present), you must use multiple values. For example:
31490 .code
31491 dnslists = a.b.c&0.0.0.1,0.0.0.2
31492 .endd
31493 matches if the final component of the address is an odd number or two times
31494 an odd number.
31495
31496
31497
31498 .section "Negated DNS matching conditions" "SECID205"
31499 You can supply a negative list of IP addresses as part of a &%dnslists%&
31500 condition. Whereas
31501 .code
31502 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31503 .endd
31504 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31505 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31506 .code
31507 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31508 .endd
31509 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31510 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31511 words, the result of the test is inverted if an exclamation mark appears before
31512 the &`=`& (or the &`&&`&) sign.
31513
31514 &*Note*&: This kind of negation is not the same as negation in a domain,
31515 host, or address list (which is why the syntax is different).
31516
31517 If you are using just one list, the negation syntax does not gain you much. The
31518 previous example is precisely equivalent to
31519 .code
31520 deny  dnslists = a.b.c
31521      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31522 .endd
31523 However, if you are using multiple lists, the negation syntax is clearer.
31524 Consider this example:
31525 .code
31526 deny  dnslists = sbl.spamhaus.org : \
31527                  list.dsbl.org : \
31528                  dnsbl.njabl.org!=127.0.0.3 : \
31529                  relays.ordb.org
31530 .endd
31531 Using only positive lists, this would have to be:
31532 .code
31533 deny  dnslists = sbl.spamhaus.org : \
31534                  list.dsbl.org
31535 deny  dnslists = dnsbl.njabl.org
31536      !dnslists = dnsbl.njabl.org=127.0.0.3
31537 deny  dnslists = relays.ordb.org
31538 .endd
31539 which is less clear, and harder to maintain.
31540
31541
31542
31543
31544 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31545 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31546 thereby providing more than one IP address. When an item in a &%dnslists%& list
31547 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31548 the match to specific results from the DNS lookup, there are two ways in which
31549 the checking can be handled. For example, consider the condition:
31550 .code
31551 dnslists = a.b.c=127.0.0.1
31552 .endd
31553 What happens if the DNS lookup for the incoming IP address yields both
31554 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31555 condition true because at least one given value was found, or is it false
31556 because at least one of the found values was not listed? And how does this
31557 affect negated conditions? Both possibilities are provided for with the help of
31558 additional separators &`==`& and &`=&&`&.
31559
31560 .ilist
31561 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31562 IP addresses matches one of the listed addresses. For the example above, the
31563 condition is true because 127.0.0.1 matches.
31564 .next
31565 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31566 looked up IP addresses matches one of the listed addresses. If the condition is
31567 changed to:
31568 .code
31569 dnslists = a.b.c==127.0.0.1
31570 .endd
31571 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31572 false because 127.0.0.2 is not listed. You would need to have:
31573 .code
31574 dnslists = a.b.c==127.0.0.1,127.0.0.2
31575 .endd
31576 for the condition to be true.
31577 .endlist
31578
31579 When &`!`& is used to negate IP address matching, it inverts the result, giving
31580 the precise opposite of the behaviour above. Thus:
31581 .ilist
31582 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31583 addresses matches one of the listed addresses. Consider:
31584 .code
31585 dnslists = a.b.c!&0.0.0.1
31586 .endd
31587 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31588 false because 127.0.0.1 matches.
31589 .next
31590 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31591 looked up IP address that does not match. Consider:
31592 .code
31593 dnslists = a.b.c!=&0.0.0.1
31594 .endd
31595 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31596 true, because 127.0.0.2 does not match. You would need to have:
31597 .code
31598 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31599 .endd
31600 for the condition to be false.
31601 .endlist
31602 When the DNS lookup yields only a single IP address, there is no difference
31603 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31604
31605
31606
31607
31608 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31609 .cindex "DNS list" "information from merged"
31610 When the facility for restricting the matching IP values in a DNS list is used,
31611 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31612 the true reason for rejection. This happens when lists are merged and the IP
31613 address in the A record is used to distinguish them; unfortunately there is
31614 only one TXT record. One way round this is not to use merged lists, but that
31615 can be inefficient because it requires multiple DNS lookups where one would do
31616 in the vast majority of cases when the host of interest is not on any of the
31617 lists.
31618
31619 A less inefficient way of solving this problem is available. If
31620 two domain names, comma-separated, are given, the second is used first to
31621 do an initial check, making use of any IP value restrictions that are set.
31622 If there is a match, the first domain is used, without any IP value
31623 restrictions, to get the TXT record. As a byproduct of this, there is also
31624 a check that the IP being tested is indeed on the first list. The first
31625 domain is the one that is put in &$dnslist_domain$&. For example:
31626 .code
31627 deny message  = \
31628          rejected because $sender_host_address is blacklisted \
31629          at $dnslist_domain\n$dnslist_text
31630        dnslists = \
31631          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31632          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31633 .endd
31634 For the first blacklist item, this starts by doing a lookup in
31635 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31636 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31637 value, and as long as something is found, it looks for the corresponding TXT
31638 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31639 The second blacklist item is processed similarly.
31640
31641 If you are interested in more than one merged list, the same list must be
31642 given several times, but because the results of the DNS lookups are cached,
31643 the DNS calls themselves are not repeated. For example:
31644 .code
31645 deny dnslists = \
31646          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31647          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31648          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31649          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31650 .endd
31651 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31652 values matches (or if no record is found), this is the only lookup that is
31653 done. Only if there is a match is one of the more specific lists consulted.
31654
31655
31656
31657 .section "DNS lists and IPv6" "SECTmorednslistslast"
31658 .cindex "IPv6" "DNS black lists"
31659 .cindex "DNS list" "IPv6 usage"
31660 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31661 nibble by nibble. For example, if the calling host's IP address is
31662 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31663 .code
31664 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31665   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31666 .endd
31667 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31668 lists contain wildcard records, intended for IPv4, that interact badly with
31669 IPv6. For example, the DNS entry
31670 .code
31671 *.3.some.list.example.    A    127.0.0.1
31672 .endd
31673 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31674 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31675
31676 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31677 &%condition%& condition, as in this example:
31678 .code
31679 deny   condition = ${if isip4{$sender_host_address}}
31680        dnslists  = some.list.example
31681 .endd
31682
31683 If an explicit key is being used for a DNS lookup and it may be an IPv6
31684 address you should specify alternate list separators for both the outer
31685 (DNS list name) list and inner (lookup keys) list:
31686 .code
31687        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31688 .endd
31689
31690 .section "Rate limiting incoming messages" "SECTratelimiting"
31691 .cindex "rate limiting" "client sending"
31692 .cindex "limiting client sending rates"
31693 .oindex "&%smtp_ratelimit_*%&"
31694 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31695 which clients can send email. This is more powerful than the
31696 &%smtp_ratelimit_*%& options, because those options control the rate of
31697 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31698 works across all connections (concurrent and sequential) from the same client
31699 host. The syntax of the &%ratelimit%& condition is:
31700 .display
31701 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31702 .endd
31703 If the average client sending rate is less than &'m'& messages per time
31704 period &'p'& then the condition is false; otherwise it is true.
31705
31706 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31707 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31708 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31709 of &'p'&.
31710
31711 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31712 time interval, for example, &`8h`& for eight hours. A larger time constant
31713 means that it takes Exim longer to forget a client's past behaviour. The
31714 parameter &'m'& is the maximum number of messages that a client is permitted to
31715 send in each time interval. It also specifies the number of messages permitted
31716 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31717 constant, you can allow a client to send more messages in a burst without
31718 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31719 both small, messages must be sent at an even rate.
31720
31721 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31722 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31723 when deploying the &%ratelimit%& ACL condition. The script prints usage
31724 instructions when it is run with no arguments.
31725
31726 The key is used to look up the data for calculating the client's average
31727 sending rate. This data is stored in Exim's spool directory, alongside the
31728 retry and other hints databases. The default key is &$sender_host_address$&,
31729 which means Exim computes the sending rate of each client host IP address.
31730 By changing the key you can change how Exim identifies clients for the purpose
31731 of ratelimiting. For example, to limit the sending rate of each authenticated
31732 user, independent of the computer they are sending from, set the key to
31733 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31734 example, &$authenticated_id$& is only meaningful if the client has
31735 authenticated (which you can check with the &%authenticated%& ACL condition).
31736
31737 The lookup key does not have to identify clients: If you want to limit the
31738 rate at which a recipient receives messages, you can use the key
31739 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31740 ACL.
31741
31742 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31743 specifies what Exim measures the rate of, for example, messages or recipients
31744 or bytes. You can adjust the measurement using the &%unique=%& and/or
31745 &%count=%& options. You can also control when Exim updates the recorded rate
31746 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31747 separated by a slash, like the other parameters. They may appear in any order.
31748
31749 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31750 any options that alter the meaning of the stored data. The limit &'m'& is not
31751 stored, so you can alter the configured maximum rate and Exim will still
31752 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31753 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31754 behaviour. The lookup key is not affected by changes to the update mode and
31755 the &%count=%& option.
31756
31757
31758 .section "Ratelimit options for what is being measured" "ratoptmea"
31759 .cindex "rate limiting" "per_* options"
31760 The &%per_conn%& option limits the client's connection rate. It is not
31761 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31762 &%acl_not_smtp_start%& ACLs.
31763
31764 The &%per_mail%& option limits the client's rate of sending messages. This is
31765 the default if none of the &%per_*%& options is specified. It can be used in
31766 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31767 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31768
31769 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31770 the same ACLs as the &%per_mail%& option, though it is best to use this option
31771 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31772 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31773 in its MAIL command, which may be inaccurate or completely missing. You can
31774 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31775 in kilobytes, megabytes, or gigabytes, respectively.
31776
31777 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31778 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31779 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31780 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31781 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31782 in either case the rate limiting engine will see a message with many
31783 recipients as a large high-speed burst.
31784
31785 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31786 number of different recipients that the client has sent messages to in the
31787 last time period. That is, if the client repeatedly sends messages to the same
31788 recipient, its measured rate is not increased. This option can only be used in
31789 &%acl_smtp_rcpt%&.
31790
31791 The &%per_cmd%& option causes Exim to recompute the rate every time the
31792 condition is processed. This can be used to limit the rate of any SMTP
31793 command. If it is used in multiple ACLs it can limit the aggregate rate of
31794 multiple different commands.
31795
31796 The &%count=%& option can be used to alter how much Exim adds to the client's
31797 measured rate. For example, the &%per_byte%& option is equivalent to
31798 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31799 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31800 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31801
31802 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31803
31804
31805 .section "Ratelimit update modes" "ratoptupd"
31806 .cindex "rate limiting" "reading data without updating"
31807 You can specify one of three options with the &%ratelimit%& condition to
31808 control when its database is updated. This section describes the &%readonly%&
31809 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31810
31811 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31812 previously-computed rate to check against the limit.
31813
31814 For example, you can test the client's sending rate and deny it access (when
31815 it is too fast) in the connect ACL. If the client passes this check then it
31816 can go on to send a message, in which case its recorded rate will be updated
31817 in the MAIL ACL. Subsequent connections from the same client will check this
31818 new rate.
31819 .code
31820 acl_check_connect:
31821  deny ratelimit = 100 / 5m / readonly
31822     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31823                   (max $sender_rate_limit)
31824 # ...
31825 acl_check_mail:
31826  warn ratelimit = 100 / 5m / strict
31827     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31828                   (max $sender_rate_limit)
31829 .endd
31830
31831 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31832 processing a message then it may increase the client's measured rate more than
31833 it should. For example, this will happen if you check the &%per_rcpt%& option
31834 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31835 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31836 multiple update problems by using the &%readonly%& option on later ratelimit
31837 checks.
31838
31839 The &%per_*%& options described above do not make sense in some ACLs. If you
31840 use a &%per_*%& option in an ACL where it is not normally permitted then the
31841 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31842 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31843 next section) so you must specify the &%readonly%& option explicitly.
31844
31845
31846 .section "Ratelimit options for handling fast clients" "ratoptfast"
31847 .cindex "rate limiting" "strict and leaky modes"
31848 If a client's average rate is greater than the maximum, the rate limiting
31849 engine can react in two possible ways, depending on the presence of the
31850 &%strict%& or &%leaky%& update modes. This is independent of the other
31851 counter-measures (such as rejecting the message) that may be specified by the
31852 rest of the ACL.
31853
31854 The &%leaky%& (default) option means that the client's recorded rate is not
31855 updated if it is above the limit. The effect of this is that Exim measures the
31856 client's average rate of successfully sent email,
31857 up to the given limit.
31858 This is appropriate if the countermeasure when the condition is true
31859 consists of refusing the message, and
31860 is generally the better choice if you have clients that retry automatically.
31861 If the action when true is anything more complex then this option is
31862 likely not what is wanted.
31863
31864 The &%strict%& option means that the client's recorded rate is always
31865 updated. The effect of this is that Exim measures the client's average rate
31866 of attempts to send email, which can be much higher than the maximum it is
31867 actually allowed. If the client is over the limit it may be subjected to
31868 counter-measures by the ACL. It must slow down and allow sufficient time to
31869 pass that its computed rate falls below the maximum before it can send email
31870 again. The time (the number of smoothing periods) it must wait and not
31871 attempt to send mail can be calculated with this formula:
31872 .code
31873         ln(peakrate/maxrate)
31874 .endd
31875
31876
31877 .section "Limiting the rate of different events" "ratoptuniq"
31878 .cindex "rate limiting" "counting unique events"
31879 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31880 rate of different events. For example, the &%per_addr%& option uses this
31881 mechanism to count the number of different recipients that the client has
31882 sent messages to in the last time period; it is equivalent to
31883 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31884 measure the rate that a client uses different sender addresses with the
31885 options &`per_mail/unique=$sender_address`&.
31886
31887 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31888 has seen for that key. The whole set is thrown away when it is older than the
31889 rate smoothing period &'p'&, so each different event is counted at most once
31890 per period. In the &%leaky%& update mode, an event that causes the client to
31891 go over the limit is not added to the set, in the same way that the client's
31892 recorded rate is not updated in the same situation.
31893
31894 When you combine the &%unique=%& and &%readonly%& options, the specific
31895 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31896 rate.
31897
31898 The &%unique=%& mechanism needs more space in the ratelimit database than the
31899 other &%ratelimit%& options in order to store the event set. The number of
31900 unique values is potentially as large as the rate limit, so the extra space
31901 required increases with larger limits.
31902
31903 The uniqueification is not perfect: there is a small probability that Exim
31904 will think a new event has happened before. If the sender's rate is less than
31905 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31906 the measured rate can go above the limit, in which case Exim may under-count
31907 events by a significant margin. Fortunately, if the rate is high enough (2.7
31908 times the limit) that the false positive rate goes above 9%, then Exim will
31909 throw away the over-full event set before the measured rate falls below the
31910 limit. Therefore the only harm should be that exceptionally high sending rates
31911 are logged incorrectly; any countermeasures you configure will be as effective
31912 as intended.
31913
31914
31915 .section "Using rate limiting" "useratlim"
31916 Exim's other ACL facilities are used to define what counter-measures are taken
31917 when the rate limit is exceeded. This might be anything from logging a warning
31918 (for example, while measuring existing sending rates in order to define
31919 policy), through time delays to slow down fast senders, up to rejecting the
31920 message. For example:
31921 .code
31922 # Log all senders' rates
31923 warn ratelimit = 0 / 1h / strict
31924      log_message = Sender rate $sender_rate / $sender_rate_period
31925
31926 # Slow down fast senders; note the need to truncate $sender_rate
31927 # at the decimal point.
31928 warn ratelimit = 100 / 1h / per_rcpt / strict
31929      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31930                    $sender_rate_limit }s
31931
31932 # Keep authenticated users under control
31933 deny authenticated = *
31934      ratelimit = 100 / 1d / strict / $authenticated_id
31935
31936 # System-wide rate limit
31937 defer message = Sorry, too busy. Try again later.
31938      ratelimit = 10 / 1s / $primary_hostname
31939
31940 # Restrict incoming rate from each host, with a default
31941 # set using a macro and special cases looked up in a table.
31942 defer message = Sender rate exceeds $sender_rate_limit \
31943                messages per $sender_rate_period
31944      ratelimit = ${lookup {$sender_host_address} \
31945                    cdb {DB/ratelimits.cdb} \
31946                    {$value} {RATELIMIT} }
31947 .endd
31948 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31949 especially with the &%per_rcpt%& option, you may suffer from a performance
31950 bottleneck caused by locking on the ratelimit hints database. Apart from
31951 making your ACLs less complicated, you can reduce the problem by using a
31952 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31953 this means that Exim will lose its hints data after a reboot (including retry
31954 hints, the callout cache, and ratelimit data).
31955
31956
31957
31958 .section "Address verification" "SECTaddressverification"
31959 .cindex "verifying address" "options for"
31960 .cindex "policy control" "address verification"
31961 Several of the &%verify%& conditions described in section
31962 &<<SECTaclconditions>>& cause addresses to be verified. Section
31963 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31964 The verification conditions can be followed by options that modify the
31965 verification process. The options are separated from the keyword and from each
31966 other by slashes, and some of them contain parameters. For example:
31967 .code
31968 verify = sender/callout
31969 verify = recipient/defer_ok/callout=10s,defer_ok
31970 .endd
31971 The first stage of address verification, which always happens, is to run the
31972 address through the routers, in &"verify mode"&. Routers can detect the
31973 difference between verification and routing for delivery, and their actions can
31974 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31975 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31976 The available options are as follows:
31977
31978 .ilist
31979 If the &%callout%& option is specified, successful routing to one or more
31980 remote hosts is followed by a &"callout"& to those hosts as an additional
31981 check. Callouts and their sub-options are discussed in the next section.
31982 .next
31983 If there is a defer error while doing verification routing, the ACL
31984 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31985 options, the condition is forced to be true instead. Note that this is a main
31986 verification option as well as a suboption for callouts.
31987 .next
31988 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31989 discusses the reporting of sender address verification failures.
31990 .next
31991 The &%success_on_redirect%& option causes verification always to succeed
31992 immediately after a successful redirection. By default, if a redirection
31993 generates just one address, that address is also verified. See further
31994 discussion in section &<<SECTredirwhilveri>>&.
31995 .endlist
31996
31997 .cindex "verifying address" "differentiating failures"
31998 .vindex "&$recipient_verify_failure$&"
31999 .vindex "&$sender_verify_failure$&"
32000 .vindex "&$acl_verify_message$&"
32001 After an address verification failure, &$acl_verify_message$& contains the
32002 error message that is associated with the failure. It can be preserved by
32003 coding like this:
32004 .code
32005 warn  !verify = sender
32006        set acl_m0 = $acl_verify_message
32007 .endd
32008 If you are writing your own custom rejection message or log message when
32009 denying access, you can use this variable to include information about the
32010 verification failure.
32011
32012 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32013 appropriate) contains one of the following words:
32014
32015 .ilist
32016 &%qualify%&: The address was unqualified (no domain), and the message
32017 was neither local nor came from an exempted host.
32018 .next
32019 &%route%&: Routing failed.
32020 .next
32021 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32022 occurred at or before the MAIL command (that is, on initial
32023 connection, HELO, or MAIL).
32024 .next
32025 &%recipient%&: The RCPT command in a callout was rejected.
32026 .next
32027 &%postmaster%&: The postmaster check in a callout was rejected.
32028 .endlist
32029
32030 The main use of these variables is expected to be to distinguish between
32031 rejections of MAIL and rejections of RCPT in callouts.
32032
32033 The above variables may also be set after a &*successful*&
32034 address verification to:
32035
32036 .ilist
32037 &%random%&: A random local-part callout succeeded
32038 .endlist
32039
32040
32041
32042
32043 .section "Callout verification" "SECTcallver"
32044 .cindex "verifying address" "by callout"
32045 .cindex "callout" "verification"
32046 .cindex "SMTP" "callout verification"
32047 For non-local addresses, routing verifies the domain, but is unable to do any
32048 checking of the local part. There are situations where some means of verifying
32049 the local part is desirable. One way this can be done is to make an SMTP
32050 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32051 a subsequent host for a recipient address, to see if the host accepts the
32052 address. We use the term &'callout'& to cover both cases. Note that for a
32053 sender address, the callback is not to the client host that is trying to
32054 deliver the message, but to one of the hosts that accepts incoming mail for the
32055 sender's domain.
32056
32057 Exim does not do callouts by default. If you want them to happen, you must
32058 request them by setting appropriate options on the &%verify%& condition, as
32059 described below. This facility should be used with care, because it can add a
32060 lot of resource usage to the cost of verifying an address. However, Exim does
32061 cache the results of callouts, which helps to reduce the cost. Details of
32062 caching are in section &<<SECTcallvercache>>&.
32063
32064 Recipient callouts are usually used only between hosts that are controlled by
32065 the same administration. For example, a corporate gateway host could use
32066 callouts to check for valid recipients on an internal mailserver. A successful
32067 callout does not guarantee that a real delivery to the address would succeed;
32068 on the other hand, a failing callout does guarantee that a delivery would fail.
32069
32070 If the &%callout%& option is present on a condition that verifies an address, a
32071 second stage of verification occurs if the address is successfully routed to
32072 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32073 &(manualroute)& router, where the router specifies the hosts. However, if a
32074 router that does not set up hosts routes to an &(smtp)& transport with a
32075 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32076 &%hosts_override%& set, its hosts are always used, whether or not the router
32077 supplies a host list.
32078 Callouts are only supported on &(smtp)& transports.
32079
32080 The port that is used is taken from the transport, if it is specified and is a
32081 remote transport. (For routers that do verification only, no transport need be
32082 specified.) Otherwise, the default SMTP port is used. If a remote transport
32083 specifies an outgoing interface, this is used; otherwise the interface is not
32084 specified. Likewise, the text that is used for the HELO command is taken from
32085 the transport's &%helo_data%& option; if there is no transport, the value of
32086 &$smtp_active_hostname$& is used.
32087
32088 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32089 test whether a bounce message could be delivered to the sender address. The
32090 following SMTP commands are sent:
32091 .display
32092 &`HELO `&<&'local host name'&>
32093 &`MAIL FROM:<>`&
32094 &`RCPT TO:`&<&'the address to be tested'&>
32095 &`QUIT`&
32096 .endd
32097 LHLO is used instead of HELO if the transport's &%protocol%& option is
32098 set to &"lmtp"&.
32099
32100 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32101 settings.
32102
32103 A recipient callout check is similar. By default, it also uses an empty address
32104 for the sender. This default is chosen because most hosts do not make use of
32105 the sender address when verifying a recipient. Using the same address means
32106 that a single cache entry can be used for each recipient. Some sites, however,
32107 do make use of the sender address when verifying. These are catered for by the
32108 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32109
32110 If the response to the RCPT command is a 2&'xx'& code, the verification
32111 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32112 Exim tries the next host, if any. If there is a problem with all the remote
32113 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32114 &%callout%& option is given, in which case the condition is forced to succeed.
32115
32116 .cindex "SMTP" "output flushing, disabling for callout"
32117 A callout may take a little time. For this reason, Exim normally flushes SMTP
32118 output before performing a callout in an ACL, to avoid unexpected timeouts in
32119 clients when the SMTP PIPELINING extension is in use. The flushing can be
32120 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32121
32122
32123
32124
32125 .section "Additional parameters for callouts" "CALLaddparcall"
32126 .cindex "callout" "additional parameters for"
32127 The &%callout%& option can be followed by an equals sign and a number of
32128 optional parameters, separated by commas. For example:
32129 .code
32130 verify = recipient/callout=10s,defer_ok
32131 .endd
32132 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32133 separate verify options, is retained for backwards compatibility, but is now
32134 deprecated. The additional parameters for &%callout%& are as follows:
32135
32136
32137 .vlist
32138 .vitem <&'a&~time&~interval'&>
32139 .cindex "callout" "timeout, specifying"
32140 This specifies the timeout that applies for the callout attempt to each host.
32141 For example:
32142 .code
32143 verify = sender/callout=5s
32144 .endd
32145 The default is 30 seconds. The timeout is used for each response from the
32146 remote host. It is also used for the initial connection, unless overridden by
32147 the &%connect%& parameter.
32148
32149
32150 .vitem &*connect&~=&~*&<&'time&~interval'&>
32151 .cindex "callout" "connection timeout, specifying"
32152 This parameter makes it possible to set a different (usually smaller) timeout
32153 for making the SMTP connection. For example:
32154 .code
32155 verify = sender/callout=5s,connect=1s
32156 .endd
32157 If not specified, this timeout defaults to the general timeout value.
32158
32159 .vitem &*defer_ok*&
32160 .cindex "callout" "defer, action on"
32161 When this parameter is present, failure to contact any host, or any other kind
32162 of temporary error, is treated as success by the ACL. However, the cache is not
32163 updated in this circumstance.
32164
32165 .vitem &*fullpostmaster*&
32166 .cindex "callout" "full postmaster check"
32167 This operates like the &%postmaster%& option (see below), but if the check for
32168 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32169 accordance with the specification in RFC 2821. The RFC states that the
32170 unqualified address &'postmaster'& should be accepted.
32171
32172
32173 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32174 .cindex "callout" "sender when verifying header"
32175 When verifying addresses in header lines using the &%header_sender%&
32176 verification option, Exim behaves by default as if the addresses are envelope
32177 sender addresses from a message. Callout verification therefore tests to see
32178 whether a bounce message could be delivered, by using an empty address in the
32179 MAIL command. However, it is arguable that these addresses might never be used
32180 as envelope senders, and could therefore justifiably reject bounce messages
32181 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32182 address to use in the MAIL command. For example:
32183 .code
32184 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32185 .endd
32186 This parameter is available only for the &%header_sender%& verification option.
32187
32188
32189 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32190 .cindex "callout" "overall timeout, specifying"
32191 This parameter sets an overall timeout for performing a callout verification.
32192 For example:
32193 .code
32194 verify = sender/callout=5s,maxwait=30s
32195 .endd
32196 This timeout defaults to four times the callout timeout for individual SMTP
32197 commands. The overall timeout applies when there is more than one host that can
32198 be tried. The timeout is checked before trying the next host. This prevents
32199 very long delays if there are a large number of hosts and all are timing out
32200 (for example, when network connections are timing out).
32201
32202
32203 .vitem &*no_cache*&
32204 .cindex "callout" "cache, suppressing"
32205 .cindex "caching callout, suppressing"
32206 When this parameter is given, the callout cache is neither read nor updated.
32207
32208 .vitem &*postmaster*&
32209 .cindex "callout" "postmaster; checking"
32210 When this parameter is set, a successful callout check is followed by a similar
32211 check for the local part &'postmaster'& at the same domain. If this address is
32212 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32213 the postmaster check is recorded in a cache record; if it is a failure, this is
32214 used to fail subsequent callouts for the domain without a connection being
32215 made, until the cache record expires.
32216
32217 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32218 The postmaster check uses an empty sender in the MAIL command by default.
32219 You can use this parameter to do a postmaster check using a different address.
32220 For example:
32221 .code
32222 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32223 .endd
32224 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32225 one overrides. The &%postmaster%& parameter is equivalent to this example:
32226 .code
32227 require  verify = sender/callout=postmaster_mailfrom=
32228 .endd
32229 &*Warning*&: The caching arrangements for postmaster checking do not take
32230 account of the sender address. It is assumed that either the empty address or
32231 a fixed non-empty address will be used. All that Exim remembers is that the
32232 postmaster check for the domain succeeded or failed.
32233
32234
32235 .vitem &*random*&
32236 .cindex "callout" "&""random""& check"
32237 When this parameter is set, before doing the normal callout check, Exim does a
32238 check for a &"random"& local part at the same domain. The local part is not
32239 really random &-- it is defined by the expansion of the option
32240 &%callout_random_local_part%&, which defaults to
32241 .code
32242 $primary_hostname-$tod_epoch-testing
32243 .endd
32244 The idea here is to try to determine whether the remote host accepts all local
32245 parts without checking. If it does, there is no point in doing callouts for
32246 specific local parts. If the &"random"& check succeeds, the result is saved in
32247 a cache record, and used to force the current and subsequent callout checks to
32248 succeed without a connection being made, until the cache record expires.
32249
32250 .vitem &*use_postmaster*&
32251 .cindex "callout" "sender for recipient check"
32252 This parameter applies to recipient callouts only. For example:
32253 .code
32254 deny  !verify = recipient/callout=use_postmaster
32255 .endd
32256 .vindex "&$qualify_domain$&"
32257 It causes a non-empty postmaster address to be used in the MAIL command when
32258 performing the callout for the recipient, and also for a &"random"& check if
32259 that is configured. The local part of the address is &`postmaster`& and the
32260 domain is the contents of &$qualify_domain$&.
32261
32262 .vitem &*use_sender*&
32263 This option applies to recipient callouts only. For example:
32264 .code
32265 require  verify = recipient/callout=use_sender
32266 .endd
32267 It causes the message's actual sender address to be used in the MAIL
32268 command when performing the callout, instead of an empty address. There is no
32269 need to use this option unless you know that the called hosts make use of the
32270 sender when checking recipients. If used indiscriminately, it reduces the
32271 usefulness of callout caching.
32272
32273 .vitem &*hold*&
32274 This option applies to recipient callouts only. For example:
32275 .code
32276 require  verify = recipient/callout=use_sender,hold
32277 .endd
32278 It causes the connection to be held open and used for any further recipients
32279 and for eventual delivery (should that be done quickly).
32280 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32281 when that is used for the connections.
32282 The advantage is only gained if there are no callout cache hits
32283 (which could be enforced by the no_cache option),
32284 if the use_sender option is used,
32285 if neither the random nor the use_postmaster option is used,
32286 and if no other callouts intervene.
32287 .endlist
32288
32289 If you use any of the parameters that set a non-empty sender for the MAIL
32290 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32291 &%use_sender%&), you should think about possible loops. Recipient checking is
32292 usually done between two hosts that are under the same management, and the host
32293 that receives the callouts is not normally configured to do callouts itself.
32294 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32295 these circumstances.
32296
32297 However, if you use a non-empty sender address for a callout to an arbitrary
32298 host, there is the likelihood that the remote host will itself initiate a
32299 callout check back to your host. As it is checking what appears to be a message
32300 sender, it is likely to use an empty address in MAIL, thus avoiding a
32301 callout loop. However, to be on the safe side it would be best to set up your
32302 own ACLs so that they do not do sender verification checks when the recipient
32303 is the address you use for header sender or postmaster callout checking.
32304
32305 Another issue to think about when using non-empty senders for callouts is
32306 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32307 by the sender/recipient combination; thus, for any given recipient, many more
32308 actual callouts are performed than when an empty sender or postmaster is used.
32309
32310
32311
32312
32313 .section "Callout caching" "SECTcallvercache"
32314 .cindex "hints database" "callout cache"
32315 .cindex "callout" "cache, description of"
32316 .cindex "caching" "callout"
32317 Exim caches the results of callouts in order to reduce the amount of resources
32318 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32319 option. A hints database called &"callout"& is used for the cache. Two
32320 different record types are used: one records the result of a callout check for
32321 a specific address, and the other records information that applies to the
32322 entire domain (for example, that it accepts the local part &'postmaster'&).
32323
32324 When an original callout fails, a detailed SMTP error message is given about
32325 the failure. However, for subsequent failures use the cache data, this message
32326 is not available.
32327
32328 The expiry times for negative and positive address cache records are
32329 independent, and can be set by the global options &%callout_negative_expire%&
32330 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32331
32332 If a host gives a negative response to an SMTP connection, or rejects any
32333 commands up to and including
32334 .code
32335 MAIL FROM:<>
32336 .endd
32337 (but not including the MAIL command with a non-empty address),
32338 any callout attempt is bound to fail. Exim remembers such failures in a
32339 domain cache record, which it uses to fail callouts for the domain without
32340 making new connections, until the domain record times out. There are two
32341 separate expiry times for domain cache records:
32342 &%callout_domain_negative_expire%& (default 3h) and
32343 &%callout_domain_positive_expire%& (default 7d).
32344
32345 Domain records expire when the negative expiry time is reached if callouts
32346 cannot be made for the domain, or if the postmaster check failed.
32347 Otherwise, they expire when the positive expiry time is reached. This
32348 ensures that, for example, a host that stops accepting &"random"& local parts
32349 will eventually be noticed.
32350
32351 The callout caching mechanism is based on the domain of the address that is
32352 being tested. If the domain routes to several hosts, it is assumed that their
32353 behaviour will be the same.
32354
32355
32356
32357 .section "Sender address verification reporting" "SECTsenaddver"
32358 .cindex "verifying" "suppressing error details"
32359 See section &<<SECTaddressverification>>& for a general discussion of
32360 verification. When sender verification fails in an ACL, the details of the
32361 failure are given as additional output lines before the 550 response to the
32362 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32363 you might see:
32364 .code
32365 MAIL FROM:<xyz@abc.example>
32366 250 OK
32367 RCPT TO:<pqr@def.example>
32368 550-Verification failed for <xyz@abc.example>
32369 550-Called:   192.168.34.43
32370 550-Sent:     RCPT TO:<xyz@abc.example>
32371 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32372 550 Sender verification failed
32373 .endd
32374 If more than one RCPT command fails in the same way, the details are given
32375 only for the first of them. However, some administrators do not want to send
32376 out this much information. You can suppress the details by adding
32377 &`/no_details`& to the ACL statement that requests sender verification. For
32378 example:
32379 .code
32380 verify = sender/no_details
32381 .endd
32382
32383 .section "Redirection while verifying" "SECTredirwhilveri"
32384 .cindex "verifying" "redirection while"
32385 .cindex "address redirection" "while verifying"
32386 A dilemma arises when a local address is redirected by aliasing or forwarding
32387 during verification: should the generated addresses themselves be verified,
32388 or should the successful expansion of the original address be enough to verify
32389 it? By default, Exim takes the following pragmatic approach:
32390
32391 .ilist
32392 When an incoming address is redirected to just one child address, verification
32393 continues with the child address, and if that fails to verify, the original
32394 verification also fails.
32395 .next
32396 When an incoming address is redirected to more than one child address,
32397 verification does not continue. A success result is returned.
32398 .endlist
32399
32400 This seems the most reasonable behaviour for the common use of aliasing as a
32401 way of redirecting different local parts to the same mailbox. It means, for
32402 example, that a pair of alias entries of the form
32403 .code
32404 A.Wol:   aw123
32405 aw123:   :fail: Gone away, no forwarding address
32406 .endd
32407 work as expected, with both local parts causing verification failure. When a
32408 redirection generates more than one address, the behaviour is more like a
32409 mailing list, where the existence of the alias itself is sufficient for
32410 verification to succeed.
32411
32412 It is possible, however, to change the default behaviour so that all successful
32413 redirections count as successful verifications, however many new addresses are
32414 generated. This is specified by the &%success_on_redirect%& verification
32415 option. For example:
32416 .code
32417 require verify = recipient/success_on_redirect/callout=10s
32418 .endd
32419 In this example, verification succeeds if a router generates a new address, and
32420 the callout does not occur, because no address was routed to a remote host.
32421
32422 When verification is being tested via the &%-bv%& option, the treatment of
32423 redirections is as just described, unless the &%-v%& or any debugging option is
32424 also specified. In that case, full verification is done for every generated
32425 address and a report is output for each of them.
32426
32427
32428
32429 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32430 .cindex "CSA" "verifying"
32431 Client SMTP Authorization is a system that allows a site to advertise
32432 which machines are and are not permitted to send email. This is done by placing
32433 special SRV records in the DNS; these are looked up using the client's HELO
32434 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32435 Authorization checks in Exim are performed by the ACL condition:
32436 .code
32437 verify = csa
32438 .endd
32439 This fails if the client is not authorized. If there is a DNS problem, or if no
32440 valid CSA SRV record is found, or if the client is authorized, the condition
32441 succeeds. These three cases can be distinguished using the expansion variable
32442 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32443 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32444 be likely to cause problems for legitimate email.
32445
32446 The error messages produced by the CSA code include slightly more
32447 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32448 looking up the CSA SRV record, or problems looking up the CSA target
32449 address record. There are four reasons for &$csa_status$& being &"fail"&:
32450
32451 .ilist
32452 The client's host name is explicitly not authorized.
32453 .next
32454 The client's IP address does not match any of the CSA target IP addresses.
32455 .next
32456 The client's host name is authorized but it has no valid target IP addresses
32457 (for example, the target's addresses are IPv6 and the client is using IPv4).
32458 .next
32459 The client's host name has no CSA SRV record but a parent domain has asserted
32460 that all subdomains must be explicitly authorized.
32461 .endlist
32462
32463 The &%csa%& verification condition can take an argument which is the domain to
32464 use for the DNS query. The default is:
32465 .code
32466 verify = csa/$sender_helo_name
32467 .endd
32468 This implementation includes an extension to CSA. If the query domain
32469 is an address literal such as [192.0.2.95], or if it is a bare IP
32470 address, Exim searches for CSA SRV records in the reverse DNS as if
32471 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32472 meaningful to say:
32473 .code
32474 verify = csa/$sender_host_address
32475 .endd
32476 In fact, this is the check that Exim performs if the client does not say HELO.
32477 This extension can be turned off by setting the main configuration option
32478 &%dns_csa_use_reverse%& to be false.
32479
32480 If a CSA SRV record is not found for the domain itself, a search
32481 is performed through its parent domains for a record which might be
32482 making assertions about subdomains. The maximum depth of this search is limited
32483 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32484 default. Exim does not look for CSA SRV records in a top level domain, so the
32485 default settings handle HELO domains as long as seven
32486 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32487 of legitimate HELO domains.
32488
32489 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32490 direct SRV lookups, this is not sufficient because of the extra parent domain
32491 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32492 addresses into lookups in the reverse DNS space. The result of a successful
32493 lookup such as:
32494 .code
32495 ${lookup dnsdb {csa=$sender_helo_name}}
32496 .endd
32497 has two space-separated fields: an authorization code and a target host name.
32498 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32499 authorization required but absent, or &"?"& for unknown.
32500
32501
32502
32503
32504 .section "Bounce address tag validation" "SECTverifyPRVS"
32505 .cindex "BATV, verifying"
32506 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32507 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32508 Genuine incoming bounce messages should therefore always be addressed to
32509 recipients that have a valid tag. This scheme is a way of detecting unwanted
32510 bounce messages caused by sender address forgeries (often called &"collateral
32511 spam"&), because the recipients of such messages do not include valid tags.
32512
32513 There are two expansion items to help with the implementation of the BATV
32514 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32515 the original envelope sender address by using a simple key to add a hash of the
32516 address and some time-based randomizing information. The &%prvs%& expansion
32517 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32518 The syntax of these expansion items is described in section
32519 &<<SECTexpansionitems>>&.
32520 The validity period on signed addresses is seven days.
32521
32522 As an example, suppose the secret per-address keys are stored in an MySQL
32523 database. A query to look up the key for an address could be defined as a macro
32524 like this:
32525 .code
32526 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32527                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32528                 }{$value}}
32529 .endd
32530 Suppose also that the senders who make use of BATV are defined by an address
32531 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32532 use this:
32533 .code
32534 # Bounces: drop unsigned addresses for BATV senders
32535 deny message = This address does not send an unsigned reverse path
32536      senders = :
32537      recipients = +batv_senders
32538
32539 # Bounces: In case of prvs-signed address, check signature.
32540 deny message = Invalid reverse path signature.
32541      senders = :
32542      condition  = ${prvscheck {$local_part@$domain}\
32543                   {PRVSCHECK_SQL}{1}}
32544      !condition = $prvscheck_result
32545 .endd
32546 The first statement rejects recipients for bounce messages that are addressed
32547 to plain BATV sender addresses, because it is known that BATV senders do not
32548 send out messages with plain sender addresses. The second statement rejects
32549 recipients that are prvs-signed, but with invalid signatures (either because
32550 the key is wrong, or the signature has timed out).
32551
32552 A non-prvs-signed address is not rejected by the second statement, because the
32553 &%prvscheck%& expansion yields an empty string if its first argument is not a
32554 prvs-signed address, thus causing the &%condition%& condition to be false. If
32555 the first argument is a syntactically valid prvs-signed address, the yield is
32556 the third string (in this case &"1"&), whether or not the cryptographic and
32557 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32558 of the checks (empty for failure, &"1"& for success).
32559
32560 There is one more issue you must consider when implementing prvs-signing:
32561 you have to ensure that the routers accept prvs-signed addresses and
32562 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32563 router to remove the signature with a configuration along these lines:
32564 .code
32565 batv_redirect:
32566   driver = redirect
32567   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32568 .endd
32569 This works because, if the third argument of &%prvscheck%& is empty, the result
32570 of the expansion of a prvs-signed address is the decoded value of the original
32571 address. This router should probably be the first of your routers that handles
32572 local addresses.
32573
32574 To create BATV-signed addresses in the first place, a transport of this form
32575 can be used:
32576 .code
32577 external_smtp_batv:
32578   driver = smtp
32579   return_path = ${prvs {$return_path} \
32580                        {${lookup mysql{SELECT \
32581                        secret FROM batv_prvs WHERE \
32582                        sender='${quote_mysql:$sender_address}'} \
32583                        {$value}fail}}}
32584 .endd
32585 If no key can be found for the existing return path, no signing takes place.
32586
32587
32588
32589 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32590 .cindex "&ACL;" "relay control"
32591 .cindex "relaying" "control by ACL"
32592 .cindex "policy control" "relay control"
32593 An MTA is said to &'relay'& a message if it receives it from some host and
32594 delivers it directly to another host as a result of a remote address contained
32595 within it. Redirecting a local address via an alias or forward file and then
32596 passing the message on to another host is not relaying,
32597 .cindex "&""percent hack""&"
32598 but a redirection as a result of the &"percent hack"& is.
32599
32600 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32601 A host which is acting as a gateway or an MX backup is concerned with incoming
32602 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32603 a host which is acting as a smart host for a number of clients is concerned
32604 with outgoing relaying from those clients to the Internet at large. Often the
32605 same host is fulfilling both functions,
32606 . ///
32607 . as illustrated in the diagram below,
32608 . ///
32609 but in principle these two kinds of relaying are entirely independent. What is
32610 not wanted is the transmission of mail from arbitrary remote hosts through your
32611 system to arbitrary domains.
32612
32613
32614 You can implement relay control by means of suitable statements in the ACL that
32615 runs for each RCPT command. For convenience, it is often easiest to use
32616 Exim's named list facility to define the domains and hosts involved. For
32617 example, suppose you want to do the following:
32618
32619 .ilist
32620 Deliver a number of domains to mailboxes on the local host (or process them
32621 locally in some other way). Let's say these are &'my.dom1.example'& and
32622 &'my.dom2.example'&.
32623 .next
32624 Relay mail for a number of other domains for which you are the secondary MX.
32625 These might be &'friend1.example'& and &'friend2.example'&.
32626 .next
32627 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32628 Suppose your LAN is 192.168.45.0/24.
32629 .endlist
32630
32631
32632 In the main part of the configuration, you put the following definitions:
32633 .code
32634 domainlist local_domains    = my.dom1.example : my.dom2.example
32635 domainlist relay_to_domains = friend1.example : friend2.example
32636 hostlist   relay_from_hosts = 192.168.45.0/24
32637 .endd
32638 Now you can use these definitions in the ACL that is run for every RCPT
32639 command:
32640 .code
32641 acl_check_rcpt:
32642   accept domains = +local_domains : +relay_to_domains
32643   accept hosts   = +relay_from_hosts
32644 .endd
32645 The first statement accepts any RCPT command that contains an address in
32646 the local or relay domains. For any other domain, control passes to the second
32647 statement, which accepts the command only if it comes from one of the relay
32648 hosts. In practice, you will probably want to make your ACL more sophisticated
32649 than this, for example, by including sender and recipient verification. The
32650 default configuration includes a more comprehensive example, which is described
32651 in chapter &<<CHAPdefconfil>>&.
32652
32653
32654
32655 .section "Checking a relay configuration" "SECTcheralcon"
32656 .cindex "relaying" "checking control of"
32657 You can check the relay characteristics of your configuration in the same way
32658 that you can test any ACL behaviour for an incoming SMTP connection, by using
32659 the &%-bh%& option to run a fake SMTP session with which you interact.
32660 .ecindex IIDacl
32661
32662
32663
32664 . ////////////////////////////////////////////////////////////////////////////
32665 . ////////////////////////////////////////////////////////////////////////////
32666
32667 .chapter "Content scanning at ACL time" "CHAPexiscan"
32668 .scindex IIDcosca "content scanning" "at ACL time"
32669 The extension of Exim to include content scanning at ACL time, formerly known
32670 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32671 was integrated into the main source for Exim release 4.50, and Tom continues to
32672 maintain it. Most of the wording of this chapter is taken from Tom's
32673 specification.
32674
32675 It is also possible to scan the content of messages at other times. The
32676 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32677 scanning after all the ACLs have run. A transport filter can be used to scan
32678 messages at delivery time (see the &%transport_filter%& option, described in
32679 chapter &<<CHAPtransportgeneric>>&).
32680
32681 If you want to include the ACL-time content-scanning features when you compile
32682 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32683 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32684
32685 .ilist
32686 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32687 for all MIME parts for SMTP and non-SMTP messages, respectively.
32688 .next
32689 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32690 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32691 run at the end of message reception (the &%acl_smtp_data%& ACL).
32692 .next
32693 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32694 of messages, or parts of messages, for debugging purposes.
32695 .next
32696 Additional expansion variables that are set in the new ACL and by the new
32697 conditions.
32698 .next
32699 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32700 .endlist
32701
32702 Content-scanning is continually evolving, and new features are still being
32703 added. While such features are still unstable and liable to incompatible
32704 changes, they are made available in Exim by setting options whose names begin
32705 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32706 this manual. You can find out about them by reading the file called
32707 &_doc/experimental.txt_&.
32708
32709 All the content-scanning facilities work on a MBOX copy of the message that is
32710 temporarily created in a file called:
32711 .display
32712 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32713 .endd
32714 The &_.eml_& extension is a friendly hint to virus scanners that they can
32715 expect an MBOX-like structure inside that file. The file is created when the
32716 first content scanning facility is called. Subsequent calls to content
32717 scanning conditions open the same file again. The directory is recursively
32718 removed when the &%acl_smtp_data%& ACL has finished running, unless
32719 .code
32720 control = no_mbox_unspool
32721 .endd
32722 has been encountered. When the MIME ACL decodes files, they are put into the
32723 same directory by default.
32724
32725
32726
32727 .section "Scanning for viruses" "SECTscanvirus"
32728 .cindex "virus scanning"
32729 .cindex "content scanning" "for viruses"
32730 .cindex "content scanning" "the &%malware%& condition"
32731 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32732 It supports a &"generic"& interface to scanners called via the shell, and
32733 specialized interfaces for &"daemon"& type virus scanners, which are resident
32734 in memory and thus are much faster.
32735
32736 .new
32737 Since message data needs to have arrived,
32738 the condition may be only called in ACL defined by
32739 &%acl_smtp_data%&,
32740 &%acl_smtp_data_prdr%&,
32741 &%acl_smtp_mime%& or
32742 &%acl_smtp_dkim%&
32743 .wen
32744
32745 A timeout of 2 minutes is applied to a scanner call (by default);
32746 if it expires then a defer action is taken.
32747
32748 .oindex "&%av_scanner%&"
32749 You can set the &%av_scanner%& option in the main part of the configuration
32750 to specify which scanner to use, together with any additional options that
32751 are needed. The basic syntax is as follows:
32752 .display
32753 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32754 .endd
32755 If you do not set &%av_scanner%&, it defaults to
32756 .code
32757 av_scanner = sophie:/var/run/sophie
32758 .endd
32759 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32760 before use.
32761 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32762 The following scanner types are supported in this release,
32763 though individual ones can be included or not at build time:
32764
32765 .vlist
32766 .vitem &%avast%&
32767 .cindex "virus scanners" "avast"
32768 This is the scanner daemon of Avast. It has been tested with Avast Core
32769 Security (currently at version 2.2.0).
32770 You can get a trial version at &url(https://www.avast.com) or for Linux
32771 at &url(https://www.avast.com/linux-server-antivirus).
32772 This scanner type takes one option,
32773 which can be either a full path to a UNIX socket,
32774 or host and port specifiers separated by white space.
32775 The host may be a name or an IP address; the port is either a
32776 single number or a pair of numbers with a dash between.
32777 A list of options may follow. These options are interpreted on the
32778 Exim's side of the malware scanner, or are given on separate lines to
32779 the daemon as options before the main scan command.
32780
32781 .cindex &`pass_unscanned`& "avast"
32782 If &`pass_unscanned`&
32783 is set, any files the Avast scanner can't scan (e.g.
32784 decompression bombs, or invalid archives) are considered clean. Use with
32785 care.
32786
32787 For example:
32788 .code
32789 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32790 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32791 av_scanner = avast:192.168.2.22 5036
32792 .endd
32793 If you omit the argument, the default path
32794 &_/var/run/avast/scan.sock_&
32795 is used.
32796 If you use a remote host,
32797 you need to make Exim's spool directory available to it,
32798 as the scanner is passed a file path, not file contents.
32799 For information about available commands and their options you may use
32800 .code
32801 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32802     FLAGS
32803     SENSITIVITY
32804     PACK
32805 .endd
32806
32807 If the scanner returns a temporary failure (e.g. license issues, or
32808 permission problems), the message is deferred and a paniclog entry is
32809 written.  The usual &`defer_ok`& option is available.
32810
32811 .vitem &%aveserver%&
32812 .cindex "virus scanners" "Kaspersky"
32813 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32814 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32815 which is the path to the daemon's UNIX socket. The default is shown in this
32816 example:
32817 .code
32818 av_scanner = aveserver:/var/run/aveserver
32819 .endd
32820
32821
32822 .vitem &%clamd%&
32823 .cindex "virus scanners" "clamd"
32824 This daemon-type scanner is GPL and free. You can get it at
32825 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32826 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32827 in the MIME ACL. This is no longer believed to be necessary.
32828
32829 The options are a list of server specifiers, which may be
32830 a UNIX socket specification,
32831 a TCP socket specification,
32832 or a (global) option.
32833
32834 A socket specification consists of a space-separated list.
32835 For a Unix socket the first element is a full path for the socket,
32836 for a TCP socket the first element is the IP address
32837 and the second a port number,
32838 Any further elements are per-server (non-global) options.
32839 These per-server options are supported:
32840 .code
32841 retry=<timespec>        Retry on connect fail
32842 .endd
32843
32844 The &`retry`& option specifies a time after which a single retry for
32845 a failed connect is made.  The default is to not retry.
32846
32847 If a Unix socket file is specified, only one server is supported.
32848
32849 Examples:
32850 .code
32851 av_scanner = clamd:/opt/clamd/socket
32852 av_scanner = clamd:192.0.2.3 1234
32853 av_scanner = clamd:192.0.2.3 1234:local
32854 av_scanner = clamd:192.0.2.3 1234 retry=10s
32855 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32856 .endd
32857 If the value of av_scanner points to a UNIX socket file or contains the
32858 &`local`&
32859 option, then the ClamAV interface will pass a filename containing the data
32860 to be scanned, which should normally result in less I/O happening and be
32861 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32862 Exim does not assume that there is a common filesystem with the remote host.
32863
32864 The final example shows that multiple TCP targets can be specified.  Exim will
32865 randomly use one for each incoming email (i.e. it load balances them).  Note
32866 that only TCP targets may be used if specifying a list of scanners; a UNIX
32867 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32868 unavailable, Exim will try the remaining one(s) until it finds one that works.
32869 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32870 not keep track of scanner state between multiple messages, and the scanner
32871 selection is random, so the message will get logged in the mainlog for each
32872 email that the down scanner gets chosen first (message wrapped to be readable):
32873 .code
32874 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32875    clamd: connection to localhost, port 3310 failed
32876    (Connection refused)
32877 .endd
32878
32879 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32880 contributing the code for this scanner.
32881
32882 .vitem &%cmdline%&
32883 .cindex "virus scanners" "command line interface"
32884 This is the keyword for the generic command line scanner interface. It can be
32885 used to attach virus scanners that are invoked from the shell. This scanner
32886 type takes 3 mandatory options:
32887
32888 .olist
32889 The full path and name of the scanner binary, with all command line options,
32890 and a placeholder (&`%s`&) for the directory to scan.
32891
32892 .next
32893 A regular expression to match against the STDOUT and STDERR output of the
32894 virus scanner. If the expression matches, a virus was found. You must make
32895 absolutely sure that this expression matches on &"virus found"&. This is called
32896 the &"trigger"& expression.
32897
32898 .next
32899 Another regular expression, containing exactly one pair of parentheses, to
32900 match the name of the virus found in the scanners output. This is called the
32901 &"name"& expression.
32902 .endlist olist
32903
32904 For example, Sophos Sweep reports a virus on a line like this:
32905 .code
32906 Virus 'W32/Magistr-B' found in file ./those.bat
32907 .endd
32908 For the trigger expression, we can match the phrase &"found in file"&. For the
32909 name expression, we want to extract the W32/Magistr-B string, so we can match
32910 for the single quotes left and right of it. Altogether, this makes the
32911 configuration setting:
32912 .code
32913 av_scanner = cmdline:\
32914              /path/to/sweep -ss -all -rec -archive %s:\
32915              found in file:'(.+)'
32916 .endd
32917 .vitem &%drweb%&
32918 .cindex "virus scanners" "DrWeb"
32919 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32920 takes one option,
32921 either a full path to a UNIX socket,
32922 or host and port specifiers separated by white space.
32923 The host may be a name or an IP address; the port is either a
32924 single number or a pair of numbers with a dash between.
32925 For example:
32926 .code
32927 av_scanner = drweb:/var/run/drwebd.sock
32928 av_scanner = drweb:192.168.2.20 31337
32929 .endd
32930 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32931 is used. Thanks to Alex Miller for contributing the code for this scanner.
32932
32933 .vitem &%f-protd%&
32934 .cindex "virus scanners" "f-protd"
32935 The f-protd scanner is accessed via HTTP over TCP.
32936 One argument is taken, being a space-separated hostname and port number
32937 (or port-range).
32938 For example:
32939 .code
32940 av_scanner = f-protd:localhost 10200-10204
32941 .endd
32942 If you omit the argument, the default values shown above are used.
32943
32944 .vitem &%f-prot6d%&
32945 .cindex "virus scanners" "f-prot6d"
32946 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32947 One argument is taken, being a space-separated hostname and port number.
32948 For example:
32949 .code
32950 av_scanner = f-prot6d:localhost 10200
32951 .endd
32952 If you omit the argument, the default values show above are used.
32953
32954 .vitem &%fsecure%&
32955 .cindex "virus scanners" "F-Secure"
32956 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32957 argument which is the path to a UNIX socket. For example:
32958 .code
32959 av_scanner = fsecure:/path/to/.fsav
32960 .endd
32961 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32962 Thelmen for contributing the code for this scanner.
32963
32964 .vitem &%kavdaemon%&
32965 .cindex "virus scanners" "Kaspersky"
32966 This is the scanner daemon of Kaspersky Version 4. This version of the
32967 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32968 scanner type takes one option, which is the path to the daemon's UNIX socket.
32969 For example:
32970 .code
32971 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32972 .endd
32973 The default path is &_/var/run/AvpCtl_&.
32974
32975 .vitem &%mksd%&
32976 .cindex "virus scanners" "mksd"
32977 This was a daemon type scanner that is aimed mainly at Polish users,
32978 though some documentation was available in English.
32979 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32980 and this appears to be a candidate for removal from Exim, unless
32981 we are informed of other virus scanners which use the same protocol
32982 to integrate.
32983 The only option for this scanner type is
32984 the maximum number of processes used simultaneously to scan the attachments,
32985 provided that mksd has
32986 been run with at least the same number of child processes. For example:
32987 .code
32988 av_scanner = mksd:2
32989 .endd
32990 You can safely omit this option (the default value is 1).
32991
32992 .vitem &%sock%&
32993 .cindex "virus scanners" "simple socket-connected"
32994 This is a general-purpose way of talking to simple scanner daemons
32995 running on the local machine.
32996 There are four options:
32997 an address (which may be an IP address and port, or the path of a Unix socket),
32998 a commandline to send (may include a single %s which will be replaced with
32999 the path to the mail file to be scanned),
33000 an RE to trigger on from the returned data,
33001 and an RE to extract malware_name from the returned data.
33002 For example:
33003 .code
33004 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33005 .endd
33006 Note that surrounding whitespace is stripped from each option, meaning
33007 there is no way to specify a trailing newline.
33008 The socket specifier and both regular-expressions are required.
33009 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33010 specify an empty element to get this.
33011
33012 .vitem &%sophie%&
33013 .cindex "virus scanners" "Sophos and Sophie"
33014 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33015 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33016 for this scanner type is the path to the UNIX socket that Sophie uses for
33017 client communication. For example:
33018 .code
33019 av_scanner = sophie:/tmp/sophie
33020 .endd
33021 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33022 the option.
33023 .endlist
33024
33025 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33026 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33027 ACL.
33028
33029 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33030 makes it possible to use different scanners. See further below for an example.
33031 The &%malware%& condition caches its results, so when you use it multiple times
33032 for the same message, the actual scanning process is only carried out once.
33033 However, using expandable items in &%av_scanner%& disables this caching, in
33034 which case each use of the &%malware%& condition causes a new scan of the
33035 message.
33036
33037 The &%malware%& condition takes a right-hand argument that is expanded before
33038 use and taken as a list, slash-separated by default.
33039 The first element can then be one of
33040
33041 .ilist
33042 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33043 The condition succeeds if a virus was found, and fail otherwise. This is the
33044 recommended usage.
33045 .next
33046 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33047 the condition fails immediately.
33048 .next
33049 A regular expression, in which case the message is scanned for viruses. The
33050 condition succeeds if a virus is found and its name matches the regular
33051 expression. This allows you to take special actions on certain types of virus.
33052 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33053 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33054 .endlist
33055
33056 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33057 messages even if there is a problem with the virus scanner.
33058 Otherwise, such a problem causes the ACL to defer.
33059
33060 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33061 specify a non-default timeout.  The default is two minutes.
33062 For example:
33063 .code
33064 malware = * / defer_ok / tmo=10s
33065 .endd
33066 A timeout causes the ACL to defer.
33067
33068 .vindex "&$callout_address$&"
33069 When a connection is made to the scanner the expansion variable &$callout_address$&
33070 is set to record the actual address used.
33071
33072 .vindex "&$malware_name$&"
33073 When a virus is found, the condition sets up an expansion variable called
33074 &$malware_name$& that contains the name of the virus. You can use it in a
33075 &%message%& modifier that specifies the error returned to the sender, and/or in
33076 logging data.
33077
33078 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33079 imposed by your anti-virus scanner.
33080
33081 Here is a very simple scanning example:
33082 .code
33083 deny message = This message contains malware ($malware_name)
33084      malware = *
33085 .endd
33086 The next example accepts messages when there is a problem with the scanner:
33087 .code
33088 deny message = This message contains malware ($malware_name)
33089      malware = */defer_ok
33090 .endd
33091 The next example shows how to use an ACL variable to scan with both sophie and
33092 aveserver. It assumes you have set:
33093 .code
33094 av_scanner = $acl_m0
33095 .endd
33096 in the main Exim configuration.
33097 .code
33098 deny message = This message contains malware ($malware_name)
33099      set acl_m0 = sophie
33100      malware = *
33101
33102 deny message = This message contains malware ($malware_name)
33103      set acl_m0 = aveserver
33104      malware = *
33105 .endd
33106
33107
33108 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33109 .cindex "content scanning" "for spam"
33110 .cindex "spam scanning"
33111 .cindex "SpamAssassin"
33112 .cindex "Rspamd"
33113 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33114 score and a report for the message.
33115 Support is also provided for Rspamd.
33116
33117 For more information about installation and configuration of SpamAssassin or
33118 Rspamd refer to their respective websites at
33119 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33120
33121 SpamAssassin can be installed with CPAN by running:
33122 .code
33123 perl -MCPAN -e 'install Mail::SpamAssassin'
33124 .endd
33125 SpamAssassin has its own set of configuration files. Please review its
33126 documentation to see how you can tweak it. The default installation should work
33127 nicely, however.
33128
33129 .oindex "&%spamd_address%&"
33130 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33131 intend to use an instance running on the local host you do not need to set
33132 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33133 you must set the &%spamd_address%& option in the global part of the Exim
33134 configuration as follows (example):
33135 .code
33136 spamd_address = 192.168.99.45 783
33137 .endd
33138 The SpamAssassin protocol relies on a TCP half-close from the client.
33139 If your SpamAssassin client side is running a Linux system with an
33140 iptables firewall, consider setting
33141 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33142 timeout, Exim uses when waiting for a response from the SpamAssassin
33143 server (currently defaulting to 120s).  With a lower value the Linux
33144 connection tracking may consider your half-closed connection as dead too
33145 soon.
33146
33147
33148 To use Rspamd (which by default listens on all local addresses
33149 on TCP port 11333)
33150 you should add &%variant=rspamd%& after the address/port pair, for example:
33151 .code
33152 spamd_address = 127.0.0.1 11333 variant=rspamd
33153 .endd
33154
33155 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33156 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33157 filename instead of an address/port pair:
33158 .code
33159 spamd_address = /var/run/spamd_socket
33160 .endd
33161 You can have multiple &%spamd%& servers to improve scalability. These can
33162 reside on other hardware reachable over the network. To specify multiple
33163 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33164 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33165 .code
33166 spamd_address = 192.168.2.10 783 : \
33167                 192.168.2.11 783 : \
33168                 192.168.2.12 783
33169 .endd
33170 Up to 32 &%spamd%& servers are supported.
33171 When a server fails to respond to the connection attempt, all other
33172 servers are tried until one succeeds. If no server responds, the &%spam%&
33173 condition defers.
33174
33175 Unix and TCP socket specifications may be mixed in any order.
33176 Each element of the list is a list itself, space-separated by default
33177 and changeable in the usual way (&<<SECTlistsepchange>>&);
33178 take care to not double the separator.
33179
33180 For TCP socket specifications a host name or IP (v4 or v6, but
33181 subject to list-separator quoting rules) address can be used,
33182 and the port can be one or a dash-separated pair.
33183 In the latter case, the range is tried in strict order.
33184
33185 Elements after the first for Unix sockets, or second for TCP socket,
33186 are options.
33187 The supported options are:
33188 .code
33189 pri=<priority>      Selection priority
33190 weight=<value>      Selection bias
33191 time=<start>-<end>  Use only between these times of day
33192 retry=<timespec>    Retry on connect fail
33193 tmo=<timespec>      Connection time limit
33194 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33195 .endd
33196
33197 The &`pri`& option specifies a priority for the server within the list,
33198 higher values being tried first.
33199 The default priority is 1.
33200
33201 The &`weight`& option specifies a selection bias.
33202 Within a priority set
33203 servers are queried in a random fashion, weighted by this value.
33204 The default value for selection bias is 1.
33205
33206 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33207 in the local time zone; each element being one or more digits.
33208 Either the seconds or both minutes and seconds, plus the leading &`.`&
33209 characters, may be omitted and will be taken as zero.
33210
33211 Timeout specifications for the &`retry`& and &`tmo`& options
33212 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33213
33214 The &`tmo`& option specifies an overall timeout for communication.
33215 The default value is two minutes.
33216
33217 The &`retry`& option specifies a time after which a single retry for
33218 a failed connect is made.
33219 The default is to not retry.
33220
33221 The &%spamd_address%& variable is expanded before use if it starts with
33222 a dollar sign. In this case, the expansion may return a string that is
33223 used as the list so that multiple spamd servers can be the result of an
33224 expansion.
33225
33226 .vindex "&$callout_address$&"
33227 When a connection is made to the server the expansion variable &$callout_address$&
33228 is set to record the actual address used.
33229
33230 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33231 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33232 .code
33233 deny message = This message was classified as SPAM
33234      spam = joe
33235 .endd
33236 The right-hand side of the &%spam%& condition specifies a name. This is
33237 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33238 to scan using a specific profile, but rather use the SpamAssassin system-wide
33239 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33240 Rspamd does not use this setting. However, you must put something on the
33241 right-hand side.
33242
33243 The name allows you to use per-domain or per-user antispam profiles in
33244 principle, but this is not straightforward in practice, because a message may
33245 have multiple recipients, not necessarily all in the same domain. Because the
33246 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33247 read the contents of the message, the variables &$local_part$& and &$domain$&
33248 are not set.
33249 Careful enforcement of single-recipient messages
33250 (e.g. by responding with defer in the recipient ACL for all recipients
33251 after the first),
33252 or the use of PRDR,
33253 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33254 are needed to use this feature.
33255
33256 The right-hand side of the &%spam%& condition is expanded before being used, so
33257 you can put lookups or conditions there. When the right-hand side evaluates to
33258 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33259
33260
33261 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33262 large ones may cause significant performance degradation. As most spam messages
33263 are quite small, it is recommended that you do not scan the big ones. For
33264 example:
33265 .code
33266 deny message = This message was classified as SPAM
33267      condition = ${if < {$message_size}{10K}}
33268      spam = nobody
33269 .endd
33270
33271 The &%spam%& condition returns true if the threshold specified in the user's
33272 SpamAssassin profile has been matched or exceeded. If you want to use the
33273 &%spam%& condition for its side effects (see the variables below), you can make
33274 it always return &"true"& by appending &`:true`& to the username.
33275
33276 .cindex "spam scanning" "returned variables"
33277 When the &%spam%& condition is run, it sets up a number of expansion
33278 variables.
33279 Except for &$spam_report$&,
33280 these variables are saved with the received message so are
33281 available for use at delivery time.
33282
33283 .vlist
33284 .vitem &$spam_score$&
33285 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33286 for inclusion in log or reject messages.
33287
33288 .vitem &$spam_score_int$&
33289 The spam score of the message, multiplied by ten, as an integer value. For
33290 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33291 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33292 The integer value is useful for numeric comparisons in conditions.
33293
33294 .vitem &$spam_bar$&
33295 A string consisting of a number of &"+"& or &"-"& characters, representing the
33296 integer part of the spam score value. A spam score of 4.4 would have a
33297 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33298 headers, since MUAs can match on such strings. The maximum length of the
33299 spam bar is 50 characters.
33300
33301 .vitem &$spam_report$&
33302 A multiline text table, containing the full SpamAssassin report for the
33303 message. Useful for inclusion in headers or reject messages.
33304 This variable is only usable in a DATA-time ACL.
33305 Beware that SpamAssassin may return non-ASCII characters, especially
33306 when running in country-specific locales, which are not legal
33307 unencoded in headers.
33308
33309 .vitem &$spam_action$&
33310 For SpamAssassin either 'reject' or 'no action' depending on the
33311 spam score versus threshold.
33312 For Rspamd, the recommended action.
33313
33314 .endlist
33315
33316 The &%spam%& condition caches its results unless expansion in
33317 spamd_address was used. If you call it again with the same user name, it
33318 does not scan again, but rather returns the same values as before.
33319
33320 The &%spam%& condition returns DEFER if there is any error while running
33321 the message through SpamAssassin or if the expansion of spamd_address
33322 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33323 statement block), append &`/defer_ok`& to the right-hand side of the
33324 spam condition, like this:
33325 .code
33326 deny message = This message was classified as SPAM
33327      spam    = joe/defer_ok
33328 .endd
33329 This causes messages to be accepted even if there is a problem with &%spamd%&.
33330
33331 Here is a longer, commented example of the use of the &%spam%&
33332 condition:
33333 .code
33334 # put headers in all messages (no matter if spam or not)
33335 warn  spam = nobody:true
33336       add_header = X-Spam-Score: $spam_score ($spam_bar)
33337       add_header = X-Spam-Report: $spam_report
33338
33339 # add second subject line with *SPAM* marker when message
33340 # is over threshold
33341 warn  spam = nobody
33342       add_header = Subject: *SPAM* $h_Subject:
33343
33344 # reject spam at high scores (> 12)
33345 deny  message = This message scored $spam_score spam points.
33346       spam = nobody:true
33347       condition = ${if >{$spam_score_int}{120}{1}{0}}
33348 .endd
33349
33350
33351
33352 .section "Scanning MIME parts" "SECTscanmimepart"
33353 .cindex "content scanning" "MIME parts"
33354 .cindex "MIME content scanning"
33355 .oindex "&%acl_smtp_mime%&"
33356 .oindex "&%acl_not_smtp_mime%&"
33357 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33358 each MIME part of an SMTP message, including multipart types, in the sequence
33359 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33360 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33361 options may both refer to the same ACL if you want the same processing in both
33362 cases.
33363
33364 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33365 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33366 the case of a non-SMTP message. However, a MIME ACL is called only if the
33367 message contains a &'Content-Type:'& header line. When a call to a MIME
33368 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33369 result code is sent to the client. In the case of an SMTP message, the
33370 &%acl_smtp_data%& ACL is not called when this happens.
33371
33372 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33373 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33374 condition to match against the raw MIME part. You can also use the
33375 &%mime_regex%& condition to match against the decoded MIME part (see section
33376 &<<SECTscanregex>>&).
33377
33378 At the start of a MIME ACL, a number of variables are set from the header
33379 information for the relevant MIME part. These are described below. The contents
33380 of the MIME part are not by default decoded into a disk file except for MIME
33381 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33382 part into a disk file, you can use the &%decode%& condition. The general
33383 syntax is:
33384 .display
33385 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33386 .endd
33387 The right hand side is expanded before use. After expansion,
33388 the value can be:
33389
33390 .olist
33391 &"0"& or &"false"&, in which case no decoding is done.
33392 .next
33393 The string &"default"&. In that case, the file is put in the temporary
33394 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33395 a sequential filename consisting of the message id and a sequence number. The
33396 full path and name is available in &$mime_decoded_filename$& after decoding.
33397 .next
33398 A full path name starting with a slash. If the full name is an existing
33399 directory, it is used as a replacement for the default directory. The filename
33400 is then sequentially assigned. If the path does not exist, it is used as
33401 the full path and filename.
33402 .next
33403 If the string does not start with a slash, it is used as the
33404 filename, and the default path is then used.
33405 .endlist
33406 The &%decode%& condition normally succeeds. It is only false for syntax
33407 errors or unusual circumstances such as memory shortages. You can easily decode
33408 a file with its original, proposed filename using
33409 .code
33410 decode = $mime_filename
33411 .endd
33412 However, you should keep in mind that &$mime_filename$& might contain
33413 anything. If you place files outside of the default path, they are not
33414 automatically unlinked.
33415
33416 For RFC822 attachments (these are messages attached to messages, with a
33417 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33418 as for the primary message, only that the &$mime_is_rfc822$& expansion
33419 variable is set (see below). Attached messages are always decoded to disk
33420 before being checked, and the files are unlinked once the check is done.
33421
33422 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33423 used to match regular expressions against raw and decoded MIME parts,
33424 respectively. They are described in section &<<SECTscanregex>>&.
33425
33426 .cindex "MIME content scanning" "returned variables"
33427 The following list describes all expansion variables that are
33428 available in the MIME ACL:
33429
33430 .vlist
33431 .vitem &$mime_boundary$&
33432 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33433 have a boundary string, which is stored in this variable. If the current part
33434 has no boundary parameter in the &'Content-Type:'& header, this variable
33435 contains the empty string.
33436
33437 .vitem &$mime_charset$&
33438 This variable contains the character set identifier, if one was found in the
33439 &'Content-Type:'& header. Examples for charset identifiers are:
33440 .code
33441 us-ascii
33442 gb2312 (Chinese)
33443 iso-8859-1
33444 .endd
33445 Please note that this value is not normalized, so you should do matches
33446 case-insensitively.
33447
33448 .vitem &$mime_content_description$&
33449 This variable contains the normalized content of the &'Content-Description:'&
33450 header. It can contain a human-readable description of the parts content. Some
33451 implementations repeat the filename for attachments here, but they are usually
33452 only used for display purposes.
33453
33454 .vitem &$mime_content_disposition$&
33455 This variable contains the normalized content of the &'Content-Disposition:'&
33456 header. You can expect strings like &"attachment"& or &"inline"& here.
33457
33458 .vitem &$mime_content_id$&
33459 This variable contains the normalized content of the &'Content-ID:'& header.
33460 This is a unique ID that can be used to reference a part from another part.
33461
33462 .vitem &$mime_content_size$&
33463 This variable is set only after the &%decode%& modifier (see above) has been
33464 successfully run. It contains the size of the decoded part in kilobytes. The
33465 size is always rounded up to full kilobytes, so only a completely empty part
33466 has a &$mime_content_size$& of zero.
33467
33468 .vitem &$mime_content_transfer_encoding$&
33469 This variable contains the normalized content of the
33470 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33471 type. Typical values are &"base64"& and &"quoted-printable"&.
33472
33473 .vitem &$mime_content_type$&
33474 If the MIME part has a &'Content-Type:'& header, this variable contains its
33475 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33476 are some examples of popular MIME types, as they may appear in this variable:
33477 .code
33478 text/plain
33479 text/html
33480 application/octet-stream
33481 image/jpeg
33482 audio/midi
33483 .endd
33484 If the MIME part has no &'Content-Type:'& header, this variable contains the
33485 empty string.
33486
33487 .vitem &$mime_decoded_filename$&
33488 This variable is set only after the &%decode%& modifier (see above) has been
33489 successfully run. It contains the full path and filename of the file
33490 containing the decoded data.
33491 .endlist
33492
33493 .cindex "RFC 2047"
33494 .vlist
33495 .vitem &$mime_filename$&
33496 This is perhaps the most important of the MIME variables. It contains a
33497 proposed filename for an attachment, if one was found in either the
33498 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33499 RFC2047
33500 or RFC2231
33501 decoded, but no additional sanity checks are done.
33502  If no filename was
33503 found, this variable contains the empty string.
33504
33505 .vitem &$mime_is_coverletter$&
33506 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33507 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33508 content in the cover letter, while not restricting attachments at all.
33509
33510 The variable contains 1 (true) for a MIME part believed to be part of the
33511 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33512 follows:
33513
33514 .olist
33515 The outermost MIME part of a message is always a cover letter.
33516
33517 .next
33518 If a multipart/alternative or multipart/related MIME part is a cover letter,
33519 so are all MIME subparts within that multipart.
33520
33521 .next
33522 If any other multipart is a cover letter, the first subpart is a cover letter,
33523 and the rest are attachments.
33524
33525 .next
33526 All parts contained within an attachment multipart are attachments.
33527 .endlist olist
33528
33529 As an example, the following will ban &"HTML mail"& (including that sent with
33530 alternative plain text), while allowing HTML files to be attached. HTML
33531 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33532 .code
33533 deny message = HTML mail is not accepted here
33534 !condition = $mime_is_rfc822
33535 condition = $mime_is_coverletter
33536 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33537 .endd
33538 .vitem &$mime_is_multipart$&
33539 This variable has the value 1 (true) when the current part has the main type
33540 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33541 Since multipart entities only serve as containers for other parts, you may not
33542 want to carry out specific actions on them.
33543
33544 .vitem &$mime_is_rfc822$&
33545 This variable has the value 1 (true) if the current part is not a part of the
33546 checked message itself, but part of an attached message. Attached message
33547 decoding is fully recursive.
33548
33549 .vitem &$mime_part_count$&
33550 This variable is a counter that is raised for each processed MIME part. It
33551 starts at zero for the very first part (which is usually a multipart). The
33552 counter is per-message, so it is reset when processing RFC822 attachments (see
33553 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33554 complete, so you can use it in the DATA ACL to determine the number of MIME
33555 parts of a message. For non-MIME messages, this variable contains the value -1.
33556 .endlist
33557
33558
33559
33560 .section "Scanning with regular expressions" "SECTscanregex"
33561 .cindex "content scanning" "with regular expressions"
33562 .cindex "regular expressions" "content scanning with"
33563 You can specify your own custom regular expression matches on the full body of
33564 the message, or on individual MIME parts.
33565
33566 The &%regex%& condition takes one or more regular expressions as arguments and
33567 matches them against the full message (when called in the DATA ACL) or a raw
33568 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33569 linewise, with a maximum line length of 32K characters. That means you cannot
33570 have multiline matches with the &%regex%& condition.
33571
33572 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33573 to 32K of decoded content (the whole content at once, not linewise). If the
33574 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33575 is decoded automatically when &%mime_regex%& is executed (using default path
33576 and filename values). If the decoded data is larger than  32K, only the first
33577 32K characters are checked.
33578
33579 The regular expressions are passed as a colon-separated list. To include a
33580 literal colon, you must double it. Since the whole right-hand side string is
33581 expanded before being used, you must also escape dollar signs and backslashes
33582 with more backslashes, or use the &`\N`& facility to disable expansion.
33583 Here is a simple example that contains two regular expressions:
33584 .code
33585 deny message = contains blacklisted regex ($regex_match_string)
33586      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33587 .endd
33588 The conditions returns true if any one of the regular expressions matches. The
33589 &$regex_match_string$& expansion variable is then set up and contains the
33590 matching regular expression.
33591 The expansion variables &$regex1$& &$regex2$& etc
33592 are set to any substrings captured by the regular expression.
33593
33594 &*Warning*&: With large messages, these conditions can be fairly
33595 CPU-intensive.
33596
33597 .ecindex IIDcosca
33598
33599
33600
33601
33602 . ////////////////////////////////////////////////////////////////////////////
33603 . ////////////////////////////////////////////////////////////////////////////
33604
33605 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33606          "Local scan function"
33607 .scindex IIDlosca "&[local_scan()]& function" "description of"
33608 .cindex "customizing" "input scan using C function"
33609 .cindex "policy control" "by local scan function"
33610 In these days of email worms, viruses, and ever-increasing spam, some sites
33611 want to apply a lot of checking to messages before accepting them.
33612
33613 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33614 passing messages to external virus and spam scanning software. You can also do
33615 a certain amount in Exim itself through string expansions and the &%condition%&
33616 condition in the ACL that runs after the SMTP DATA command or the ACL for
33617 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33618
33619 To allow for further customization to a site's own requirements, there is the
33620 possibility of linking Exim with a private message scanning function, written
33621 in C. If you want to run code that is written in something other than C, you
33622 can of course use a little C stub to call it.
33623
33624 The local scan function is run once for every incoming message, at the point
33625 when Exim is just about to accept the message.
33626 It can therefore be used to control non-SMTP messages from local processes as
33627 well as messages arriving via SMTP.
33628
33629 Exim applies a timeout to calls of the local scan function, and there is an
33630 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33631 Zero means &"no timeout"&.
33632 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33633 before calling the local scan function, so that the most common types of crash
33634 are caught. If the timeout is exceeded or one of those signals is caught, the
33635 incoming message is rejected with a temporary error if it is an SMTP message.
33636 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33637 code. The incident is logged on the main and reject logs.
33638
33639
33640
33641 .section "Building Exim to use a local scan function" "SECID207"
33642 .cindex "&[local_scan()]& function" "building Exim to use"
33643 To make use of the local scan function feature, you must tell Exim where your
33644 function is before building Exim, by setting
33645 both HAVE_LOCAL_SCAN and
33646 LOCAL_SCAN_SOURCE in your
33647 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33648 directory, so you might set
33649 .code
33650 HAVE_LOCAL_SCAN=yes
33651 LOCAL_SCAN_SOURCE=Local/local_scan.c
33652 .endd
33653 for example. The function must be called &[local_scan()]&. It is called by
33654 Exim after it has received a message, when the success return code is about to
33655 be sent. This is after all the ACLs have been run. The return code from your
33656 function controls whether the message is actually accepted or not. There is a
33657 commented template function (that just accepts the message) in the file
33658 _src/local_scan.c_.
33659
33660 If you want to make use of Exim's runtime configuration file to set options
33661 for your &[local_scan()]& function, you must also set
33662 .code
33663 LOCAL_SCAN_HAS_OPTIONS=yes
33664 .endd
33665 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33666
33667
33668
33669
33670 .section "API for local_scan()" "SECTapiforloc"
33671 .cindex "&[local_scan()]& function" "API description"
33672 .cindex &%dlfunc%& "API description"
33673 You must include this line near the start of your code:
33674 .code
33675 #include "local_scan.h"
33676 .endd
33677 This header file defines a number of variables and other values, and the
33678 prototype for the function itself. Exim is coded to use unsigned char values
33679 almost exclusively, and one of the things this header defines is a shorthand
33680 for &`unsigned char`& called &`uschar`&.
33681 It also contains the following macro definitions, to simplify casting character
33682 strings and pointers to character strings:
33683 .code
33684 #define CS   (char *)
33685 #define CCS  (const char *)
33686 #define CSS  (char **)
33687 #define US   (unsigned char *)
33688 #define CUS  (const unsigned char *)
33689 #define USS  (unsigned char **)
33690 .endd
33691 The function prototype for &[local_scan()]& is:
33692 .code
33693 extern int local_scan(int fd, uschar **return_text);
33694 .endd
33695 The arguments are as follows:
33696
33697 .ilist
33698 &%fd%& is a file descriptor for the file that contains the body of the message
33699 (the -D file). The file is open for reading and writing, but updating it is not
33700 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33701
33702 The descriptor is positioned at character 19 of the file, which is the first
33703 character of the body itself, because the first 19 characters are the message
33704 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33705 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33706 case this changes in some future version.
33707 .next
33708 &%return_text%& is an address which you can use to return a pointer to a text
33709 string at the end of the function. The value it points to on entry is NULL.
33710 .endlist
33711
33712 The function must return an &%int%& value which is one of the following macros:
33713
33714 .vlist
33715 .vitem &`LOCAL_SCAN_ACCEPT`&
33716 .vindex "&$local_scan_data$&"
33717 The message is accepted. If you pass back a string of text, it is saved with
33718 the message, and made available in the variable &$local_scan_data$&. No
33719 newlines are permitted (if there are any, they are turned into spaces) and the
33720 maximum length of text is 1000 characters.
33721
33722 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33723 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33724 queued without immediate delivery, and is frozen.
33725
33726 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33727 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33728 queued without immediate delivery.
33729
33730 .vitem &`LOCAL_SCAN_REJECT`&
33731 The message is rejected; the returned text is used as an error message which is
33732 passed back to the sender and which is also logged. Newlines are permitted &--
33733 they cause a multiline response for SMTP rejections, but are converted to
33734 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33735 used.
33736
33737 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33738 The message is temporarily rejected; the returned text is used as an error
33739 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33740 problem"& is used.
33741
33742 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33743 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33744 message is not written to the reject log. It has the effect of unsetting the
33745 &%rejected_header%& log selector for just this rejection. If
33746 &%rejected_header%& is already unset (see the discussion of the
33747 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33748 same as LOCAL_SCAN_REJECT.
33749
33750 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33751 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33752 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33753 .endlist
33754
33755 If the message is not being received by interactive SMTP, rejections are
33756 reported by writing to &%stderr%& or by sending an email, as configured by the
33757 &%-oe%& command line options.
33758
33759
33760
33761 .section "Configuration options for local_scan()" "SECTconoptloc"
33762 .cindex "&[local_scan()]& function" "configuration options"
33763 It is possible to have option settings in the main configuration file
33764 that set values in static variables in the &[local_scan()]& module. If you
33765 want to do this, you must have the line
33766 .code
33767 LOCAL_SCAN_HAS_OPTIONS=yes
33768 .endd
33769 in your &_Local/Makefile_& when you build Exim. (This line is in
33770 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33771 file, you must define static variables to hold the option values, and a table
33772 to define them.
33773
33774 The table must be a vector called &%local_scan_options%&, of type
33775 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33776 and a pointer to the variable that holds the value. The entries must appear in
33777 alphabetical order. Following &%local_scan_options%& you must also define a
33778 variable called &%local_scan_options_count%& that contains the number of
33779 entries in the table. Here is a short example, showing two kinds of option:
33780 .code
33781 static int my_integer_option = 42;
33782 static uschar *my_string_option = US"a default string";
33783
33784 optionlist local_scan_options[] = {
33785   { "my_integer", opt_int,       &my_integer_option },
33786   { "my_string",  opt_stringptr, &my_string_option }
33787 };
33788
33789 int local_scan_options_count =
33790   sizeof(local_scan_options)/sizeof(optionlist);
33791 .endd
33792 The values of the variables can now be changed from Exim's runtime
33793 configuration file by including a local scan section as in this example:
33794 .code
33795 begin local_scan
33796 my_integer = 99
33797 my_string = some string of text...
33798 .endd
33799 The available types of option data are as follows:
33800
33801 .vlist
33802 .vitem &*opt_bool*&
33803 This specifies a boolean (true/false) option. The address should point to a
33804 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33805 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33806 whether such a variable has been set at all, you can initialize it to
33807 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33808 values.)
33809
33810 .vitem &*opt_fixed*&
33811 This specifies a fixed point number, such as is used for load averages.
33812 The address should point to a variable of type &`int`&. The value is stored
33813 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33814
33815 .vitem &*opt_int*&
33816 This specifies an integer; the address should point to a variable of type
33817 &`int`&. The value may be specified in any of the integer formats accepted by
33818 Exim.
33819
33820 .vitem &*opt_mkint*&
33821 This is the same as &%opt_int%&, except that when such a value is output in a
33822 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33823 printed with the suffix K or M.
33824
33825 .vitem &*opt_octint*&
33826 This also specifies an integer, but the value is always interpreted as an
33827 octal integer, whether or not it starts with the digit zero, and it is
33828 always output in octal.
33829
33830 .vitem &*opt_stringptr*&
33831 This specifies a string value; the address must be a pointer to a
33832 variable that points to a string (for example, of type &`uschar *`&).
33833
33834 .vitem &*opt_time*&
33835 This specifies a time interval value. The address must point to a variable of
33836 type &`int`&. The value that is placed there is a number of seconds.
33837 .endlist
33838
33839 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33840 out the values of all the &[local_scan()]& options.
33841
33842
33843
33844 .section "Available Exim variables" "SECID208"
33845 .cindex "&[local_scan()]& function" "available Exim variables"
33846 The header &_local_scan.h_& gives you access to a number of C variables. These
33847 are the only ones that are guaranteed to be maintained from release to release.
33848 Note, however, that you can obtain the value of any Exim expansion variable,
33849 including &$recipients$&, by calling &'expand_string()'&. The exported
33850 C variables are as follows:
33851
33852 .vlist
33853 .vitem &*int&~body_linecount*&
33854 This variable contains the number of lines in the message's body.
33855 It is not valid if the &%spool_files_wireformat%& option is used.
33856
33857 .vitem &*int&~body_zerocount*&
33858 This variable contains the number of binary zero bytes in the message's body.
33859 It is not valid if the &%spool_files_wireformat%& option is used.
33860
33861 .vitem &*unsigned&~int&~debug_selector*&
33862 This variable is set to zero when no debugging is taking place. Otherwise, it
33863 is a bitmap of debugging selectors. Two bits are identified for use in
33864 &[local_scan()]&; they are defined as macros:
33865
33866 .ilist
33867 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33868 testing option that is not privileged &-- any caller may set it. All the
33869 other selector bits can be set only by admin users.
33870
33871 .next
33872 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33873 by the &`+local_scan`& debug selector. It is not included in the default set
33874 of debugging bits.
33875 .endlist ilist
33876
33877 Thus, to write to the debugging output only when &`+local_scan`& has been
33878 selected, you should use code like this:
33879 .code
33880 if ((debug_selector & D_local_scan) != 0)
33881   debug_printf("xxx", ...);
33882 .endd
33883 .vitem &*uschar&~*expand_string_message*&
33884 After a failing call to &'expand_string()'& (returned value NULL), the
33885 variable &%expand_string_message%& contains the error message, zero-terminated.
33886
33887 .vitem &*header_line&~*header_list*&
33888 A pointer to a chain of header lines. The &%header_line%& structure is
33889 discussed below.
33890
33891 .vitem &*header_line&~*header_last*&
33892 A pointer to the last of the header lines.
33893
33894 .vitem &*uschar&~*headers_charset*&
33895 The value of the &%headers_charset%& configuration option.
33896
33897 .vitem &*BOOL&~host_checking*&
33898 This variable is TRUE during a host checking session that is initiated by the
33899 &%-bh%& command line option.
33900
33901 .vitem &*uschar&~*interface_address*&
33902 The IP address of the interface that received the message, as a string. This
33903 is NULL for locally submitted messages.
33904
33905 .vitem &*int&~interface_port*&
33906 The port on which this message was received. When testing with the &%-bh%&
33907 command line option, the value of this variable is -1 unless a port has been
33908 specified via the &%-oMi%& option.
33909
33910 .vitem &*uschar&~*message_id*&
33911 This variable contains Exim's message id for the incoming message (the value of
33912 &$message_exim_id$&) as a zero-terminated string.
33913
33914 .vitem &*uschar&~*received_protocol*&
33915 The name of the protocol by which the message was received.
33916
33917 .vitem &*int&~recipients_count*&
33918 The number of accepted recipients.
33919
33920 .vitem &*recipient_item&~*recipients_list*&
33921 .cindex "recipient" "adding in local scan"
33922 .cindex "recipient" "removing in local scan"
33923 The list of accepted recipients, held in a vector of length
33924 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33925 can add additional recipients by calling &'receive_add_recipient()'& (see
33926 below). You can delete recipients by removing them from the vector and
33927 adjusting the value in &%recipients_count%&. In particular, by setting
33928 &%recipients_count%& to zero you remove all recipients. If you then return the
33929 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33930 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33931 and then call &'receive_add_recipient()'& as often as needed.
33932
33933 .vitem &*uschar&~*sender_address*&
33934 The envelope sender address. For bounce messages this is the empty string.
33935
33936 .vitem &*uschar&~*sender_host_address*&
33937 The IP address of the sending host, as a string. This is NULL for
33938 locally-submitted messages.
33939
33940 .vitem &*uschar&~*sender_host_authenticated*&
33941 The name of the authentication mechanism that was used, or NULL if the message
33942 was not received over an authenticated SMTP connection.
33943
33944 .vitem &*uschar&~*sender_host_name*&
33945 The name of the sending host, if known.
33946
33947 .vitem &*int&~sender_host_port*&
33948 The port on the sending host.
33949
33950 .vitem &*BOOL&~smtp_input*&
33951 This variable is TRUE for all SMTP input, including BSMTP.
33952
33953 .vitem &*BOOL&~smtp_batched_input*&
33954 This variable is TRUE for BSMTP input.
33955
33956 .vitem &*int&~store_pool*&
33957 The contents of this variable control which pool of memory is used for new
33958 requests. See section &<<SECTmemhanloc>>& for details.
33959 .endlist
33960
33961
33962 .section "Structure of header lines" "SECID209"
33963 The &%header_line%& structure contains the members listed below.
33964 You can add additional header lines by calling the &'header_add()'& function
33965 (see below). You can cause header lines to be ignored (deleted) by setting
33966 their type to *.
33967
33968
33969 .vlist
33970 .vitem &*struct&~header_line&~*next*&
33971 A pointer to the next header line, or NULL for the last line.
33972
33973 .vitem &*int&~type*&
33974 A code identifying certain headers that Exim recognizes. The codes are printing
33975 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33976 Notice in particular that any header line whose type is * is not transmitted
33977 with the message. This flagging is used for header lines that have been
33978 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33979 lines.) Effectively, * means &"deleted"&.
33980
33981 .vitem &*int&~slen*&
33982 The number of characters in the header line, including the terminating and any
33983 internal newlines.
33984
33985 .vitem &*uschar&~*text*&
33986 A pointer to the text of the header. It always ends with a newline, followed by
33987 a zero byte. Internal newlines are preserved.
33988 .endlist
33989
33990
33991
33992 .section "Structure of recipient items" "SECID210"
33993 The &%recipient_item%& structure contains these members:
33994
33995 .vlist
33996 .vitem &*uschar&~*address*&
33997 This is a pointer to the recipient address as it was received.
33998
33999 .vitem &*int&~pno*&
34000 This is used in later Exim processing when top level addresses are created by
34001 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34002 and must always contain -1 at this stage.
34003
34004 .vitem &*uschar&~*errors_to*&
34005 If this value is not NULL, bounce messages caused by failing to deliver to the
34006 recipient are sent to the address it contains. In other words, it overrides the
34007 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34008 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34009 an unqualified address, Exim qualifies it using the domain from
34010 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34011 is NULL for all recipients.
34012 .endlist
34013
34014
34015
34016 .section "Available Exim functions" "SECID211"
34017 .cindex "&[local_scan()]& function" "available Exim functions"
34018 The header &_local_scan.h_& gives you access to a number of Exim functions.
34019 These are the only ones that are guaranteed to be maintained from release to
34020 release:
34021
34022 .vlist
34023 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34024        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34025
34026 This function creates a child process that runs the command specified by
34027 &%argv%&. The environment for the process is specified by &%envp%&, which can
34028 be NULL if no environment variables are to be passed. A new umask is supplied
34029 for the process in &%newumask%&.
34030
34031 Pipes to the standard input and output of the new process are set up
34032 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34033 standard error is cloned to the standard output. If there are any file
34034 descriptors &"in the way"& in the new process, they are closed. If the final
34035 argument is TRUE, the new process is made into a process group leader.
34036
34037 The function returns the pid of the new process, or -1 if things go wrong.
34038
34039 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34040 This function waits for a child process to terminate, or for a timeout (in
34041 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34042 return value is as follows:
34043
34044 .ilist
34045 >= 0
34046
34047 The process terminated by a normal exit and the value is the process
34048 ending status.
34049
34050 .next
34051 < 0 and > &--256
34052
34053 The process was terminated by a signal and the value is the negation of the
34054 signal number.
34055
34056 .next
34057 &--256
34058
34059 The process timed out.
34060 .next
34061 &--257
34062
34063 The was some other error in wait(); &%errno%& is still set.
34064 .endlist
34065
34066 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34067 This function provide you with a means of submitting a new message to
34068 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34069 want, but this packages it all up for you.) The function creates a pipe,
34070 forks a subprocess that is running
34071 .code
34072 exim -t -oem -oi -f <>
34073 .endd
34074 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34075 that is connected to the standard input. The yield of the function is the PID
34076 of the subprocess. You can then write a message to the file descriptor, with
34077 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34078
34079 When you have finished, call &'child_close()'& to wait for the process to
34080 finish and to collect its ending status. A timeout value of zero is usually
34081 fine in this circumstance. Unless you have made a mistake with the recipient
34082 addresses, you should get a return code of zero.
34083
34084
34085 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34086        *sender_authentication)*&
34087 This function is a more sophisticated version of &'child_open()'&. The command
34088 that it runs is:
34089 .display
34090 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34091 .endd
34092 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34093
34094
34095 .vitem &*void&~debug_printf(char&~*,&~...)*&
34096 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34097 output is written to the standard error stream. If no debugging is selected,
34098 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34099 conditional on the &`local_scan`& debug selector by coding like this:
34100 .code
34101 if ((debug_selector & D_local_scan) != 0)
34102   debug_printf("xxx", ...);
34103 .endd
34104
34105 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34106 This is an interface to Exim's string expansion code. The return value is the
34107 expanded string, or NULL if there was an expansion failure.
34108 The C variable &%expand_string_message%& contains an error message after an
34109 expansion failure. If expansion does not change the string, the return value is
34110 the pointer to the input string. Otherwise, the return value points to a new
34111 block of memory that was obtained by a call to &'store_get()'&. See section
34112 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34113
34114 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34115 This function allows you to an add additional header line at the end of the
34116 existing ones. The first argument is the type, and should normally be a space
34117 character. The second argument is a format string and any number of
34118 substitution arguments as for &[sprintf()]&. You may include internal newlines
34119 if you want, and you must ensure that the string ends with a newline.
34120
34121 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34122         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34123 This function adds a new header line at a specified point in the header
34124 chain. The header itself is specified as for &'header_add()'&.
34125
34126 If &%name%& is NULL, the new header is added at the end of the chain if
34127 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34128 NULL, the header lines are searched for the first non-deleted header that
34129 matches the name. If one is found, the new header is added before it if
34130 &%after%& is false. If &%after%& is true, the new header is added after the
34131 found header and any adjacent subsequent ones with the same name (even if
34132 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34133 option controls where the header is added. If it is true, addition is at the
34134 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34135 headers, or at the top if there are no &'Received:'& headers, you could use
34136 .code
34137 header_add_at_position(TRUE, US"Received", TRUE,
34138   ' ', "X-xxx: ...");
34139 .endd
34140 Normally, there is always at least one non-deleted &'Received:'& header, but
34141 there may not be if &%received_header_text%& expands to an empty string.
34142
34143
34144 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34145 This function removes header lines. If &%occurrence%& is zero or negative, all
34146 occurrences of the header are removed. If occurrence is greater than zero, that
34147 particular instance of the header is removed. If no header(s) can be found that
34148 match the specification, the function does nothing.
34149
34150
34151 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34152         int&~length,&~BOOL&~notdel)*&"
34153 This function tests whether the given header has the given name. It is not just
34154 a string comparison, because white space is permitted between the name and the
34155 colon. If the &%notdel%& argument is true, a false return is forced for all
34156 &"deleted"& headers; otherwise they are not treated specially. For example:
34157 .code
34158 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34159 .endd
34160 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34161 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34162 This function base64-encodes a string, which is passed by address and length.
34163 The text may contain bytes of any value, including zero. The result is passed
34164 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34165 zero-terminated.
34166
34167 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34168 This function decodes a base64-encoded string. Its arguments are a
34169 zero-terminated base64-encoded string and the address of a variable that is set
34170 to point to the result, which is in dynamic memory. The length of the decoded
34171 string is the yield of the function. If the input is invalid base64 data, the
34172 yield is -1. A zero byte is added to the end of the output string to make it
34173 easy to interpret as a C string (assuming it contains no zeros of its own). The
34174 added zero byte is not included in the returned count.
34175
34176 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34177 This function checks for a match in a domain list. Domains are always
34178 matched caselessly. The return value is one of the following:
34179 .display
34180 &`OK     `& match succeeded
34181 &`FAIL   `& match failed
34182 &`DEFER  `& match deferred
34183 .endd
34184 DEFER is usually caused by some kind of lookup defer, such as the
34185 inability to contact a database.
34186
34187 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34188         BOOL&~caseless)*&"
34189 This function checks for a match in a local part list. The third argument
34190 controls case-sensitivity. The return values are as for
34191 &'lss_match_domain()'&.
34192
34193 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34194         BOOL&~caseless)*&"
34195 This function checks for a match in an address list. The third argument
34196 controls the case-sensitivity of the local part match. The domain is always
34197 matched caselessly. The return values are as for &'lss_match_domain()'&.
34198
34199 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34200         uschar&~*list)*&"
34201 This function checks for a match in a host list. The most common usage is
34202 expected to be
34203 .code
34204 lss_match_host(sender_host_name, sender_host_address, ...)
34205 .endd
34206 .vindex "&$sender_host_address$&"
34207 An empty address field matches an empty item in the host list. If the host name
34208 is NULL, the name corresponding to &$sender_host_address$& is automatically
34209 looked up if a host name is required to match an item in the list. The return
34210 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34211 returns ERROR in the case when it had to look up a host name, but the lookup
34212 failed.
34213
34214 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34215         *format,&~...)*&"
34216 This function writes to Exim's log files. The first argument should be zero (it
34217 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34218 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34219 them. It specifies to which log or logs the message is written. The remaining
34220 arguments are a format and relevant insertion arguments. The string should not
34221 contain any newlines, not even at the end.
34222
34223
34224 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34225 This function adds an additional recipient to the message. The first argument
34226 is the recipient address. If it is unqualified (has no domain), it is qualified
34227 with the &%qualify_recipient%& domain. The second argument must always be -1.
34228
34229 This function does not allow you to specify a private &%errors_to%& address (as
34230 described with the structure of &%recipient_item%& above), because it pre-dates
34231 the addition of that field to the structure. However, it is easy to add such a
34232 value afterwards. For example:
34233 .code
34234  receive_add_recipient(US"monitor@mydom.example", -1);
34235  recipients_list[recipients_count-1].errors_to =
34236    US"postmaster@mydom.example";
34237 .endd
34238
34239 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34240 This is a convenience function to remove a named recipient from the list of
34241 recipients. It returns true if a recipient was removed, and false if no
34242 matching recipient could be found. The argument must be a complete email
34243 address.
34244 .endlist
34245
34246
34247 .cindex "RFC 2047"
34248 .vlist
34249 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34250   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34251 This function decodes strings that are encoded according to RFC 2047. Typically
34252 these are the contents of header lines. First, each &"encoded word"& is decoded
34253 from the Q or B encoding into a byte-string. Then, if provided with the name of
34254 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34255 made  to translate the result to the named character set. If this fails, the
34256 binary string is returned with an error message.
34257
34258 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34259 maximum MIME word length is enforced. The third argument is the target
34260 encoding, or NULL if no translation is wanted.
34261
34262 .cindex "binary zero" "in RFC 2047 decoding"
34263 .cindex "RFC 2047" "binary zero in"
34264 If a binary zero is encountered in the decoded string, it is replaced by the
34265 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34266 not be 0 because header lines are handled as zero-terminated strings.
34267
34268 The function returns the result of processing the string, zero-terminated; if
34269 &%lenptr%& is not NULL, the length of the result is set in the variable to
34270 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34271
34272 If an error is encountered, the function returns NULL and uses the &%error%&
34273 argument to return an error message. The variable pointed to by &%error%& is
34274 set to NULL if there is no error; it may be set non-NULL even when the function
34275 returns a non-NULL value if decoding was successful, but there was a problem
34276 with translation.
34277
34278
34279 .vitem &*int&~smtp_fflush(void)*&
34280 This function is used in conjunction with &'smtp_printf()'&, as described
34281 below.
34282
34283 .vitem &*void&~smtp_printf(char&~*,&~...)*&
34284 The arguments of this function are like &[printf()]&; it writes to the SMTP
34285 output stream. You should use this function only when there is an SMTP output
34286 stream, that is, when the incoming message is being received via interactive
34287 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34288 is FALSE. If you want to test for an incoming message from another host (as
34289 opposed to a local process that used the &%-bs%& command line option), you can
34290 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34291 is involved.
34292
34293 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34294 output function, so it can be used for all forms of SMTP connection.
34295
34296 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34297 must start with an appropriate response code: 550 if you are going to return
34298 LOCAL_SCAN_REJECT, 451 if you are going to return
34299 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34300 initial lines of a multi-line response, the code must be followed by a hyphen
34301 to indicate that the line is not the final response line. You must also ensure
34302 that the lines you write terminate with CRLF. For example:
34303 .code
34304 smtp_printf("550-this is some extra info\r\n");
34305 return LOCAL_SCAN_REJECT;
34306 .endd
34307 Note that you can also create multi-line responses by including newlines in
34308 the data returned via the &%return_text%& argument. The added value of using
34309 &'smtp_printf()'& is that, for instance, you could introduce delays between
34310 multiple output lines.
34311
34312 The &'smtp_printf()'& function does not return any error indication, because it
34313 does not automatically flush pending output, and therefore does not test
34314 the state of the stream. (In the main code of Exim, flushing and error
34315 detection is done when Exim is ready for the next SMTP input command.) If
34316 you want to flush the output and check for an error (for example, the
34317 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34318 arguments. It flushes the output stream, and returns a non-zero value if there
34319 is an error.
34320
34321 .vitem &*void&~*store_get(int)*&
34322 This function accesses Exim's internal store (memory) manager. It gets a new
34323 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34324 runs out of memory. See the next section for a discussion of memory handling.
34325
34326 .vitem &*void&~*store_get_perm(int)*&
34327 This function is like &'store_get()'&, but it always gets memory from the
34328 permanent pool. See the next section for a discussion of memory handling.
34329
34330 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34331 See below.
34332
34333 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34334 See below.
34335
34336 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34337 These three functions create strings using Exim's dynamic memory facilities.
34338 The first makes a copy of an entire string. The second copies up to a maximum
34339 number of characters, indicated by the second argument. The third uses a format
34340 and insertion arguments to create a new string. In each case, the result is a
34341 pointer to a new string in the current memory pool. See the next section for
34342 more discussion.
34343 .endlist
34344
34345
34346
34347 .section "More about Exim's memory handling" "SECTmemhanloc"
34348 .cindex "&[local_scan()]& function" "memory handling"
34349 No function is provided for freeing memory, because that is never needed.
34350 The dynamic memory that Exim uses when receiving a message is automatically
34351 recycled if another message is received by the same process (this applies only
34352 to incoming SMTP connections &-- other input methods can supply only one
34353 message at a time). After receiving the last message, a reception process
34354 terminates.
34355
34356 Because it is recycled, the normal dynamic memory cannot be used for holding
34357 data that must be preserved over a number of incoming messages on the same SMTP
34358 connection. However, Exim in fact uses two pools of dynamic memory; the second
34359 one is not recycled, and can be used for this purpose.
34360
34361 If you want to allocate memory that remains available for subsequent messages
34362 in the same SMTP connection, you should set
34363 .code
34364 store_pool = POOL_PERM
34365 .endd
34366 before calling the function that does the allocation. There is no need to
34367 restore the value if you do not need to; however, if you do want to revert to
34368 the normal pool, you can either restore the previous value of &%store_pool%& or
34369 set it explicitly to POOL_MAIN.
34370
34371 The pool setting applies to all functions that get dynamic memory, including
34372 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34373 There is also a convenience function called &'store_get_perm()'& that gets a
34374 block of memory from the permanent pool while preserving the value of
34375 &%store_pool%&.
34376 .ecindex IIDlosca
34377
34378
34379
34380
34381 . ////////////////////////////////////////////////////////////////////////////
34382 . ////////////////////////////////////////////////////////////////////////////
34383
34384 .chapter "System-wide message filtering" "CHAPsystemfilter"
34385 .scindex IIDsysfil1 "filter" "system filter"
34386 .scindex IIDsysfil2 "filtering all mail"
34387 .scindex IIDsysfil3 "system filter"
34388 The previous chapters (on ACLs and the local scan function) describe checks
34389 that can be applied to messages before they are accepted by a host. There is
34390 also a mechanism for checking messages once they have been received, but before
34391 they are delivered. This is called the &'system filter'&.
34392
34393 The system filter operates in a similar manner to users' filter files, but it
34394 is run just once per message (however many recipients the message has).
34395 It should not normally be used as a substitute for routing, because &%deliver%&
34396 commands in a system router provide new envelope recipient addresses.
34397 The system filter must be an Exim filter. It cannot be a Sieve filter.
34398
34399 The system filter is run at the start of a delivery attempt, before any routing
34400 is done. If a message fails to be completely delivered at the first attempt,
34401 the system filter is run again at the start of every retry.
34402 If you want your filter to do something only once per message, you can make use
34403 of the &%first_delivery%& condition in an &%if%& command in the filter to
34404 prevent it happening on retries.
34405
34406 .vindex "&$domain$&"
34407 .vindex "&$local_part$&"
34408 &*Warning*&: Because the system filter runs just once, variables that are
34409 specific to individual recipient addresses, such as &$local_part$& and
34410 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34411 you want to run a centrally-specified filter for each recipient address
34412 independently, you can do so by setting up a suitable &(redirect)& router, as
34413 described in section &<<SECTperaddfil>>& below.
34414
34415
34416 .section "Specifying a system filter" "SECID212"
34417 .cindex "uid (user id)" "system filter"
34418 .cindex "gid (group id)" "system filter"
34419 The name of the file that contains the system filter must be specified by
34420 setting &%system_filter%&. If you want the filter to run under a uid and gid
34421 other than root, you must also set &%system_filter_user%& and
34422 &%system_filter_group%& as appropriate. For example:
34423 .code
34424 system_filter = /etc/mail/exim.filter
34425 system_filter_user = exim
34426 .endd
34427 If a system filter generates any deliveries directly to files or pipes (via the
34428 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34429 specified by setting &%system_filter_file_transport%& and
34430 &%system_filter_pipe_transport%&, respectively. Similarly,
34431 &%system_filter_reply_transport%& must be set to handle any messages generated
34432 by the &%reply%& command.
34433
34434
34435 .section "Testing a system filter" "SECID213"
34436 You can run simple tests of a system filter in the same way as for a user
34437 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34438 are permitted only in system filters are recognized.
34439
34440 If you want to test the combined effect of a system filter and a user filter,
34441 you can use both &%-bF%& and &%-bf%& on the same command line.
34442
34443
34444
34445 .section "Contents of a system filter" "SECID214"
34446 The language used to specify system filters is the same as for users' filter
34447 files. It is described in the separate end-user document &'Exim's interface to
34448 mail filtering'&. However, there are some additional features that are
34449 available only in system filters; these are described in subsequent sections.
34450 If they are encountered in a user's filter file or when testing with &%-bf%&,
34451 they cause errors.
34452
34453 .cindex "frozen messages" "manual thaw; testing in filter"
34454 There are two special conditions which, though available in users' filter
34455 files, are designed for use in system filters. The condition &%first_delivery%&
34456 is true only for the first attempt at delivering a message, and
34457 &%manually_thawed%& is true only if the message has been frozen, and
34458 subsequently thawed by an admin user. An explicit forced delivery counts as a
34459 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34460
34461 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34462 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34463 succeed, it will not be tried again.
34464 If you want Exim to retry an unseen delivery until it succeeds, you should
34465 arrange to set it up every time the filter runs.
34466
34467 When a system filter finishes running, the values of the variables &$n0$& &--
34468 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34469 users' filter files. Thus a system filter can, for example, set up &"scores"&
34470 to which users' filter files can refer.
34471
34472
34473
34474 .section "Additional variable for system filters" "SECID215"
34475 .vindex "&$recipients$&"
34476 The expansion variable &$recipients$&, containing a list of all the recipients
34477 of the message (separated by commas and white space), is available in system
34478 filters. It is not available in users' filters for privacy reasons.
34479
34480
34481
34482 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34483 .cindex "freezing messages"
34484 .cindex "message" "freezing"
34485 .cindex "message" "forced failure"
34486 .cindex "&%fail%&" "in system filter"
34487 .cindex "&%freeze%& in system filter"
34488 .cindex "&%defer%& in system filter"
34489 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34490 always available in system filters, but are not normally enabled in users'
34491 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34492 for the &(redirect)& router.) These commands can optionally be followed by the
34493 word &%text%& and a string containing an error message, for example:
34494 .code
34495 fail text "this message looks like spam to me"
34496 .endd
34497 The keyword &%text%& is optional if the next character is a double quote.
34498
34499 The &%defer%& command defers delivery of the original recipients of the
34500 message. The &%fail%& command causes all the original recipients to be failed,
34501 and a bounce message to be created. The &%freeze%& command suspends all
34502 delivery attempts for the original recipients. In all cases, any new deliveries
34503 that are specified by the filter are attempted as normal after the filter has
34504 run.
34505
34506 The &%freeze%& command is ignored if the message has been manually unfrozen and
34507 not manually frozen since. This means that automatic freezing by a system
34508 filter can be used as a way of checking out suspicious messages. If a message
34509 is found to be all right, manually unfreezing it allows it to be delivered.
34510
34511 .cindex "log" "&%fail%& command log line"
34512 .cindex "&%fail%&" "log line; reducing"
34513 The text given with a fail command is used as part of the bounce message as
34514 well as being written to the log. If the message is quite long, this can fill
34515 up a lot of log space when such failures are common. To reduce the size of the
34516 log message, Exim interprets the text in a special way if it starts with the
34517 two characters &`<<`& and contains &`>>`& later. The text between these two
34518 strings is written to the log, and the rest of the text is used in the bounce
34519 message. For example:
34520 .code
34521 fail "<<filter test 1>>Your message is rejected \
34522      because it contains attachments that we are \
34523      not prepared to receive."
34524 .endd
34525
34526 .cindex "loop" "caused by &%fail%&"
34527 Take great care with the &%fail%& command when basing the decision to fail on
34528 the contents of the message, because the bounce message will of course include
34529 the contents of the original message and will therefore trigger the &%fail%&
34530 command again (causing a mail loop) unless steps are taken to prevent this.
34531 Testing the &%error_message%& condition is one way to prevent this. You could
34532 use, for example
34533 .code
34534 if $message_body contains "this is spam" and not error_message
34535 then fail text "spam is not wanted here" endif
34536 .endd
34537 though of course that might let through unwanted bounce messages. The
34538 alternative is clever checking of the body and/or headers to detect bounces
34539 generated by the filter.
34540
34541 The interpretation of a system filter file ceases after a
34542 &%defer%&,
34543 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34544 set up earlier in the filter file are honoured, so you can use a sequence such
34545 as
34546 .code
34547 mail ...
34548 freeze
34549 .endd
34550 to send a specified message when the system filter is freezing (or deferring or
34551 failing) a message. The normal deliveries for the message do not, of course,
34552 take place.
34553
34554
34555
34556 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34557 .cindex "header lines" "adding; in system filter"
34558 .cindex "header lines" "removing; in system filter"
34559 .cindex "filter" "header lines; adding/removing"
34560 Two filter commands that are available only in system filters are:
34561 .code
34562 headers add <string>
34563 headers remove <string>
34564 .endd
34565 The argument for the &%headers add%& is a string that is expanded and then
34566 added to the end of the message's headers. It is the responsibility of the
34567 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34568 space is ignored, and if the string is otherwise empty, or if the expansion is
34569 forced to fail, the command has no effect.
34570
34571 You can use &"\n"& within the string, followed by white space, to specify
34572 continued header lines. More than one header may be added in one command by
34573 including &"\n"& within the string without any following white space. For
34574 example:
34575 .code
34576 headers add "X-header-1: ....\n  \
34577              continuation of X-header-1 ...\n\
34578              X-header-2: ...."
34579 .endd
34580 Note that the header line continuation white space after the first newline must
34581 be placed before the backslash that continues the input string, because white
34582 space after input continuations is ignored.
34583
34584 The argument for &%headers remove%& is a colon-separated list of header names.
34585 This command applies only to those headers that are stored with the message;
34586 those that are added at delivery time (such as &'Envelope-To:'& and
34587 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34588 header with the same name, they are all removed.
34589
34590 The &%headers%& command in a system filter makes an immediate change to the set
34591 of header lines that was received with the message (with possible additions
34592 from ACL processing). Subsequent commands in the system filter operate on the
34593 modified set, which also forms the basis for subsequent message delivery.
34594 Unless further modified during routing or transporting, this set of headers is
34595 used for all recipients of the message.
34596
34597 During routing and transporting, the variables that refer to the contents of
34598 header lines refer only to those lines that are in this set. Thus, header lines
34599 that are added by a system filter are visible to users' filter files and to all
34600 routers and transports. This contrasts with the manipulation of header lines by
34601 routers and transports, which is not immediate, but which instead is saved up
34602 until the message is actually being written (see section
34603 &<<SECTheadersaddrem>>&).
34604
34605 If the message is not delivered at the first attempt, header lines that were
34606 added by the system filter are stored with the message, and so are still
34607 present at the next delivery attempt. Header lines that were removed are still
34608 present, but marked &"deleted"& so that they are not transported with the
34609 message. For this reason, it is usual to make the &%headers%& command
34610 conditional on &%first_delivery%& so that the set of header lines is not
34611 modified more than once.
34612
34613 Because header modification in a system filter acts immediately, you have to
34614 use an indirect approach if you want to modify the contents of a header line.
34615 For example:
34616 .code
34617 headers add "Old-Subject: $h_subject:"
34618 headers remove "Subject"
34619 headers add "Subject: new subject (was: $h_old-subject:)"
34620 headers remove "Old-Subject"
34621 .endd
34622
34623
34624
34625 .section "Setting an errors address in a system filter" "SECID217"
34626 .cindex "envelope from"
34627 .cindex "envelope sender"
34628 In a system filter, if a &%deliver%& command is followed by
34629 .code
34630 errors_to <some address>
34631 .endd
34632 in order to change the envelope sender (and hence the error reporting) for that
34633 delivery, any address may be specified. (In a user filter, only the current
34634 user's address can be set.) For example, if some mail is being monitored, you
34635 might use
34636 .code
34637 unseen deliver monitor@spying.example errors_to root@local.example
34638 .endd
34639 to take a copy which would not be sent back to the normal error reporting
34640 address if its delivery failed.
34641
34642
34643
34644 .section "Per-address filtering" "SECTperaddfil"
34645 .vindex "&$domain$&"
34646 .vindex "&$local_part$&"
34647 In contrast to the system filter, which is run just once per message for each
34648 delivery attempt, it is also possible to set up a system-wide filtering
34649 operation that runs once for each recipient address. In this case, variables
34650 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34651 filter file could be made dependent on them. This is an example of a router
34652 which implements such a filter:
34653 .code
34654 central_filter:
34655   check_local_user
34656   driver = redirect
34657   domains = +local_domains
34658   file = /central/filters/$local_part
34659   no_verify
34660   allow_filter
34661   allow_freeze
34662 .endd
34663 The filter is run in a separate process under its own uid. Therefore, either
34664 &%check_local_user%& must be set (as above), in which case the filter is run as
34665 the local user, or the &%user%& option must be used to specify which user to
34666 use. If both are set, &%user%& overrides.
34667
34668 Care should be taken to ensure that none of the commands in the filter file
34669 specify a significant delivery if the message is to go on to be delivered to
34670 its intended recipient. The router will not then claim to have dealt with the
34671 address, so it will be passed on to subsequent routers to be delivered in the
34672 normal way.
34673 .ecindex IIDsysfil1
34674 .ecindex IIDsysfil2
34675 .ecindex IIDsysfil3
34676
34677
34678
34679
34680
34681
34682 . ////////////////////////////////////////////////////////////////////////////
34683 . ////////////////////////////////////////////////////////////////////////////
34684
34685 .chapter "Message processing" "CHAPmsgproc"
34686 .scindex IIDmesproc "message" "general processing"
34687 Exim performs various transformations on the sender and recipient addresses of
34688 all messages that it handles, and also on the messages' header lines. Some of
34689 these are optional and configurable, while others always take place. All of
34690 this processing, except rewriting as a result of routing, and the addition or
34691 removal of header lines while delivering, happens when a message is received,
34692 before it is placed on Exim's queue.
34693
34694 Some of the automatic processing takes place by default only for
34695 &"locally-originated"& messages. This adjective is used to describe messages
34696 that are not received over TCP/IP, but instead are passed to an Exim process on
34697 its standard input. This includes the interactive &"local SMTP"& case that is
34698 set up by the &%-bs%& command line option.
34699
34700 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34701 or ::1) are not considered to be locally-originated. Exim does not treat the
34702 loopback interface specially in any way.
34703
34704 If you want the loopback interface to be treated specially, you must ensure
34705 that there are appropriate entries in your ACLs.
34706
34707
34708
34709
34710 .section "Submission mode for non-local messages" "SECTsubmodnon"
34711 .cindex "message" "submission"
34712 .cindex "submission mode"
34713 Processing that happens automatically for locally-originated messages (unless
34714 &%suppress_local_fixups%& is set) can also be requested for messages that are
34715 received over TCP/IP. The term &"submission mode"& is used to describe this
34716 state. Submission mode is set by the modifier
34717 .code
34718 control = submission
34719 .endd
34720 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34721 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34722 a local submission, and is normally used when the source of the message is
34723 known to be an MUA running on a client host (as opposed to an MTA). For
34724 example, to set submission mode for messages originating on the IPv4 loopback
34725 interface, you could include the following in the MAIL ACL:
34726 .code
34727 warn  hosts = 127.0.0.1
34728       control = submission
34729 .endd
34730 .cindex "&%sender_retain%& submission option"
34731 There are some options that can be used when setting submission mode. A slash
34732 is used to separate options. For example:
34733 .code
34734 control = submission/sender_retain
34735 .endd
34736 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34737 true and &%local_from_check%& false for the current incoming message. The first
34738 of these allows an existing &'Sender:'& header in the message to remain, and
34739 the second suppresses the check to ensure that &'From:'& matches the
34740 authenticated sender. With this setting, Exim still fixes up messages by adding
34741 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34742 attempt to check sender authenticity in header lines.
34743
34744 When &%sender_retain%& is not set, a submission mode setting may specify a
34745 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34746 example:
34747 .code
34748 control = submission/domain=some.domain
34749 .endd
34750 The domain may be empty. How this value is used is described in sections
34751 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34752 that allows you to specify the user's full name for inclusion in a created
34753 &'Sender:'& or &'From:'& header line. For example:
34754 .code
34755 accept authenticated = *
34756        control = submission/domain=wonderland.example/\
34757                             name=${lookup {$authenticated_id} \
34758                                    lsearch {/etc/exim/namelist}}
34759 .endd
34760 Because the name may contain any characters, including slashes, the &%name%&
34761 option must be given last. The remainder of the string is used as the name. For
34762 the example above, if &_/etc/exim/namelist_& contains:
34763 .code
34764 bigegg:  Humpty Dumpty
34765 .endd
34766 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34767 line would be:
34768 .code
34769 Sender: Humpty Dumpty <bigegg@wonderland.example>
34770 .endd
34771 .cindex "return path" "in submission mode"
34772 By default, submission mode forces the return path to the same address as is
34773 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34774 specified, the return path is also left unchanged.
34775
34776 &*Note*&: The changes caused by submission mode take effect after the predata
34777 ACL. This means that any sender checks performed before the fix-ups use the
34778 untrusted sender address specified by the user, not the trusted sender address
34779 specified by submission mode. Although this might be slightly unexpected, it
34780 does mean that you can configure ACL checks to spot that a user is trying to
34781 spoof another's address.
34782
34783 .section "Line endings" "SECTlineendings"
34784 .cindex "line endings"
34785 .cindex "carriage return"
34786 .cindex "linefeed"
34787 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34788 linefeed) is the line ending for messages transmitted over the Internet using
34789 SMTP over TCP/IP. However, within individual operating systems, different
34790 conventions are used. For example, Unix-like systems use just LF, but others
34791 use CRLF or just CR.
34792
34793 Exim was designed for Unix-like systems, and internally, it stores messages
34794 using the system's convention of a single LF as a line terminator. When
34795 receiving a message, all line endings are translated to this standard format.
34796 Originally, it was thought that programs that passed messages directly to an
34797 MTA within an operating system would use that system's convention. Experience
34798 has shown that this is not the case; for example, there are Unix applications
34799 that use CRLF in this circumstance. For this reason, and for compatibility with
34800 other MTAs, the way Exim handles line endings for all messages is now as
34801 follows:
34802
34803 .ilist
34804 LF not preceded by CR is treated as a line ending.
34805 .next
34806 CR is treated as a line ending; if it is immediately followed by LF, the LF
34807 is ignored.
34808 .next
34809 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34810 nor a local message in the state where a line containing only a dot is a
34811 terminator.
34812 .next
34813 If a bare CR is encountered within a header line, an extra space is added after
34814 the line terminator so as not to end the header line. The reasoning behind this
34815 is that bare CRs in header lines are most likely either to be mistakes, or
34816 people trying to play silly games.
34817 .next
34818 If the first header line received in a message ends with CRLF, a subsequent
34819 bare LF in a header line is treated in the same way as a bare CR in a header
34820 line.
34821 .endlist
34822
34823
34824
34825
34826
34827 .section "Unqualified addresses" "SECID218"
34828 .cindex "unqualified addresses"
34829 .cindex "address" "qualification"
34830 By default, Exim expects every envelope address it receives from an external
34831 host to be fully qualified. Unqualified addresses cause negative responses to
34832 SMTP commands. However, because SMTP is used as a means of transporting
34833 messages from MUAs running on personal workstations, there is sometimes a
34834 requirement to accept unqualified addresses from specific hosts or IP networks.
34835
34836 Exim has two options that separately control which hosts may send unqualified
34837 sender or recipient addresses in SMTP commands, namely
34838 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34839 cases, if an unqualified address is accepted, it is qualified by adding the
34840 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34841
34842 .oindex "&%qualify_domain%&"
34843 .oindex "&%qualify_recipient%&"
34844 Unqualified addresses in header lines are automatically qualified for messages
34845 that are locally originated, unless the &%-bnq%& option is given on the command
34846 line. For messages received over SMTP, unqualified addresses in header lines
34847 are qualified only if unqualified addresses are permitted in SMTP commands. In
34848 other words, such qualification is also controlled by
34849 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34850
34851
34852
34853
34854 .section "The UUCP From line" "SECID219"
34855 .cindex "&""From""& line"
34856 .cindex "UUCP" "&""From""& line"
34857 .cindex "sender" "address"
34858 .oindex "&%uucp_from_pattern%&"
34859 .oindex "&%uucp_from_sender%&"
34860 .cindex "envelope from"
34861 .cindex "envelope sender"
34862 .cindex "Sendmail compatibility" "&""From""& line"
34863 Messages that have come from UUCP (and some other applications) often begin
34864 with a line containing the envelope sender and a timestamp, following the word
34865 &"From"&. Examples of two common formats are:
34866 .code
34867 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34868 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34869 .endd
34870 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34871 Exim recognizes such lines at the start of messages that are submitted to it
34872 via the command line (that is, on the standard input). It does not recognize
34873 such lines in incoming SMTP messages, unless the sending host matches
34874 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34875 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34876 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34877 default value matches the two common cases shown above and puts the address
34878 that follows &"From"& into &$1$&.
34879
34880 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34881 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34882 a trusted user, the message's sender address is constructed by expanding the
34883 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34884 then parsed as an RFC 2822 address. If there is no domain, the local part is
34885 qualified with &%qualify_domain%& unless it is the empty string. However, if
34886 the command line &%-f%& option is used, it overrides the &"From"& line.
34887
34888 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34889 sender address is not changed. This is also the case for incoming SMTP messages
34890 that are permitted to contain &"From"& lines.
34891
34892 Only one &"From"& line is recognized. If there is more than one, the second is
34893 treated as a data line that starts the body of the message, as it is not valid
34894 as a header line. This also happens if a &"From"& line is present in an
34895 incoming SMTP message from a source that is not permitted to send them.
34896
34897
34898
34899 .section "Resent- header lines" "SECID220"
34900 .cindex "&%Resent-%& header lines"
34901 .cindex "header lines" "Resent-"
34902 RFC 2822 makes provision for sets of header lines starting with the string
34903 &`Resent-`& to be added to a message when it is resent by the original
34904 recipient to somebody else. These headers are &'Resent-Date:'&,
34905 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34906 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34907
34908 .blockquote
34909 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34910 processing of replies or other such automatic actions on messages.'&
34911 .endblockquote
34912
34913 This leaves things a bit vague as far as other processing actions such as
34914 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34915 follows:
34916
34917 .ilist
34918 A &'Resent-From:'& line that just contains the login id of the submitting user
34919 is automatically rewritten in the same way as &'From:'& (see below).
34920 .next
34921 If there's a rewriting rule for a particular header line, it is also applied to
34922 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34923 &'From:'& also rewrites &'Resent-From:'&.
34924 .next
34925 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34926 also removed.
34927 .next
34928 For a locally-submitted message,
34929 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34930 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34931 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34932 included in log lines in this case.
34933 .next
34934 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34935 &%Resent-%& header lines are present.
34936 .endlist
34937
34938
34939
34940
34941 .section "The Auto-Submitted: header line" "SECID221"
34942 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34943 includes the header line:
34944 .code
34945 Auto-Submitted: auto-replied
34946 .endd
34947
34948 .section "The Bcc: header line" "SECID222"
34949 .cindex "&'Bcc:'& header line"
34950 If Exim is called with the &%-t%& option, to take recipient addresses from a
34951 message's header, it removes any &'Bcc:'& header line that may exist (after
34952 extracting its addresses). If &%-t%& is not present on the command line, any
34953 existing &'Bcc:'& is not removed.
34954
34955
34956 .section "The Date: header line" "SECID223"
34957 .cindex "&'Date:'& header line"
34958 .cindex "header lines" "Date:"
34959 If a locally-generated or submission-mode message has no &'Date:'& header line,
34960 Exim adds one, using the current date and time, unless the
34961 &%suppress_local_fixups%& control has been specified.
34962
34963 .section "The Delivery-date: header line" "SECID224"
34964 .cindex "&'Delivery-date:'& header line"
34965 .oindex "&%delivery_date_remove%&"
34966 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34967 set. Exim can be configured to add them to the final delivery of messages. (See
34968 the generic &%delivery_date_add%& transport option.) They should not be present
34969 in messages in transit. If the &%delivery_date_remove%& configuration option is
34970 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34971 messages.
34972
34973
34974 .section "The Envelope-to: header line" "SECID225"
34975 .cindex "&'Envelope-to:'& header line"
34976 .cindex "header lines" "Envelope-to:"
34977 .oindex "&%envelope_to_remove%&"
34978 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34979 Exim can be configured to add them to the final delivery of messages. (See the
34980 generic &%envelope_to_add%& transport option.) They should not be present in
34981 messages in transit. If the &%envelope_to_remove%& configuration option is set
34982 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34983 messages.
34984
34985
34986 .section "The From: header line" "SECTthefrohea"
34987 .cindex "&'From:'& header line"
34988 .cindex "header lines" "From:"
34989 .cindex "Sendmail compatibility" "&""From""& line"
34990 .cindex "message" "submission"
34991 .cindex "submission mode"
34992 If a submission-mode message does not contain a &'From:'& header line, Exim
34993 adds one if either of the following conditions is true:
34994
34995 .ilist
34996 The envelope sender address is not empty (that is, this is not a bounce
34997 message). The added header line copies the envelope sender address.
34998 .next
34999 .vindex "&$authenticated_id$&"
35000 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35001 .olist
35002 .vindex "&$qualify_domain$&"
35003 If no domain is specified by the submission control, the local part is
35004 &$authenticated_id$& and the domain is &$qualify_domain$&.
35005 .next
35006 If a non-empty domain is specified by the submission control, the local
35007 part is &$authenticated_id$&, and the domain is the specified domain.
35008 .next
35009 If an empty domain is specified by the submission control,
35010 &$authenticated_id$& is assumed to be the complete address.
35011 .endlist
35012 .endlist
35013
35014 A non-empty envelope sender takes precedence.
35015
35016 If a locally-generated incoming message does not contain a &'From:'& header
35017 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35018 containing the sender's address. The calling user's login name and full name
35019 are used to construct the address, as described in section &<<SECTconstr>>&.
35020 They are obtained from the password data by calling &[getpwuid()]& (but see the
35021 &%unknown_login%& configuration option). The address is qualified with
35022 &%qualify_domain%&.
35023
35024 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35025 &'From:'& header line containing just the unqualified login name of the calling
35026 user, this is replaced by an address containing the user's login name and full
35027 name as described in section &<<SECTconstr>>&.
35028
35029
35030 .section "The Message-ID: header line" "SECID226"
35031 .cindex "&'Message-ID:'& header line"
35032 .cindex "header lines" "Message-ID:"
35033 .cindex "message" "submission"
35034 .oindex "&%message_id_header_text%&"
35035 If a locally-generated or submission-mode incoming message does not contain a
35036 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35037 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35038 to the message. If there are any &'Resent-:'& headers in the message, it
35039 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35040 message id, preceded by the letter E to ensure it starts with a letter, and
35041 followed by @ and the primary host name. Additional information can be included
35042 in this header line by setting the &%message_id_header_text%& and/or
35043 &%message_id_header_domain%& options.
35044
35045
35046 .section "The Received: header line" "SECID227"
35047 .cindex "&'Received:'& header line"
35048 .cindex "header lines" "Received:"
35049 A &'Received:'& header line is added at the start of every message. The
35050 contents are defined by the &%received_header_text%& configuration option, and
35051 Exim automatically adds a semicolon and a timestamp to the configured string.
35052
35053 The &'Received:'& header is generated as soon as the message's header lines
35054 have been received. At this stage, the timestamp in the &'Received:'& header
35055 line is the time that the message started to be received. This is the value
35056 that is seen by the DATA ACL and by the &[local_scan()]& function.
35057
35058 Once a message is accepted, the timestamp in the &'Received:'& header line is
35059 changed to the time of acceptance, which is (apart from a small delay while the
35060 -H spool file is written) the earliest time at which delivery could start.
35061
35062
35063 .section "The References: header line" "SECID228"
35064 .cindex "&'References:'& header line"
35065 .cindex "header lines" "References:"
35066 Messages created by the &(autoreply)& transport include a &'References:'&
35067 header line. This is constructed according to the rules that are described in
35068 section 3.64 of RFC 2822 (which states that replies should contain such a
35069 header line), and section 3.14 of RFC 3834 (which states that automatic
35070 responses are not different in this respect). However, because some mail
35071 processing software does not cope well with very long header lines, no more
35072 than 12 message IDs are copied from the &'References:'& header line in the
35073 incoming message. If there are more than 12, the first one and then the final
35074 11 are copied, before adding the message ID of the incoming message.
35075
35076
35077
35078 .section "The Return-path: header line" "SECID229"
35079 .cindex "&'Return-path:'& header line"
35080 .cindex "header lines" "Return-path:"
35081 .oindex "&%return_path_remove%&"
35082 &'Return-path:'& header lines are defined as something an MTA may insert when
35083 it does the final delivery of messages. (See the generic &%return_path_add%&
35084 transport option.) Therefore, they should not be present in messages in
35085 transit. If the &%return_path_remove%& configuration option is set (the
35086 default), Exim removes &'Return-path:'& header lines from incoming messages.
35087
35088
35089
35090 .section "The Sender: header line" "SECTthesenhea"
35091 .cindex "&'Sender:'& header line"
35092 .cindex "message" "submission"
35093 .cindex "header lines" "Sender:"
35094 For a locally-originated message from an untrusted user, Exim may remove an
35095 existing &'Sender:'& header line, and it may add a new one. You can modify
35096 these actions by setting the &%local_sender_retain%& option true, the
35097 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35098 control setting.
35099
35100 When a local message is received from an untrusted user and
35101 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35102 control has not been set, a check is made to see if the address given in the
35103 &'From:'& header line is the correct (local) sender of the message. The address
35104 that is expected has the login name as the local part and the value of
35105 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35106 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35107 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35108 line is added to the message.
35109
35110 If you set &%local_from_check%& false, this checking does not occur. However,
35111 the removal of an existing &'Sender:'& line still happens, unless you also set
35112 &%local_sender_retain%& to be true. It is not possible to set both of these
35113 options true at the same time.
35114
35115 .cindex "submission mode"
35116 By default, no processing of &'Sender:'& header lines is done for messages
35117 received over TCP/IP or for messages submitted by trusted users. However, when
35118 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35119 not specified on the submission control, the following processing takes place:
35120
35121 .vindex "&$authenticated_id$&"
35122 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35123 authenticated, and &$authenticated_id$& is not empty, a sender address is
35124 created as follows:
35125
35126 .ilist
35127 .vindex "&$qualify_domain$&"
35128 If no domain is specified by the submission control, the local part is
35129 &$authenticated_id$& and the domain is &$qualify_domain$&.
35130 .next
35131 If a non-empty domain is specified by the submission control, the local part
35132 is &$authenticated_id$&, and the domain is the specified domain.
35133 .next
35134 If an empty domain is specified by the submission control,
35135 &$authenticated_id$& is assumed to be the complete address.
35136 .endlist
35137
35138 This address is compared with the address in the &'From:'& header line. If they
35139 are different, a &'Sender:'& header line containing the created address is
35140 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35141 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35142
35143 .cindex "return path" "created from &'Sender:'&"
35144 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35145 the message (the envelope sender address) is changed to be the same address,
35146 except in the case of submission mode when &%sender_retain%& is specified.
35147
35148
35149
35150 .section "Adding and removing header lines in routers and transports" &&&
35151          "SECTheadersaddrem"
35152 .cindex "header lines" "adding; in router or transport"
35153 .cindex "header lines" "removing; in router or transport"
35154 When a message is delivered, the addition and removal of header lines can be
35155 specified in a system filter, or on any of the routers and transports that
35156 process the message. Section &<<SECTaddremheasys>>& contains details about
35157 modifying headers in a system filter. Header lines can also be added in an ACL
35158 as a message is received (see section &<<SECTaddheadacl>>&).
35159
35160 In contrast to what happens in a system filter, header modifications that are
35161 specified on routers and transports apply only to the particular recipient
35162 addresses that are being processed by those routers and transports. These
35163 changes do not actually take place until a copy of the message is being
35164 transported. Therefore, they do not affect the basic set of header lines, and
35165 they do not affect the values of the variables that refer to header lines.
35166
35167 &*Note*&: In particular, this means that any expansions in the configuration of
35168 the transport cannot refer to the modified header lines, because such
35169 expansions all occur before the message is actually transported.
35170
35171 For both routers and transports, the argument of a &%headers_add%&
35172 option must be in the form of one or more RFC 2822 header lines, separated by
35173 newlines (coded as &"\n"&). For example:
35174 .code
35175 headers_add = X-added-header: added by $primary_hostname\n\
35176               X-added-second: another added header line
35177 .endd
35178 Exim does not check the syntax of these added header lines.
35179
35180 Multiple &%headers_add%& options for a single router or transport can be
35181 specified; the values will append to a single list of header lines.
35182 Each header-line is separately expanded.
35183
35184 The argument of a &%headers_remove%& option must consist of a colon-separated
35185 list of header names. This is confusing, because header names themselves are
35186 often terminated by colons. In this case, the colons are the list separators,
35187 not part of the names. For example:
35188 .code
35189 headers_remove = return-receipt-to:acknowledge-to
35190 .endd
35191
35192 Multiple &%headers_remove%& options for a single router or transport can be
35193 specified; the arguments will append to a single header-names list.
35194 Each item is separately expanded.
35195 Note that colons in complex expansions which are used to
35196 form all or part of a &%headers_remove%& list
35197 will act as list separators.
35198
35199 When &%headers_add%& or &%headers_remove%& is specified on a router,
35200 items are expanded at routing time,
35201 and then associated with all addresses that are
35202 accepted by that router, and also with any new addresses that it generates. If
35203 an address passes through several routers as a result of aliasing or
35204 forwarding, the changes are cumulative.
35205
35206 .oindex "&%unseen%&"
35207 However, this does not apply to multiple routers that result from the use of
35208 the &%unseen%& option. Any header modifications that were specified by the
35209 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35210
35211 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35212 settings cannot be delivered together in a batch, so a transport is always
35213 dealing with a set of addresses that have the same header-processing
35214 requirements.
35215
35216 The transport starts by writing the original set of header lines that arrived
35217 with the message, possibly modified by the system filter. As it writes out
35218 these lines, it consults the list of header names that were attached to the
35219 recipient address(es) by &%headers_remove%& options in routers, and it also
35220 consults the transport's own &%headers_remove%& option. Header lines whose
35221 names are on either of these lists are not written out. If there are multiple
35222 instances of any listed header, they are all skipped.
35223
35224 After the remaining original header lines have been written, new header
35225 lines that were specified by routers' &%headers_add%& options are written, in
35226 the order in which they were attached to the address. These are followed by any
35227 header lines specified by the transport's &%headers_add%& option.
35228
35229 This way of handling header line modifications in routers and transports has
35230 the following consequences:
35231
35232 .ilist
35233 The original set of header lines, possibly modified by the system filter,
35234 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35235 to it, at all times.
35236 .next
35237 Header lines that are added by a router's
35238 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35239 expansion syntax in subsequent routers or the transport.
35240 .next
35241 Conversely, header lines that are specified for removal by &%headers_remove%&
35242 in a router remain visible to subsequent routers and the transport.
35243 .next
35244 Headers added to an address by &%headers_add%& in a router cannot be removed by
35245 a later router or by a transport.
35246 .next
35247 An added header can refer to the contents of an original header that is to be
35248 removed, even it has the same name as the added header. For example:
35249 .code
35250 headers_remove = subject
35251 headers_add = Subject: new subject (was: $h_subject:)
35252 .endd
35253 .endlist
35254
35255 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35256 for a &(redirect)& router that has the &%one_time%& option set.
35257
35258
35259
35260
35261
35262 .section "Constructed addresses" "SECTconstr"
35263 .cindex "address" "constructed"
35264 .cindex "constructed address"
35265 When Exim constructs a sender address for a locally-generated message, it uses
35266 the form
35267 .display
35268 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35269 .endd
35270 For example:
35271 .code
35272 Zaphod Beeblebrox <zaphod@end.univ.example>
35273 .endd
35274 The user name is obtained from the &%-F%& command line option if set, or
35275 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35276 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35277 ampersand character, this is replaced by the login name with the first letter
35278 upper cased, as is conventional in a number of operating systems. See the
35279 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35280 The &%unknown_username%& option can be used to specify user names in cases when
35281 there is no password file entry.
35282
35283 .cindex "RFC 2047"
35284 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35285 parts of it if necessary. In addition, if it contains any non-printing
35286 characters, it is encoded as described in RFC 2047, which defines a way of
35287 including non-ASCII characters in header lines. The value of the
35288 &%headers_charset%& option specifies the name of the encoding that is used (the
35289 characters are assumed to be in this encoding). The setting of
35290 &%print_topbitchars%& controls whether characters with the top bit set (that
35291 is, with codes greater than 127) count as printing characters or not.
35292
35293
35294
35295 .section "Case of local parts" "SECID230"
35296 .cindex "case of local parts"
35297 .cindex "local part" "case of"
35298 RFC 2822 states that the case of letters in the local parts of addresses cannot
35299 be assumed to be non-significant. Exim preserves the case of local parts of
35300 addresses, but by default it uses a lower-cased form when it is routing,
35301 because on most Unix systems, usernames are in lower case and case-insensitive
35302 routing is required. However, any particular router can be made to use the
35303 original case for local parts by setting the &%caseful_local_part%& generic
35304 router option.
35305
35306 .cindex "mixed-case login names"
35307 If you must have mixed-case user names on your system, the best way to proceed,
35308 assuming you want case-independent handling of incoming email, is to set up
35309 your first router to convert incoming local parts in your domains to the
35310 correct case by means of a file lookup. For example:
35311 .code
35312 correct_case:
35313   driver = redirect
35314   domains = +local_domains
35315   data = ${lookup{$local_part}cdb\
35316               {/etc/usercased.cdb}{$value}fail}\
35317               @$domain
35318 .endd
35319 For this router, the local part is forced to lower case by the default action
35320 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35321 up a new local part in the correct case. If you then set &%caseful_local_part%&
35322 on any subsequent routers which process your domains, they will operate on
35323 local parts with the correct case in a case-sensitive manner.
35324
35325
35326
35327 .section "Dots in local parts" "SECID231"
35328 .cindex "dot" "in local part"
35329 .cindex "local part" "dots in"
35330 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35331 part may not begin or end with a dot, nor have two consecutive dots in the
35332 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35333 empty components for compatibility.
35334
35335
35336
35337 .section "Rewriting addresses" "SECID232"
35338 .cindex "rewriting" "addresses"
35339 Rewriting of sender and recipient addresses, and addresses in headers, can
35340 happen automatically, or as the result of configuration options, as described
35341 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35342 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35343
35344 Automatic rewriting includes qualification, as mentioned above. The other case
35345 in which it can happen is when an incomplete non-local domain is given. The
35346 routing process may cause this to be expanded into the full domain name. For
35347 example, a header such as
35348 .code
35349 To: hare@teaparty
35350 .endd
35351 might get rewritten as
35352 .code
35353 To: hare@teaparty.wonderland.fict.example
35354 .endd
35355 Rewriting as a result of routing is the one kind of message processing that
35356 does not happen at input time, as it cannot be done until the address has
35357 been routed.
35358
35359 Strictly, one should not do &'any'& deliveries of a message until all its
35360 addresses have been routed, in case any of the headers get changed as a
35361 result of routing. However, doing this in practice would hold up many
35362 deliveries for unreasonable amounts of time, just because one address could not
35363 immediately be routed. Exim therefore does not delay other deliveries when
35364 routing of one or more addresses is deferred.
35365 .ecindex IIDmesproc
35366
35367
35368
35369 . ////////////////////////////////////////////////////////////////////////////
35370 . ////////////////////////////////////////////////////////////////////////////
35371
35372 .chapter "SMTP processing" "CHAPSMTP"
35373 .scindex IIDsmtpproc1 "SMTP" "processing details"
35374 .scindex IIDsmtpproc2 "LMTP" "processing details"
35375 Exim supports a number of different ways of using the SMTP protocol, and its
35376 LMTP variant, which is an interactive protocol for transferring messages into a
35377 closed mail store application. This chapter contains details of how SMTP is
35378 processed. For incoming mail, the following are available:
35379
35380 .ilist
35381 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35382 .next
35383 SMTP over the standard input and output (the &%-bs%& option);
35384 .next
35385 Batched SMTP on the standard input (the &%-bS%& option).
35386 .endlist
35387
35388 For mail delivery, the following are available:
35389
35390 .ilist
35391 SMTP over TCP/IP (the &(smtp)& transport);
35392 .next
35393 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35394 &"lmtp"&);
35395 .next
35396 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35397 transport);
35398 .next
35399 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35400 the &%use_bsmtp%& option set).
35401 .endlist
35402
35403 &'Batched SMTP'& is the name for a process in which batches of messages are
35404 stored in or read from files (or pipes), in a format in which SMTP commands are
35405 used to contain the envelope information.
35406
35407
35408
35409 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35410 .cindex "SMTP" "outgoing over TCP/IP"
35411 .cindex "outgoing SMTP over TCP/IP"
35412 .cindex "LMTP" "over TCP/IP"
35413 .cindex "outgoing LMTP over TCP/IP"
35414 .cindex "EHLO"
35415 .cindex "HELO"
35416 .cindex "SIZE option on MAIL command"
35417 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35418 The &%protocol%& option selects which protocol is to be used, but the actual
35419 processing is the same in both cases.
35420
35421 If, in response to its EHLO command, Exim is told that the SIZE
35422 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35423 command. The value of <&'n'&> is the message size plus the value of the
35424 &%size_addition%& option (default 1024) to allow for additions to the message
35425 such as per-transport header lines, or changes made in a
35426 .cindex "transport" "filter"
35427 .cindex "filter" "transport filter"
35428 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35429 suppressed.
35430
35431 If the remote server advertises support for PIPELINING, Exim uses the
35432 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35433 required for the transaction.
35434
35435 If the remote server advertises support for the STARTTLS command, and Exim
35436 was built to support TLS encryption, it tries to start a TLS session unless the
35437 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35438 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35439 is called for verification.
35440
35441 If the remote server advertises support for the AUTH command, Exim scans
35442 the authenticators configuration for any suitable client settings, as described
35443 in chapter &<<CHAPSMTPAUTH>>&.
35444
35445 .cindex "carriage return"
35446 .cindex "linefeed"
35447 Responses from the remote host are supposed to be terminated by CR followed by
35448 LF. However, there are known to be hosts that do not send CR characters, so in
35449 order to be able to interwork with such hosts, Exim treats LF on its own as a
35450 line terminator.
35451
35452 If a message contains a number of different addresses, all those with the same
35453 characteristics (for example, the same envelope sender) that resolve to the
35454 same set of hosts, in the same order, are sent in a single SMTP transaction,
35455 even if they are for different domains, unless there are more than the setting
35456 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35457 they are split into groups containing no more than &%max_rcpt%&s addresses
35458 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35459 in parallel sessions. The order of hosts with identical MX values is not
35460 significant when checking whether addresses can be batched in this way.
35461
35462 When the &(smtp)& transport suffers a temporary failure that is not
35463 message-related, Exim updates its transport-specific database, which contains
35464 records indexed by host name that remember which messages are waiting for each
35465 particular host. It also updates the retry database with new retry times.
35466
35467 .cindex "hints database" "retry keys"
35468 Exim's retry hints are based on host name plus IP address, so if one address of
35469 a multi-homed host is broken, it will soon be skipped most of the time.
35470 See the next section for more detail about error handling.
35471
35472 .cindex "SMTP" "passed connection"
35473 .cindex "SMTP" "batching over TCP/IP"
35474 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35475 looks in the hints database for the transport to see if there are any queued
35476 messages waiting for the host to which it is connected. If it finds one, it
35477 creates a new Exim process using the &%-MC%& option (which can only be used by
35478 a process running as root or the Exim user) and passes the TCP/IP socket to it
35479 so that it can deliver another message using the same socket. The new process
35480 does only those deliveries that are routed to the connected host, and may in
35481 turn pass the socket on to a third process, and so on.
35482
35483 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35484 limit the number of messages sent down a single TCP/IP connection.
35485
35486 .cindex "asterisk" "after IP address"
35487 The second and subsequent messages delivered down an existing connection are
35488 identified in the main log by the addition of an asterisk after the closing
35489 square bracket of the IP address.
35490
35491
35492
35493
35494 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35495 .cindex "error" "in outgoing SMTP"
35496 .cindex "SMTP" "errors in outgoing"
35497 .cindex "host" "error"
35498 Three different kinds of error are recognized for outgoing SMTP: host errors,
35499 message errors, and recipient errors.
35500
35501 .vlist
35502 .vitem "&*Host errors*&"
35503 A host error is not associated with a particular message or with a
35504 particular recipient of a message. The host errors are:
35505
35506 .ilist
35507 Connection refused or timed out,
35508 .next
35509 Any error response code on connection,
35510 .next
35511 Any error response code to EHLO or HELO,
35512 .next
35513 Loss of connection at any time, except after &"."&,
35514 .next
35515 I/O errors at any time,
35516 .next
35517 Timeouts during the session, other than in response to MAIL, RCPT or
35518 the &"."& at the end of the data.
35519 .endlist ilist
35520
35521 For a host error, a permanent error response on connection, or in response to
35522 EHLO, causes all addresses routed to the host to be failed. Any other host
35523 error causes all addresses to be deferred, and retry data to be created for the
35524 host. It is not tried again, for any message, until its retry time arrives. If
35525 the current set of addresses are not all delivered in this run (to some
35526 alternative host), the message is added to the list of those waiting for this
35527 host, so if it is still undelivered when a subsequent successful delivery is
35528 made to the host, it will be sent down the same SMTP connection.
35529
35530 .vitem "&*Message errors*&"
35531 .cindex "message" "error"
35532 A message error is associated with a particular message when sent to a
35533 particular host, but not with a particular recipient of the message. The
35534 message errors are:
35535
35536 .ilist
35537 Any error response code to MAIL, DATA, or the &"."& that terminates
35538 the data,
35539 .next
35540 Timeout after MAIL,
35541 .next
35542 Timeout or loss of connection after the &"."& that terminates the data. A
35543 timeout after the DATA command itself is treated as a host error, as is loss of
35544 connection at any other time.
35545 .endlist ilist
35546
35547 For a message error, a permanent error response (5&'xx'&) causes all addresses
35548 to be failed, and a delivery error report to be returned to the sender. A
35549 temporary error response (4&'xx'&), or one of the timeouts, causes all
35550 addresses to be deferred. Retry data is not created for the host, but instead,
35551 a retry record for the combination of host plus message id is created. The
35552 message is not added to the list of those waiting for this host. This ensures
35553 that the failing message will not be sent to this host again until the retry
35554 time arrives. However, other messages that are routed to the host are not
35555 affected, so if it is some property of the message that is causing the error,
35556 it will not stop the delivery of other mail.
35557
35558 If the remote host specified support for the SIZE parameter in its response
35559 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35560 over-large message will cause a message error because the error arrives as a
35561 response to MAIL.
35562
35563 .vitem "&*Recipient errors*&"
35564 .cindex "recipient" "error"
35565 A recipient error is associated with a particular recipient of a message. The
35566 recipient errors are:
35567
35568 .ilist
35569 Any error response to RCPT,
35570 .next
35571 Timeout after RCPT.
35572 .endlist
35573
35574 For a recipient error, a permanent error response (5&'xx'&) causes the
35575 recipient address to be failed, and a bounce message to be returned to the
35576 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35577 address to be deferred, and routing retry data to be created for it. This is
35578 used to delay processing of the address in subsequent queue runs, until its
35579 routing retry time arrives. This applies to all messages, but because it
35580 operates only in queue runs, one attempt will be made to deliver a new message
35581 to the failing address before the delay starts to operate. This ensures that,
35582 if the failure is really related to the message rather than the recipient
35583 (&"message too big for this recipient"& is a possible example), other messages
35584 have a chance of getting delivered. If a delivery to the address does succeed,
35585 the retry information gets cleared, so all stuck messages get tried again, and
35586 the retry clock is reset.
35587
35588 The message is not added to the list of those waiting for this host. Use of the
35589 host for other messages is unaffected, and except in the case of a timeout,
35590 other recipients are processed independently, and may be successfully delivered
35591 in the current SMTP session. After a timeout it is of course impossible to
35592 proceed with the session, so all addresses get deferred. However, those other
35593 than the one that failed do not suffer any subsequent retry delays. Therefore,
35594 if one recipient is causing trouble, the others have a chance of getting
35595 through when a subsequent delivery attempt occurs before the failing
35596 recipient's retry time.
35597 .endlist
35598
35599 In all cases, if there are other hosts (or IP addresses) available for the
35600 current set of addresses (for example, from multiple MX records), they are
35601 tried in this run for any undelivered addresses, subject of course to their
35602 own retry data. In other words, recipient error retry data does not take effect
35603 until the next delivery attempt.
35604
35605 Some hosts have been observed to give temporary error responses to every
35606 MAIL command at certain times (&"insufficient space"& has been seen). It
35607 would be nice if such circumstances could be recognized, and defer data for the
35608 host itself created, but this is not possible within the current Exim design.
35609 What actually happens is that retry data for every (host, message) combination
35610 is created.
35611
35612 The reason that timeouts after MAIL and RCPT are treated specially is that
35613 these can sometimes arise as a result of the remote host's verification
35614 procedures. Exim makes this assumption, and treats them as if a temporary error
35615 response had been received. A timeout after &"."& is treated specially because
35616 it is known that some broken implementations fail to recognize the end of the
35617 message if the last character of the last line is a binary zero. Thus, it is
35618 helpful to treat this case as a message error.
35619
35620 Timeouts at other times are treated as host errors, assuming a problem with the
35621 host, or the connection to it. If a timeout after MAIL, RCPT,
35622 or &"."& is really a connection problem, the assumption is that at the next try
35623 the timeout is likely to occur at some other point in the dialogue, causing it
35624 then to be treated as a host error.
35625
35626 There is experimental evidence that some MTAs drop the connection after the
35627 terminating &"."& if they do not like the contents of the message for some
35628 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35629 should be given. That is why Exim treats this case as a message rather than a
35630 host error, in order not to delay other messages to the same host.
35631
35632
35633
35634
35635 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35636 .cindex "SMTP" "incoming over TCP/IP"
35637 .cindex "incoming SMTP over TCP/IP"
35638 .cindex "inetd"
35639 .cindex "daemon"
35640 Incoming SMTP messages can be accepted in one of two ways: by running a
35641 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35642 &_/etc/inetd.conf_& should be like this:
35643 .code
35644 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35645 .endd
35646 Exim distinguishes between this case and the case of a locally running user
35647 agent using the &%-bs%& option by checking whether or not the standard input is
35648 a socket. When it is, either the port must be privileged (less than 1024), or
35649 the caller must be root or the Exim user. If any other user passes a socket
35650 with an unprivileged port number, Exim prints a message on the standard error
35651 stream and exits with an error code.
35652
35653 By default, Exim does not make a log entry when a remote host connects or
35654 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35655 unexpected. It can be made to write such log entries by setting the
35656 &%smtp_connection%& log selector.
35657
35658 .cindex "carriage return"
35659 .cindex "linefeed"
35660 Commands from the remote host are supposed to be terminated by CR followed by
35661 LF. However, there are known to be hosts that do not send CR characters. In
35662 order to be able to interwork with such hosts, Exim treats LF on its own as a
35663 line terminator.
35664 Furthermore, because common code is used for receiving messages from all
35665 sources, a CR on its own is also interpreted as a line terminator. However, the
35666 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35667
35668 .cindex "EHLO" "invalid data"
35669 .cindex "HELO" "invalid data"
35670 One area that sometimes gives rise to problems concerns the EHLO or
35671 HELO commands. Some clients send syntactically invalid versions of these
35672 commands, which Exim rejects by default. (This is nothing to do with verifying
35673 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35674 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35675 match the broken hosts that send invalid commands.
35676
35677 .cindex "SIZE option on MAIL command"
35678 .cindex "MAIL" "SIZE option"
35679 The amount of disk space available is checked whenever SIZE is received on
35680 a MAIL command, independently of whether &%message_size_limit%& or
35681 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35682 false. A temporary error is given if there is not enough space. If
35683 &%check_spool_space%& is set, the check is for that amount of space plus the
35684 value given with SIZE, that is, it checks that the addition of the incoming
35685 message will not reduce the space below the threshold.
35686
35687 When a message is successfully received, Exim includes the local message id in
35688 its response to the final &"."& that terminates the data. If the remote host
35689 logs this text it can help with tracing what has happened to a message.
35690
35691 The Exim daemon can limit the number of simultaneous incoming connections it is
35692 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35693 number of simultaneous incoming connections from a single remote host (see the
35694 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35695 rejected using the SMTP temporary error code 421.
35696
35697 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35698 subprocess has finished, as this can get lost at busy times. Instead, it looks
35699 for completed subprocesses every time it wakes up. Provided there are other
35700 things happening (new incoming calls, starts of queue runs), completed
35701 processes will be noticed and tidied away. On very quiet systems you may
35702 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35703 it will be noticed when the daemon next wakes up.
35704
35705 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35706 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35707 high system load &-- for details see the &%smtp_accept_reserve%&,
35708 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35709 applies in both the daemon and &'inetd'& cases.
35710
35711 Exim normally starts a delivery process for each message received, though this
35712 can be varied by means of the &%-odq%& command line option and the
35713 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35714 number of simultaneously running delivery processes started in this way from
35715 SMTP input can be limited by the &%smtp_accept_queue%& and
35716 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35717 subsequently received messages are just put on the input queue without starting
35718 a delivery process.
35719
35720 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35721 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35722 started up from the &'inetd'& daemon, because in that case each connection is
35723 handled by an entirely independent Exim process. Control by load average is,
35724 however, available with &'inetd'&.
35725
35726 Exim can be configured to verify addresses in incoming SMTP commands as they
35727 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35728 to rewrite addresses at this time &-- before any syntax checking is done. See
35729 section &<<SECTrewriteS>>&.
35730
35731 Exim can also be configured to limit the rate at which a client host submits
35732 MAIL and RCPT commands in a single SMTP session. See the
35733 &%smtp_ratelimit_hosts%& option.
35734
35735
35736
35737 .section "Unrecognized SMTP commands" "SECID234"
35738 .cindex "SMTP" "unrecognized commands"
35739 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35740 commands during a single SMTP connection, it drops the connection after sending
35741 the error response to the last command. The default value for
35742 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35743 abuse that subvert web servers into making connections to SMTP ports; in these
35744 circumstances, a number of non-SMTP lines are sent first.
35745
35746
35747 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35748 .cindex "SMTP" "syntax errors"
35749 .cindex "SMTP" "protocol errors"
35750 A syntax error is detected if an SMTP command is recognized, but there is
35751 something syntactically wrong with its data, for example, a malformed email
35752 address in a RCPT command. Protocol errors include invalid command
35753 sequencing such as RCPT before MAIL. If Exim receives more than
35754 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35755 drops the connection after sending the error response to the last command. The
35756 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35757 broken clients that loop sending bad commands (yes, it has been seen).
35758
35759
35760
35761 .section "Use of non-mail SMTP commands" "SECID236"
35762 .cindex "SMTP" "non-mail commands"
35763 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35764 DATA. Exim counts such commands, and drops the connection if there are too
35765 many of them in a single SMTP session. This action catches some
35766 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35767 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35768 defines what &"too many"& means. Its default value is 10.
35769
35770 When a new message is expected, one occurrence of RSET is not counted. This
35771 allows a client to send one RSET between messages (this is not necessary,
35772 but some clients do it). Exim also allows one uncounted occurrence of HELO
35773 or EHLO, and one occurrence of STARTTLS between messages. After
35774 starting up a TLS session, another EHLO is expected, and so it too is not
35775 counted.
35776
35777 The first occurrence of AUTH in a connection, or immediately following
35778 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35779 RCPT, DATA, and QUIT are counted.
35780
35781 You can control which hosts are subject to the limit set by
35782 &%smtp_accept_max_nonmail%& by setting
35783 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35784 the limit apply to all hosts. This option means that you can exclude any
35785 specific badly-behaved hosts that you have to live with.
35786
35787
35788
35789
35790 .section "The VRFY and EXPN commands" "SECID237"
35791 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35792 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35793 appropriate) in order to decide whether the command should be accepted or not.
35794
35795 .cindex "VRFY" "processing"
35796 When no ACL is defined for VRFY, or if it rejects without
35797 setting an explicit response code, the command is accepted
35798 (with a 252 SMTP response code)
35799 in order to support awkward clients that do a VRFY before every RCPT.
35800 When VRFY is accepted, it runs exactly the same code as when Exim is
35801 called with the &%-bv%& option, and returns 250/451/550
35802 SMTP response codes.
35803
35804 .cindex "EXPN" "processing"
35805 If no ACL for EXPN is defined, the command is rejected.
35806 When EXPN is accepted, a single-level expansion of the address is done.
35807 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35808 than a verification (the &%-bv%& option). If an unqualified local part is given
35809 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35810 of VRFY and EXPN commands are logged on the main and reject logs, and
35811 VRFY verification failures are logged on the main log for consistency with
35812 RCPT failures.
35813
35814
35815
35816 .section "The ETRN command" "SECTETRN"
35817 .cindex "ETRN" "processing"
35818 RFC 1985 describes an SMTP command called ETRN that is designed to
35819 overcome the security problems of the TURN command (which has fallen into
35820 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35821 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35822 should be accepted or not. If no ACL is defined, the command is rejected.
35823
35824 The ETRN command is concerned with &"releasing"& messages that are awaiting
35825 delivery to certain hosts. As Exim does not organize its message queue by host,
35826 the only form of ETRN that is supported by default is the one where the
35827 text starts with the &"#"& prefix, in which case the remainder of the text is
35828 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35829 the &%-R%& option to happen, with the remainder of the ETRN text as its
35830 argument. For example,
35831 .code
35832 ETRN #brigadoon
35833 .endd
35834 runs the command
35835 .code
35836 exim -R brigadoon
35837 .endd
35838 which causes a delivery attempt on all messages with undelivered addresses
35839 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35840 default), Exim prevents the simultaneous execution of more than one queue run
35841 for the same argument string as a result of an ETRN command. This stops
35842 a misbehaving client from starting more than one queue runner at once.
35843
35844 .cindex "hints database" "ETRN serialization"
35845 Exim implements the serialization by means of a hints database in which a
35846 record is written whenever a process is started by ETRN, and deleted when
35847 the process completes. However, Exim does not keep the SMTP session waiting for
35848 the ETRN process to complete. Once ETRN is accepted, the client is sent
35849 a &"success"& return code. Obviously there is scope for hints records to get
35850 left lying around if there is a system or program crash. To guard against this,
35851 Exim ignores any records that are more than six hours old.
35852
35853 .oindex "&%smtp_etrn_command%&"
35854 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35855 used. This specifies a command that is run whenever ETRN is received,
35856 whatever the form of its argument. For
35857 example:
35858 .code
35859 smtp_etrn_command = /etc/etrn_command $domain \
35860                     $sender_host_address
35861 .endd
35862 .vindex "&$domain$&"
35863 The string is split up into arguments which are independently expanded. The
35864 expansion variable &$domain$& is set to the argument of the ETRN command,
35865 and no syntax checking is done on the contents of this argument. Exim does not
35866 wait for the command to complete, so its status code is not checked. Exim runs
35867 under its own uid and gid when receiving incoming SMTP, so it is not possible
35868 for it to change them before running the command.
35869
35870
35871
35872 .section "Incoming local SMTP" "SECID238"
35873 .cindex "SMTP" "local incoming"
35874 Some user agents use SMTP to pass messages to their local MTA using the
35875 standard input and output, as opposed to passing the envelope on the command
35876 line and writing the message to the standard input. This is supported by the
35877 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35878 messages over TCP/IP (including the use of ACLs), except that the envelope
35879 sender given in a MAIL command is ignored unless the caller is trusted. In
35880 an ACL you can detect this form of SMTP input by testing for an empty host
35881 identification. It is common to have this as the first line in the ACL that
35882 runs for RCPT commands:
35883 .code
35884 accept hosts = :
35885 .endd
35886 This accepts SMTP messages from local processes without doing any other tests.
35887
35888
35889
35890 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35891 .cindex "SMTP" "batched outgoing"
35892 .cindex "batched SMTP output"
35893 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35894 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35895 be output in BSMTP format. No SMTP responses are possible for this form of
35896 delivery. All it is doing is using SMTP commands as a way of transmitting the
35897 envelope along with the message.
35898
35899 The message is written to the file or pipe preceded by the SMTP commands
35900 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35901 the message that start with a dot have an extra dot added. The SMTP command
35902 HELO is not normally used. If it is required, the &%message_prefix%& option
35903 can be used to specify it.
35904
35905 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35906 one recipient address at a time by default. However, you can arrange for them
35907 to handle several addresses at once by setting the &%batch_max%& option. When
35908 this is done for BSMTP, messages may contain multiple RCPT commands. See
35909 chapter &<<CHAPbatching>>& for more details.
35910
35911 .vindex "&$host$&"
35912 When one or more addresses are routed to a BSMTP transport by a router that
35913 sets up a host list, the name of the first host on the list is available to the
35914 transport in the variable &$host$&. Here is an example of such a transport and
35915 router:
35916 .code
35917 begin routers
35918 route_append:
35919   driver = manualroute
35920   transport = smtp_appendfile
35921   route_list = domain.example  batch.host.example
35922
35923 begin transports
35924 smtp_appendfile:
35925   driver = appendfile
35926   directory = /var/bsmtp/$host
35927   batch_max = 1000
35928   use_bsmtp
35929   user = exim
35930 .endd
35931 This causes messages addressed to &'domain.example'& to be written in BSMTP
35932 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35933 message (unless there are more than 1000 recipients).
35934
35935
35936
35937 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35938 .cindex "SMTP" "batched incoming"
35939 .cindex "batched SMTP input"
35940 The &%-bS%& command line option causes Exim to accept one or more messages by
35941 reading SMTP on the standard input, but to generate no responses. If the caller
35942 is trusted, the senders in the MAIL commands are believed; otherwise the
35943 sender is always the caller of Exim. Unqualified senders and receivers are not
35944 rejected (there seems little point) but instead just get qualified. HELO
35945 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35946 as NOOP; QUIT quits.
35947
35948 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35949 ACL is run in the same way as for non-SMTP local input.
35950
35951 If an error is detected while reading a message, including a missing &"."& at
35952 the end, Exim gives up immediately. It writes details of the error to the
35953 standard output in a stylized way that the calling program should be able to
35954 make some use of automatically, for example:
35955 .code
35956 554 Unexpected end of file
35957 Transaction started in line 10
35958 Error detected in line 14
35959 .endd
35960 It writes a more verbose version, for human consumption, to the standard error
35961 file, for example:
35962 .code
35963 An error was detected while processing a file of BSMTP input.
35964 The error message was:
35965
35966 501 '>' missing at end of address
35967
35968 The SMTP transaction started in line 10.
35969 The error was detected in line 12.
35970 The SMTP command at fault was:
35971
35972 rcpt to:<malformed@in.com.plete
35973
35974 1 previous message was successfully processed.
35975 The rest of the batch was abandoned.
35976 .endd
35977 The return code from Exim is zero only if there were no errors. It is 1 if some
35978 messages were accepted before an error was detected, and 2 if no messages were
35979 accepted.
35980 .ecindex IIDsmtpproc1
35981 .ecindex IIDsmtpproc2
35982
35983
35984
35985 . ////////////////////////////////////////////////////////////////////////////
35986 . ////////////////////////////////////////////////////////////////////////////
35987
35988 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35989          "Customizing messages"
35990 When a message fails to be delivered, or remains in the queue for more than a
35991 configured amount of time, Exim sends a message to the original sender, or
35992 to an alternative configured address. The text of these messages is built into
35993 the code of Exim, but it is possible to change it, either by adding a single
35994 string, or by replacing each of the paragraphs by text supplied in a file.
35995
35996 The &'From:'& and &'To:'& header lines are automatically generated; you can
35997 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35998 option. Exim also adds the line
35999 .code
36000 Auto-Submitted: auto-generated
36001 .endd
36002 to all warning and bounce messages,
36003
36004
36005 .section "Customizing bounce messages" "SECID239"
36006 .cindex "customizing" "bounce message"
36007 .cindex "bounce message" "customizing"
36008 If &%bounce_message_text%& is set, its contents are included in the default
36009 message immediately after &"This message was created automatically by mail
36010 delivery software."& The string is not expanded. It is not used if
36011 &%bounce_message_file%& is set.
36012
36013 When &%bounce_message_file%& is set, it must point to a template file for
36014 constructing error messages. The file consists of a series of text items,
36015 separated by lines consisting of exactly four asterisks. If the file cannot be
36016 opened, default text is used and a message is written to the main and panic
36017 logs. If any text item in the file is empty, default text is used for that
36018 item.
36019
36020 .vindex "&$bounce_recipient$&"
36021 .vindex "&$bounce_return_size_limit$&"
36022 Each item of text that is read from the file is expanded, and there are two
36023 expansion variables which can be of use here: &$bounce_recipient$& is set to
36024 the recipient of an error message while it is being created, and
36025 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36026 option, rounded to a whole number.
36027
36028 The items must appear in the file in the following order:
36029
36030 .ilist
36031 The first item is included in the headers, and should include at least a
36032 &'Subject:'& header. Exim does not check the syntax of these headers.
36033 .next
36034 The second item forms the start of the error message. After it, Exim lists the
36035 failing addresses with their error messages.
36036 .next
36037 The third item is used to introduce any text from pipe transports that is to be
36038 returned to the sender. It is omitted if there is no such text.
36039 .next
36040 The fourth, fifth and sixth items will be ignored and may be empty.
36041 The fields exist for back-compatibility
36042 .endlist
36043
36044 The default state (&%bounce_message_file%& unset) is equivalent to the
36045 following file, in which the sixth item is empty. The &'Subject:'& and some
36046 other lines have been split in order to fit them on the page:
36047 .code
36048 Subject: Mail delivery failed
36049   ${if eq{$sender_address}{$bounce_recipient}
36050   {: returning message to sender}}
36051 ****
36052 This message was created automatically by mail delivery software.
36053
36054 A message ${if eq{$sender_address}{$bounce_recipient}
36055   {that you sent }{sent by
36056
36057 <$sender_address>
36058
36059 }}could not be delivered to all of its recipients.
36060 This is a permanent error. The following address(es) failed:
36061 ****
36062 The following text was generated during the delivery attempt(s):
36063 ****
36064 ------ This is a copy of the message, including all the headers.
36065   ------
36066 ****
36067 ------ The body of the message is $message_size characters long;
36068   only the first
36069 ------ $bounce_return_size_limit or so are included here.
36070 ****
36071 .endd
36072 .section "Customizing warning messages" "SECTcustwarn"
36073 .cindex "customizing" "warning message"
36074 .cindex "warning of delay" "customizing the message"
36075 The option &%warn_message_file%& can be pointed at a template file for use when
36076 warnings about message delays are created. In this case there are only three
36077 text sections:
36078
36079 .ilist
36080 The first item is included in the headers, and should include at least a
36081 &'Subject:'& header. Exim does not check the syntax of these headers.
36082 .next
36083 The second item forms the start of the warning message. After it, Exim lists
36084 the delayed addresses.
36085 .next
36086 The third item then ends the message.
36087 .endlist
36088
36089 The default state is equivalent to the following file, except that some lines
36090 have been split here, in order to fit them on the page:
36091 .code
36092 Subject: Warning: message $message_exim_id delayed
36093   $warn_message_delay
36094 ****
36095 This message was created automatically by mail delivery software.
36096
36097 A message ${if eq{$sender_address}{$warn_message_recipients}
36098 {that you sent }{sent by
36099
36100 <$sender_address>
36101
36102 }}has not been delivered to all of its recipients after
36103 more than $warn_message_delay in the queue on $primary_hostname.
36104
36105 The message identifier is:     $message_exim_id
36106 The subject of the message is: $h_subject
36107 The date of the message is:    $h_date
36108
36109 The following address(es) have not yet been delivered:
36110 ****
36111 No action is required on your part. Delivery attempts will
36112 continue for some time, and this warning may be repeated at
36113 intervals if the message remains undelivered. Eventually the
36114 mail delivery software will give up, and when that happens,
36115 the message will be returned to you.
36116 .endd
36117 .vindex "&$warn_message_delay$&"
36118 .vindex "&$warn_message_recipients$&"
36119 However, in the default state the subject and date lines are omitted if no
36120 appropriate headers exist. During the expansion of this file,
36121 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36122 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36123 of recipients for the warning message. There may be more than one if there are
36124 multiple addresses with different &%errors_to%& settings on the routers that
36125 handled them.
36126
36127
36128
36129
36130 . ////////////////////////////////////////////////////////////////////////////
36131 . ////////////////////////////////////////////////////////////////////////////
36132
36133 .chapter "Some common configuration settings" "CHAPcomconreq"
36134 This chapter discusses some configuration settings that seem to be fairly
36135 common. More examples and discussion can be found in the Exim book.
36136
36137
36138
36139 .section "Sending mail to a smart host" "SECID240"
36140 .cindex "smart host" "example router"
36141 If you want to send all mail for non-local domains to a &"smart host"&, you
36142 should replace the default &(dnslookup)& router with a router which does the
36143 routing explicitly:
36144 .code
36145 send_to_smart_host:
36146   driver = manualroute
36147   route_list = !+local_domains smart.host.name
36148   transport = remote_smtp
36149 .endd
36150 You can use the smart host's IP address instead of the name if you wish.
36151 If you are using Exim only to submit messages to a smart host, and not for
36152 receiving incoming messages, you can arrange for it to do the submission
36153 synchronously by setting the &%mua_wrapper%& option (see chapter
36154 &<<CHAPnonqueueing>>&).
36155
36156
36157
36158
36159 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36160 .cindex "mailing lists"
36161 Exim can be used to run simple mailing lists, but for large and/or complicated
36162 requirements, the use of additional specialized mailing list software such as
36163 Majordomo or Mailman is recommended.
36164
36165 The &(redirect)& router can be used to handle mailing lists where each list
36166 is maintained in a separate file, which can therefore be managed by an
36167 independent manager. The &%domains%& router option can be used to run these
36168 lists in a separate domain from normal mail. For example:
36169 .code
36170 lists:
36171   driver = redirect
36172   domains = lists.example
36173   file = /usr/lists/$local_part
36174   forbid_pipe
36175   forbid_file
36176   errors_to = $local_part-request@lists.example
36177   no_more
36178 .endd
36179 This router is skipped for domains other than &'lists.example'&. For addresses
36180 in that domain, it looks for a file that matches the local part. If there is no
36181 such file, the router declines, but because &%no_more%& is set, no subsequent
36182 routers are tried, and so the whole delivery fails.
36183
36184 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36185 expanded into a filename or a pipe delivery, which is usually inappropriate in
36186 a mailing list.
36187
36188 .oindex "&%errors_to%&"
36189 The &%errors_to%& option specifies that any delivery errors caused by addresses
36190 taken from a mailing list are to be sent to the given address rather than the
36191 original sender of the message. However, before acting on this, Exim verifies
36192 the error address, and ignores it if verification fails.
36193
36194 For example, using the configuration above, mail sent to
36195 &'dicts@lists.example'& is passed on to those addresses contained in
36196 &_/usr/lists/dicts_&, with error reports directed to
36197 &'dicts-request@lists.example'&, provided that this address can be verified.
36198 There could be a file called &_/usr/lists/dicts-request_& containing
36199 the address(es) of this particular list's manager(s), but other approaches,
36200 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36201 or &%local_part_suffix%& options) to handle addresses of the form
36202 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36203
36204
36205
36206 .section "Syntax errors in mailing lists" "SECID241"
36207 .cindex "mailing lists" "syntax errors in"
36208 If an entry in redirection data contains a syntax error, Exim normally defers
36209 delivery of the original address. That means that a syntax error in a mailing
36210 list holds up all deliveries to the list. This may not be appropriate when a
36211 list is being maintained automatically from data supplied by users, and the
36212 addresses are not rigorously checked.
36213
36214 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36215 entries that fail to parse, noting the incident in the log. If in addition
36216 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36217 whenever a broken address is skipped. It is usually appropriate to set
36218 &%syntax_errors_to%& to the same address as &%errors_to%&.
36219
36220
36221
36222 .section "Re-expansion of mailing lists" "SECID242"
36223 .cindex "mailing lists" "re-expansion of"
36224 Exim remembers every individual address to which a message has been delivered,
36225 in order to avoid duplication, but it normally stores only the original
36226 recipient addresses with a message. If all the deliveries to a mailing list
36227 cannot be done at the first attempt, the mailing list is re-expanded when the
36228 delivery is next tried. This means that alterations to the list are taken into
36229 account at each delivery attempt, so addresses that have been added to
36230 the list since the message arrived will therefore receive a copy of the
36231 message, even though it pre-dates their subscription.
36232
36233 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36234 on the &(redirect)& router. If this is done, any addresses generated by the
36235 router that fail to deliver at the first attempt are added to the message as
36236 &"top level"& addresses, and the parent address that generated them is marked
36237 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36238 subsequent delivery attempts. The disadvantage of this is that if any of the
36239 failing addresses are incorrect, correcting them in the file has no effect on
36240 pre-existing messages.
36241
36242 The original top-level address is remembered with each of the generated
36243 addresses, and is output in any log messages. However, any intermediate parent
36244 addresses are not recorded. This makes a difference to the log only if the
36245 &%all_parents%& selector is set, but for mailing lists there is normally only
36246 one level of expansion anyway.
36247
36248
36249
36250 .section "Closed mailing lists" "SECID243"
36251 .cindex "mailing lists" "closed"
36252 The examples so far have assumed open mailing lists, to which anybody may
36253 send mail. It is also possible to set up closed lists, where mail is accepted
36254 from specified senders only. This is done by making use of the generic
36255 &%senders%& option to restrict the router that handles the list.
36256
36257 The following example uses the same file as a list of recipients and as a list
36258 of permitted senders. It requires three routers:
36259 .code
36260 lists_request:
36261   driver = redirect
36262   domains = lists.example
36263   local_part_suffix = -request
36264   file = /usr/lists/$local_part$local_part_suffix
36265   no_more
36266
36267 lists_post:
36268   driver = redirect
36269   domains = lists.example
36270   senders = ${if exists {/usr/lists/$local_part}\
36271              {lsearch;/usr/lists/$local_part}{*}}
36272   file = /usr/lists/$local_part
36273   forbid_pipe
36274   forbid_file
36275   errors_to = $local_part-request@lists.example
36276   no_more
36277
36278 lists_closed:
36279   driver = redirect
36280   domains = lists.example
36281   allow_fail
36282   data = :fail: $local_part@lists.example is a closed mailing list
36283 .endd
36284 All three routers have the same &%domains%& setting, so for any other domains,
36285 they are all skipped. The first router runs only if the local part ends in
36286 &%-request%&. It handles messages to the list manager(s) by means of an open
36287 mailing list.
36288
36289 The second router runs only if the &%senders%& precondition is satisfied. It
36290 checks for the existence of a list that corresponds to the local part, and then
36291 checks that the sender is on the list by means of a linear search. It is
36292 necessary to check for the existence of the file before trying to search it,
36293 because otherwise Exim thinks there is a configuration error. If the file does
36294 not exist, the expansion of &%senders%& is *, which matches all senders. This
36295 means that the router runs, but because there is no list, declines, and
36296 &%no_more%& ensures that no further routers are run. The address fails with an
36297 &"unrouteable address"& error.
36298
36299 The third router runs only if the second router is skipped, which happens when
36300 a mailing list exists, but the sender is not on it. This router forcibly fails
36301 the address, giving a suitable error message.
36302
36303
36304
36305
36306 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36307 .cindex "VERP"
36308 .cindex "Variable Envelope Return Paths"
36309 .cindex "envelope from"
36310 .cindex "envelope sender"
36311 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36312 are a way of helping mailing list administrators discover which subscription
36313 address is the cause of a particular delivery failure. The idea is to encode
36314 the original recipient address in the outgoing envelope sender address, so that
36315 if the message is forwarded by another host and then subsequently bounces, the
36316 original recipient can be extracted from the recipient address of the bounce.
36317
36318 .oindex &%errors_to%&
36319 .oindex &%return_path%&
36320 Envelope sender addresses can be modified by Exim using two different
36321 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36322 list examples), or the &%return_path%& option on a transport. The second of
36323 these is effective only if the message is successfully delivered to another
36324 host; it is not used for errors detected on the local host (see the description
36325 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36326 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36327 .code
36328 verp_smtp:
36329   driver = smtp
36330   max_rcpt = 1
36331   return_path = \
36332     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36333       {$1-request+$local_part=$domain@your.dom.example}fail}
36334 .endd
36335 This has the effect of rewriting the return path (envelope sender) on outgoing
36336 SMTP messages, if the local part of the original return path ends in
36337 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36338 local part and domain of the recipient into the return path. Suppose, for
36339 example, that a message whose return path has been set to
36340 &'somelist-request@your.dom.example'& is sent to
36341 &'subscriber@other.dom.example'&. In the transport, the return path is
36342 rewritten as
36343 .code
36344 somelist-request+subscriber=other.dom.example@your.dom.example
36345 .endd
36346 .vindex "&$local_part$&"
36347 For this to work, you must tell Exim to send multiple copies of messages that
36348 have more than one recipient, so that each copy has just one recipient. This is
36349 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36350 might be sent to several different recipients in the same domain, in which case
36351 &$local_part$& is not available in the transport, because it is not unique.
36352
36353 Unless your host is doing nothing but mailing list deliveries, you should
36354 probably use a separate transport for the VERP deliveries, so as not to use
36355 extra resources in making one-per-recipient copies for other deliveries. This
36356 can easily be done by expanding the &%transport%& option in the router:
36357 .code
36358 dnslookup:
36359   driver = dnslookup
36360   domains = ! +local_domains
36361   transport = \
36362     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36363       {verp_smtp}{remote_smtp}}
36364   no_more
36365 .endd
36366 If you want to change the return path using &%errors_to%& in a router instead
36367 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36368 routers that handle mailing list addresses. This will ensure that all delivery
36369 errors, including those detected on the local host, are sent to the VERP
36370 address.
36371
36372 On a host that does no local deliveries and has no manual routing, only the
36373 &(dnslookup)& router needs to be changed. A special transport is not needed for
36374 SMTP deliveries. Every mailing list recipient has its own return path value,
36375 and so Exim must hand them to the transport one at a time. Here is an example
36376 of a &(dnslookup)& router that implements VERP:
36377 .code
36378 verp_dnslookup:
36379   driver = dnslookup
36380   domains = ! +local_domains
36381   transport = remote_smtp
36382   errors_to = \
36383     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36384      {$1-request+$local_part=$domain@your.dom.example}fail}
36385   no_more
36386 .endd
36387 Before you start sending out messages with VERPed return paths, you must also
36388 configure Exim to accept the bounce messages that come back to those paths.
36389 Typically this is done by setting a &%local_part_suffix%& option for a
36390 router, and using this to route the messages to wherever you want to handle
36391 them.
36392
36393 The overhead incurred in using VERP depends very much on the size of the
36394 message, the number of recipient addresses that resolve to the same remote
36395 host, and the speed of the connection over which the message is being sent. If
36396 a lot of addresses resolve to the same host and the connection is slow, sending
36397 a separate copy of the message for each address may take substantially longer
36398 than sending a single copy with many recipients (for which VERP cannot be
36399 used).
36400
36401
36402
36403
36404
36405
36406 .section "Virtual domains" "SECTvirtualdomains"
36407 .cindex "virtual domains"
36408 .cindex "domain" "virtual"
36409 The phrase &'virtual domain'& is unfortunately used with two rather different
36410 meanings:
36411
36412 .ilist
36413 A domain for which there are no real mailboxes; all valid local parts are
36414 aliases for other email addresses. Common examples are organizational
36415 top-level domains and &"vanity"& domains.
36416 .next
36417 One of a number of independent domains that are all handled by the same host,
36418 with mailboxes on that host, but where the mailbox owners do not necessarily
36419 have login accounts on that host.
36420 .endlist
36421
36422 The first usage is probably more common, and does seem more &"virtual"& than
36423 the second. This kind of domain can be handled in Exim with a straightforward
36424 aliasing router. One approach is to create a separate alias file for each
36425 virtual domain. Exim can test for the existence of the alias file to determine
36426 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36427 to a router of this form:
36428 .code
36429 virtual:
36430   driver = redirect
36431   domains = dsearch;/etc/mail/virtual
36432   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36433   no_more
36434 .endd
36435 The &%domains%& option specifies that the router is to be skipped, unless there
36436 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36437 domain that is being processed. When the router runs, it looks up the local
36438 part in the file to find a new address (or list of addresses). The &%no_more%&
36439 setting ensures that if the lookup fails (leading to &%data%& being an empty
36440 string), Exim gives up on the address without trying any subsequent routers.
36441
36442 This one router can handle all the virtual domains because the alias filenames
36443 follow a fixed pattern. Permissions can be arranged so that appropriate people
36444 can edit the different alias files. A successful aliasing operation results in
36445 a new envelope recipient address, which is then routed from scratch.
36446
36447 The other kind of &"virtual"& domain can also be handled in a straightforward
36448 way. One approach is to create a file for each domain containing a list of
36449 valid local parts, and use it in a router like this:
36450 .code
36451 my_domains:
36452   driver = accept
36453   domains = dsearch;/etc/mail/domains
36454   local_parts = lsearch;/etc/mail/domains/$domain
36455   transport = my_mailboxes
36456 .endd
36457 The address is accepted if there is a file for the domain, and the local part
36458 can be found in the file. The &%domains%& option is used to check for the
36459 file's existence because &%domains%& is tested before the &%local_parts%&
36460 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36461 because that option is tested after &%local_parts%&. The transport is as
36462 follows:
36463 .code
36464 my_mailboxes:
36465   driver = appendfile
36466   file = /var/mail/$domain/$local_part
36467   user = mail
36468 .endd
36469 This uses a directory of mailboxes for each domain. The &%user%& setting is
36470 required, to specify which uid is to be used for writing to the mailboxes.
36471
36472 The configuration shown here is just one example of how you might support this
36473 requirement. There are many other ways this kind of configuration can be set
36474 up, for example, by using a database instead of separate files to hold all the
36475 information about the domains.
36476
36477
36478
36479 .section "Multiple user mailboxes" "SECTmulbox"
36480 .cindex "multiple mailboxes"
36481 .cindex "mailbox" "multiple"
36482 .cindex "local part" "prefix"
36483 .cindex "local part" "suffix"
36484 Heavy email users often want to operate with multiple mailboxes, into which
36485 incoming mail is automatically sorted. A popular way of handling this is to
36486 allow users to use multiple sender addresses, so that replies can easily be
36487 identified. Users are permitted to add prefixes or suffixes to their local
36488 parts for this purpose. The wildcard facility of the generic router options
36489 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36490 example, consider this router:
36491 .code
36492 userforward:
36493   driver = redirect
36494   check_local_user
36495   file = $home/.forward
36496   local_part_suffix = -*
36497   local_part_suffix_optional
36498   allow_filter
36499 .endd
36500 .vindex "&$local_part_suffix$&"
36501 It runs a user's &_.forward_& file for all local parts of the form
36502 &'username-*'&. Within the filter file the user can distinguish different
36503 cases by testing the variable &$local_part_suffix$&. For example:
36504 .code
36505 if $local_part_suffix contains -special then
36506 save /home/$local_part/Mail/special
36507 endif
36508 .endd
36509 If the filter file does not exist, or does not deal with such addresses, they
36510 fall through to subsequent routers, and, assuming no subsequent use of the
36511 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36512 control over which suffixes are valid.
36513
36514 Alternatively, a suffix can be used to trigger the use of a different
36515 &_.forward_& file &-- which is the way a similar facility is implemented in
36516 another MTA:
36517 .code
36518 userforward:
36519   driver = redirect
36520   check_local_user
36521   file = $home/.forward$local_part_suffix
36522   local_part_suffix = -*
36523   local_part_suffix_optional
36524   allow_filter
36525 .endd
36526 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36527 example, &_.forward-special_& is used. Once again, if the appropriate file
36528 does not exist, or does not deal with the address, it is passed on to
36529 subsequent routers, which could, if required, look for an unqualified
36530 &_.forward_& file to use as a default.
36531
36532
36533
36534 .section "Simplified vacation processing" "SECID244"
36535 .cindex "vacation processing"
36536 The traditional way of running the &'vacation'& program is for a user to set up
36537 a pipe command in a &_.forward_& file
36538 (see section &<<SECTspecitredli>>& for syntax details).
36539 This is prone to error by inexperienced users. There are two features of Exim
36540 that can be used to make this process simpler for users:
36541
36542 .ilist
36543 A local part prefix such as &"vacation-"& can be specified on a router which
36544 can cause the message to be delivered directly to the &'vacation'& program, or
36545 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36546 &_.forward_& file are then much simpler. For example:
36547 .code
36548 spqr, vacation-spqr
36549 .endd
36550 .next
36551 The &%require_files%& generic router option can be used to trigger a
36552 vacation delivery by checking for the existence of a certain file in the
36553 user's home directory. The &%unseen%& generic option should also be used, to
36554 ensure that the original delivery also proceeds. In this case, all the user has
36555 to do is to create a file called, say, &_.vacation_&, containing a vacation
36556 message.
36557 .endlist
36558
36559 Another advantage of both these methods is that they both work even when the
36560 use of arbitrary pipes by users is locked out.
36561
36562
36563
36564 .section "Taking copies of mail" "SECID245"
36565 .cindex "message" "copying every"
36566 Some installations have policies that require archive copies of all messages to
36567 be made. A single copy of each message can easily be taken by an appropriate
36568 command in a system filter, which could, for example, use a different file for
36569 each day's messages.
36570
36571 There is also a shadow transport mechanism that can be used to take copies of
36572 messages that are successfully delivered by local transports, one copy per
36573 delivery. This could be used, &'inter alia'&, to implement automatic
36574 notification of delivery by sites that insist on doing such things.
36575
36576
36577
36578 .section "Intermittently connected hosts" "SECID246"
36579 .cindex "intermittently connected hosts"
36580 It has become quite common (because it is cheaper) for hosts to connect to the
36581 Internet periodically rather than remain connected all the time. The normal
36582 arrangement is that mail for such hosts accumulates on a system that is
36583 permanently connected.
36584
36585 Exim was designed for use on permanently connected hosts, and so it is not
36586 particularly well-suited to use in an intermittently connected environment.
36587 Nevertheless there are some features that can be used.
36588
36589
36590 .section "Exim on the upstream server host" "SECID247"
36591 It is tempting to arrange for incoming mail for the intermittently connected
36592 host to remain in Exim's queue until the client connects. However, this
36593 approach does not scale very well. Two different kinds of waiting message are
36594 being mixed up in the same queue &-- those that cannot be delivered because of
36595 some temporary problem, and those that are waiting for their destination host
36596 to connect. This makes it hard to manage the queue, as well as wasting
36597 resources, because each queue runner scans the entire queue.
36598
36599 A better approach is to separate off those messages that are waiting for an
36600 intermittently connected host. This can be done by delivering these messages
36601 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36602 format, from where they are transmitted by other software when their
36603 destination connects. This makes it easy to collect all the mail for one host
36604 in a single directory, and to apply local timeout rules on a per-message basis
36605 if required.
36606
36607 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36608 you are doing this, you should configure Exim with a long retry period for the
36609 intermittent host. For example:
36610 .code
36611 cheshire.wonderland.fict.example    *   F,5d,24h
36612 .endd
36613 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36614 which messages it has queued up for that host. Once the intermittent host comes
36615 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36616 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36617 causes all the queued up messages to be delivered, often down a single SMTP
36618 connection. While the host remains connected, any new messages get delivered
36619 immediately.
36620
36621 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36622 issued with a different IP address each time it connects, Exim's retry
36623 mechanisms on the holding host get confused, because the IP address is normally
36624 used as part of the key string for holding retry information. This can be
36625 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36626 Since this has disadvantages for permanently connected hosts, it is best to
36627 arrange a separate transport for the intermittently connected ones.
36628
36629
36630
36631 .section "Exim on the intermittently connected client host" "SECID248"
36632 The value of &%smtp_accept_queue_per_connection%& should probably be
36633 increased, or even set to zero (that is, disabled) on the intermittently
36634 connected host, so that all incoming messages down a single connection get
36635 delivered immediately.
36636
36637 .cindex "SMTP" "passed connection"
36638 .cindex "SMTP" "multiple deliveries"
36639 .cindex "multiple SMTP deliveries"
36640 Mail waiting to be sent from an intermittently connected host will probably
36641 not have been routed, because without a connection DNS lookups are not
36642 possible. This means that if a normal queue run is done at connection time,
36643 each message is likely to be sent in a separate SMTP session. This can be
36644 avoided by starting the queue run with a command line option beginning with
36645 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36646 first pass, routing is done but no deliveries take place. The second pass is a
36647 normal queue run; since all the messages have been previously routed, those
36648 destined for the same host are likely to get sent as multiple deliveries in a
36649 single SMTP connection.
36650
36651
36652
36653 . ////////////////////////////////////////////////////////////////////////////
36654 . ////////////////////////////////////////////////////////////////////////////
36655
36656 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36657          "Exim as a non-queueing client"
36658 .cindex "client, non-queueing"
36659 .cindex "smart host" "suppressing queueing"
36660 On a personal computer, it is a common requirement for all
36661 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36662 configured to operate that way, for all the popular operating systems.
36663 However, there are some MUAs for Unix-like systems that cannot be so
36664 configured: they submit messages using the command line interface of
36665 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36666 messages this way.
36667
36668 If the personal computer runs continuously, there is no problem, because it can
36669 run a conventional MTA that handles delivery to the smart host, and deal with
36670 any delays via its queueing mechanism. However, if the computer does not run
36671 continuously or runs different operating systems at different times, queueing
36672 email is not desirable.
36673
36674 There is therefore a requirement for something that can provide the
36675 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36676 any queueing or retrying facilities. Furthermore, the delivery to the smart
36677 host should be synchronous, so that if it fails, the sending MUA is immediately
36678 informed. In other words, we want something that extends an MUA that submits
36679 to a local MTA via the command line so that it behaves like one that submits
36680 to a remote smart host using TCP/SMTP.
36681
36682 There are a number of applications (for example, there is one called &'ssmtp'&)
36683 that do this job. However, people have found them to be lacking in various
36684 ways. For instance, you might want to allow aliasing and forwarding to be done
36685 before sending a message to the smart host.
36686
36687 Exim already had the necessary infrastructure for doing this job. Just a few
36688 tweaks were needed to make it behave as required, though it is somewhat of an
36689 overkill to use a fully-featured MTA for this purpose.
36690
36691 .oindex "&%mua_wrapper%&"
36692 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36693 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36694 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36695 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36696 compatible router and transport configuration. Typically there will be just one
36697 router and one transport, sending everything to a smart host.
36698
36699 When run in MUA wrapping mode, the behaviour of Exim changes in the
36700 following ways:
36701
36702 .ilist
36703 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36704 In other words, the only way to submit messages is via the command line.
36705 .next
36706 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36707 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36708 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36709 does not finish until the delivery attempt is complete. If the delivery is
36710 successful, a zero return code is given.
36711 .next
36712 Address redirection is permitted, but the final routing for all addresses must
36713 be to the same remote transport, and to the same list of hosts. Furthermore,
36714 the return address (envelope sender) must be the same for all recipients, as
36715 must any added or deleted header lines. In other words, it must be possible to
36716 deliver the message in a single SMTP transaction, however many recipients there
36717 are.
36718 .next
36719 If these conditions are not met, or if routing any address results in a
36720 failure or defer status, or if Exim is unable to deliver all the recipients
36721 successfully to one of the smart hosts, delivery of the entire message fails.
36722 .next
36723 Because no queueing is allowed, all failures are treated as permanent; there
36724 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36725 smart host. Furthermore, because only a single yes/no response can be given to
36726 the caller, it is not possible to deliver to some recipients and not others. If
36727 there is an error (temporary or permanent) for any recipient, all are failed.
36728 .next
36729 If more than one smart host is listed, Exim will try another host after a
36730 connection failure or a timeout, in the normal way. However, if this kind of
36731 failure happens for all the hosts, the delivery fails.
36732 .next
36733 When delivery fails, an error message is written to the standard error stream
36734 (as well as to Exim's log), and Exim exits to the caller with a return code
36735 value 1. The message is expunged from Exim's spool files. No bounce messages
36736 are ever generated.
36737 .next
36738 No retry data is maintained, and any retry rules are ignored.
36739 .next
36740 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36741 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36742 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36743 .endlist
36744
36745 The overall effect is that Exim makes a single synchronous attempt to deliver
36746 the message, failing if there is any kind of problem. Because no local
36747 deliveries are done and no daemon can be run, Exim does not need root
36748 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36749 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36750 the advantages and disadvantages of running without root privilege.
36751
36752
36753
36754
36755 . ////////////////////////////////////////////////////////////////////////////
36756 . ////////////////////////////////////////////////////////////////////////////
36757
36758 .chapter "Log files" "CHAPlog"
36759 .scindex IIDloggen "log" "general description"
36760 .cindex "log" "types of"
36761 Exim writes three different logs, referred to as the main log, the reject log,
36762 and the panic log:
36763
36764 .ilist
36765 .cindex "main log"
36766 The main log records the arrival of each message and each delivery in a single
36767 line in each case. The format is as compact as possible, in an attempt to keep
36768 down the size of log files. Two-character flag sequences make it easy to pick
36769 out these lines. A number of other events are recorded in the main log. Some of
36770 them are optional, in which case the &%log_selector%& option controls whether
36771 they are included or not. A Perl script called &'eximstats'&, which does simple
36772 analysis of main log files, is provided in the Exim distribution (see section
36773 &<<SECTmailstat>>&).
36774 .next
36775 .cindex "reject log"
36776 The reject log records information from messages that are rejected as a result
36777 of a configuration option (that is, for policy reasons).
36778 The first line of each rejection is a copy of the line that is also written to
36779 the main log. Then, if the message's header has been read at the time the log
36780 is written, its contents are written to this log. Only the original header
36781 lines are available; header lines added by ACLs are not logged. You can use the
36782 reject log to check that your policy controls are working correctly; on a busy
36783 host this may be easier than scanning the main log for rejection messages. You
36784 can suppress the writing of the reject log by setting &%write_rejectlog%&
36785 false.
36786 .next
36787 .cindex "panic log"
36788 .cindex "system log"
36789 When certain serious errors occur, Exim writes entries to its panic log. If the
36790 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36791 are usually written to the main log as well, but can get lost amid the mass of
36792 other entries. The panic log should be empty under normal circumstances. It is
36793 therefore a good idea to check it (or to have a &'cron'& script check it)
36794 regularly, in order to become aware of any problems. When Exim cannot open its
36795 panic log, it tries as a last resort to write to the system log (syslog). This
36796 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36797 message itself is written at priority LOG_CRIT.
36798 .endlist
36799
36800 Every log line starts with a timestamp, in the format shown in the following
36801 example. Note that many of the examples shown in this chapter are line-wrapped.
36802 In the log file, this would be all on one line:
36803 .code
36804 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36805   by QUIT
36806 .endd
36807 By default, the timestamps are in the local timezone. There are two
36808 ways of changing this:
36809
36810 .ilist
36811 You can set the &%timezone%& option to a different time zone; in particular, if
36812 you set
36813 .code
36814 timezone = UTC
36815 .endd
36816 the timestamps will be in UTC (aka GMT).
36817 .next
36818 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36819 example:
36820 .code
36821 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36822 .endd
36823 .endlist
36824
36825 .cindex "log" "process ids in"
36826 .cindex "pid (process id)" "in log lines"
36827 Exim does not include its process id in log lines by default, but you can
36828 request that it does so by specifying the &`pid`& log selector (see section
36829 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36830 brackets, immediately after the time and date.
36831
36832
36833
36834
36835 .section "Where the logs are written" "SECTwhelogwri"
36836 .cindex "log" "destination"
36837 .cindex "log" "to file"
36838 .cindex "log" "to syslog"
36839 .cindex "syslog"
36840 The logs may be written to local files, or to syslog, or both. However, it
36841 should be noted that many syslog implementations use UDP as a transport, and
36842 are therefore unreliable in the sense that messages are not guaranteed to
36843 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36844 It has also been reported that on large log files (tens of megabytes) you may
36845 need to tweak syslog to prevent it syncing the file with each write &-- on
36846 Linux this has been seen to make syslog take 90% plus of CPU time.
36847
36848 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36849 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36850 configuration. This latter string is expanded, so it can contain, for example,
36851 references to the host name:
36852 .code
36853 log_file_path = /var/log/$primary_hostname/exim_%slog
36854 .endd
36855 It is generally advisable, however, to set the string in &_Local/Makefile_&
36856 rather than at runtime, because then the setting is available right from the
36857 start of Exim's execution. Otherwise, if there's something it wants to log
36858 before it has read the configuration file (for example, an error in the
36859 configuration file) it will not use the path you want, and may not be able to
36860 log at all.
36861
36862 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36863 list, currently limited to at most two items. This is one option where the
36864 facility for changing a list separator may not be used. The list must always be
36865 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36866 otherwise the item must either be an absolute path, containing &`%s`& at the
36867 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36868 implying the use of a default path.
36869
36870 When Exim encounters an empty item in the list, it searches the list defined by
36871 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36872 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36873 mean &"use the path specified at build time"&. It no such item exists, log
36874 files are written in the &_log_& subdirectory of the spool directory. This is
36875 equivalent to the setting:
36876 .code
36877 log_file_path = $spool_directory/log/%slog
36878 .endd
36879 If you do not specify anything at build time or runtime,
36880 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36881 that is where the logs are written.
36882
36883 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36884 are in use &-- see section &<<SECTdatlogfil>>& below.
36885
36886 Here are some examples of possible settings:
36887 .display
36888 &`LOG_FILE_PATH=syslog                    `& syslog only
36889 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36890 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36891 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36892 .endd
36893 If there are more than two paths in the list, the first is used and a panic
36894 error is logged.
36895
36896
36897
36898 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36899 .cindex "log" "cycling local files"
36900 .cindex "cycling logs"
36901 .cindex "&'exicyclog'&"
36902 .cindex "log" "local files; writing to"
36903 Some operating systems provide centralized and standardized methods for cycling
36904 log files. For those that do not, a utility script called &'exicyclog'& is
36905 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36906 main and reject logs each time it is called. The maximum number of old logs to
36907 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36908
36909 An Exim delivery process opens the main log when it first needs to write to it,
36910 and it keeps the file open in case subsequent entries are required &-- for
36911 example, if a number of different deliveries are being done for the same
36912 message. However, remote SMTP deliveries can take a long time, and this means
36913 that the file may be kept open long after it is renamed if &'exicyclog'& or
36914 something similar is being used to rename log files on a regular basis. To
36915 ensure that a switch of log files is noticed as soon as possible, Exim calls
36916 &[stat()]& on the main log's name before reusing an open file, and if the file
36917 does not exist, or its inode has changed, the old file is closed and Exim
36918 tries to open the main log from scratch. Thus, an old log file may remain open
36919 for quite some time, but no Exim processes should write to it once it has been
36920 renamed.
36921
36922
36923
36924 .section "Datestamped log files" "SECTdatlogfil"
36925 .cindex "log" "datestamped files"
36926 Instead of cycling the main and reject log files by renaming them
36927 periodically, some sites like to use files whose names contain a datestamp,
36928 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36929 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36930 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36931 point where the datestamp is required. For example:
36932 .code
36933 log_file_path = /var/spool/exim/log/%slog-%D
36934 log_file_path = /var/log/exim-%s-%D.log
36935 log_file_path = /var/spool/exim/log/%D-%slog
36936 log_file_path = /var/log/exim/%s.%M
36937 .endd
36938 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36939 examples of names generated by the above examples:
36940 .code
36941 /var/spool/exim/log/mainlog-20021225
36942 /var/log/exim-reject-20021225.log
36943 /var/spool/exim/log/20021225-mainlog
36944 /var/log/exim/main.200212
36945 .endd
36946 When this form of log file is specified, Exim automatically switches to new
36947 files at midnight. It does not make any attempt to compress old logs; you
36948 will need to write your own script if you require this. You should not
36949 run &'exicyclog'& with this form of logging.
36950
36951 The location of the panic log is also determined by &%log_file_path%&, but it
36952 is not datestamped, because rotation of the panic log does not make sense.
36953 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36954 the string. In addition, if it immediately follows a slash, a following
36955 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36956 character is removed. Thus, the four examples above would give these panic
36957 log names:
36958 .code
36959 /var/spool/exim/log/paniclog
36960 /var/log/exim-panic.log
36961 /var/spool/exim/log/paniclog
36962 /var/log/exim/panic
36963 .endd
36964
36965
36966 .section "Logging to syslog" "SECID249"
36967 .cindex "log" "syslog; writing to"
36968 The use of syslog does not change what Exim logs or the format of its messages,
36969 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36970 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36971 that, the same strings are written to syslog as to log files. The syslog
36972 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36973 by default, but you can change these by setting the &%syslog_facility%& and
36974 &%syslog_processname%& options, respectively. If Exim was compiled with
36975 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36976 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36977 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36978 the time and host name to each line.
36979 The three log streams are mapped onto syslog priorities as follows:
36980
36981 .ilist
36982 &'mainlog'& is mapped to LOG_INFO
36983 .next
36984 &'rejectlog'& is mapped to LOG_NOTICE
36985 .next
36986 &'paniclog'& is mapped to LOG_ALERT
36987 .endlist
36988
36989 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36990 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36991 these are routed by syslog to the same place. You can suppress this duplication
36992 by setting &%syslog_duplication%& false.
36993
36994 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36995 entries contain multiple lines when headers are included. To cope with both
36996 these cases, entries written to syslog are split into separate &[syslog()]&
36997 calls at each internal newline, and also after a maximum of
36998 870 data characters. (This allows for a total syslog line length of 1024, when
36999 additions such as timestamps are added.) If you are running a syslog
37000 replacement that can handle lines longer than the 1024 characters allowed by
37001 RFC 3164, you should set
37002 .code
37003 SYSLOG_LONG_LINES=yes
37004 .endd
37005 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37006 lines, but it still splits at internal newlines in &'reject'& log entries.
37007
37008 To make it easy to re-assemble split lines later, each component of a split
37009 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37010 where <&'n'&> is the component number and <&'m'&> is the total number of
37011 components in the entry. The / delimiter is used when the line was split
37012 because it was too long; if it was split because of an internal newline, the \
37013 delimiter is used. For example, supposing the length limit to be 50 instead of
37014 870, the following would be the result of a typical rejection message to
37015 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37016 name, and pid as added by syslog:
37017 .code
37018 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37019 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37020 [3/5]  when scanning for sender: missing or malformed lo
37021 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37022 [5/5] mple>)
37023 .endd
37024 The same error might cause the following lines to be written to &"rejectlog"&
37025 (LOG_NOTICE):
37026 .code
37027 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37028 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37029 [3/18] er when scanning for sender: missing or malformed
37030 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37031 [5\18] .example>)
37032 [6\18] Recipients: ph10@some.domain.cam.example
37033 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37034 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37035 [9\18]        id 16RdAL-0006pc-00
37036 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37037 [11\18] 09:43 +0100
37038 [12\18] F From: <>
37039 [13\18]   Subject: this is a test header
37040 [18\18]   X-something: this is another header
37041 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37042 [16\18] le>
37043 [17\18] B Bcc:
37044 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37045 .endd
37046 Log lines that are neither too long nor contain newlines are written to syslog
37047 without modification.
37048
37049 If only syslog is being used, the Exim monitor is unable to provide a log tail
37050 display, unless syslog is routing &'mainlog'& to a file on the local host and
37051 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37052 where it is.
37053
37054
37055
37056 .section "Log line flags" "SECID250"
37057 One line is written to the main log for each message received, and for each
37058 successful, unsuccessful, and delayed delivery. These lines can readily be
37059 picked out by the distinctive two-character flags that immediately follow the
37060 timestamp. The flags are:
37061 .display
37062 &`<=`&     message arrival
37063 &`(=`&     message fakereject
37064 &`=>`&     normal message delivery
37065 &`->`&     additional address in same delivery
37066 &`>>`&     cutthrough message delivery
37067 &`*>`&     delivery suppressed by &%-N%&
37068 &`**`&     delivery failed; address bounced
37069 &`==`&     delivery deferred; temporary problem
37070 .endd
37071
37072
37073 .section "Logging message reception" "SECID251"
37074 .cindex "log" "reception line"
37075 The format of the single-line entry in the main log that is written for every
37076 message received is shown in the basic example below, which is split over
37077 several lines in order to fit it on the page:
37078 .code
37079 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37080   H=mailer.fict.example [192.168.123.123] U=exim
37081   P=smtp S=5678 id=<incoming message id>
37082 .endd
37083 The address immediately following &"<="& is the envelope sender address. A
37084 bounce message is shown with the sender address &"<>"&, and if it is locally
37085 generated, this is followed by an item of the form
37086 .code
37087 R=<message id>
37088 .endd
37089 which is a reference to the message that caused the bounce to be sent.
37090
37091 .cindex "HELO"
37092 .cindex "EHLO"
37093 For messages from other hosts, the H and U fields identify the remote host and
37094 record the RFC 1413 identity of the user that sent the message, if one was
37095 received. The number given in square brackets is the IP address of the sending
37096 host. If there is a single, unparenthesized  host name in the H field, as
37097 above, it has been verified to correspond to the IP address (see the
37098 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37099 by the remote host in the SMTP HELO or EHLO command, and has not been
37100 verified. If verification yields a different name to that given for HELO or
37101 EHLO, the verified name appears first, followed by the HELO or EHLO
37102 name in parentheses.
37103
37104 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37105 without brackets, in the HELO or EHLO command, leading to entries in
37106 the log containing text like these examples:
37107 .code
37108 H=(10.21.32.43) [192.168.8.34]
37109 H=([10.21.32.43]) [192.168.8.34]
37110 .endd
37111 This can be confusing. Only the final address in square brackets can be relied
37112 on.
37113
37114 For locally generated messages (that is, messages not received over TCP/IP),
37115 the H field is omitted, and the U field contains the login name of the caller
37116 of Exim.
37117
37118 .cindex "authentication" "logging"
37119 .cindex "AUTH" "logging"
37120 For all messages, the P field specifies the protocol used to receive the
37121 message. This is the value that is stored in &$received_protocol$&. In the case
37122 of incoming SMTP messages, the value indicates whether or not any SMTP
37123 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37124 session was encrypted, there is an additional X field that records the cipher
37125 suite that was used.
37126
37127 .cindex log protocol
37128 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37129 hosts that have authenticated themselves using the SMTP AUTH command. The first
37130 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37131 there is an additional item A= followed by the name of the authenticator that
37132 was used. If an authenticated identification was set up by the authenticator's
37133 &%server_set_id%& option, this is logged too, separated by a colon from the
37134 authenticator name.
37135
37136 .cindex "size" "of message"
37137 The id field records the existing message id, if present. The size of the
37138 received message is given by the S field. When the message is delivered,
37139 headers may be removed or added, so that the size of delivered copies of the
37140 message may not correspond with this value (and indeed may be different to each
37141 other).
37142
37143 The &%log_selector%& option can be used to request the logging of additional
37144 data when a message is received. See section &<<SECTlogselector>>& below.
37145
37146
37147
37148 .section "Logging deliveries" "SECID252"
37149 .cindex "log" "delivery line"
37150 The format of the single-line entry in the main log that is written for every
37151 delivery is shown in one of the examples below, for local and remote
37152 deliveries, respectively. Each example has been split into multiple lines in order
37153 to fit it on the page:
37154 .code
37155 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37156   <marv@hitch.fict.example> R=localuser T=local_delivery
37157 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37158   monk@holistic.fict.example R=dnslookup T=remote_smtp
37159   H=holistic.fict.example [192.168.234.234]
37160 .endd
37161 For ordinary local deliveries, the original address is given in angle brackets
37162 after the final delivery address, which might be a pipe or a file. If
37163 intermediate address(es) exist between the original and the final address, the
37164 last of these is given in parentheses after the final address. The R and T
37165 fields record the router and transport that were used to process the address.
37166
37167 If SMTP AUTH was used for the delivery there is an additional item A=
37168 followed by the name of the authenticator that was used.
37169 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37170 option, this is logged too, separated by a colon from the authenticator name.
37171
37172 If a shadow transport was run after a successful local delivery, the log line
37173 for the successful delivery has an item added on the end, of the form
37174 .display
37175 &`ST=<`&&'shadow transport name'&&`>`&
37176 .endd
37177 If the shadow transport did not succeed, the error message is put in
37178 parentheses afterwards.
37179
37180 .cindex "asterisk" "after IP address"
37181 When more than one address is included in a single delivery (for example, two
37182 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37183 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37184 down a single SMTP connection, an asterisk follows the IP address in the log
37185 lines for the second and subsequent messages.
37186 When two or more messages are delivered down a single TLS connection, the
37187 DNS and some TLS-related information logged for the first message delivered
37188 will not be present in the log lines for the second and subsequent messages.
37189 TLS cipher information is still available.
37190
37191 .cindex "delivery" "cutthrough; logging"
37192 .cindex "cutthrough" "logging"
37193 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37194 line precedes the reception line, since cutthrough waits for a possible
37195 rejection from the destination in case it can reject the sourced item.
37196
37197 The generation of a reply message by a filter file gets logged as a
37198 &"delivery"& to the addressee, preceded by &">"&.
37199
37200 The &%log_selector%& option can be used to request the logging of additional
37201 data when a message is delivered. See section &<<SECTlogselector>>& below.
37202
37203
37204 .section "Discarded deliveries" "SECID253"
37205 .cindex "discarded messages"
37206 .cindex "message" "discarded"
37207 .cindex "delivery" "discarded; logging"
37208 When a message is discarded as a result of the command &"seen finish"& being
37209 obeyed in a filter file which generates no deliveries, a log entry of the form
37210 .code
37211 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37212   <low.club@bridge.example> R=userforward
37213 .endd
37214 is written, to record why no deliveries are logged. When a message is discarded
37215 because it is aliased to &":blackhole:"& the log line is like this:
37216 .code
37217 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37218   <hole@nowhere.example> R=blackhole_router
37219 .endd
37220
37221
37222 .section "Deferred deliveries" "SECID254"
37223 When a delivery is deferred, a line of the following form is logged:
37224 .code
37225 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37226   R=dnslookup T=smtp defer (146): Connection refused
37227 .endd
37228 In the case of remote deliveries, the error is the one that was given for the
37229 last IP address that was tried. Details of individual SMTP failures are also
37230 written to the log, so the above line would be preceded by something like
37231 .code
37232 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37233   mail1.endrest.example [192.168.239.239]: Connection refused
37234 .endd
37235 When a deferred address is skipped because its retry time has not been reached,
37236 a message is written to the log, but this can be suppressed by setting an
37237 appropriate value in &%log_selector%&.
37238
37239
37240
37241 .section "Delivery failures" "SECID255"
37242 .cindex "delivery" "failure; logging"
37243 If a delivery fails because an address cannot be routed, a line of the
37244 following form is logged:
37245 .code
37246 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37247   <jim@trek99.example>: unknown mail domain
37248 .endd
37249 If a delivery fails at transport time, the router and transport are shown, and
37250 the response from the remote host is included, as in this example:
37251 .code
37252 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37253   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37254   after pipelined RCPT TO:<ace400@pb.example>: host
37255   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37256   <ace400@pb.example>...Addressee unknown
37257 .endd
37258 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37259 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37260 disabling PIPELINING. The log lines for all forms of delivery failure are
37261 flagged with &`**`&.
37262
37263
37264
37265 .section "Fake deliveries" "SECID256"
37266 .cindex "delivery" "fake; logging"
37267 If a delivery does not actually take place because the &%-N%& option has been
37268 used to suppress it, a normal delivery line is written to the log, except that
37269 &"=>"& is replaced by &"*>"&.
37270
37271
37272
37273 .section "Completion" "SECID257"
37274 A line of the form
37275 .code
37276 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37277 .endd
37278 is written to the main log when a message is about to be removed from the spool
37279 at the end of its processing.
37280
37281
37282
37283
37284 .section "Summary of Fields in Log Lines" "SECID258"
37285 .cindex "log" "summary of fields"
37286 A summary of the field identifiers that are used in log lines is shown in
37287 the following table:
37288 .display
37289 &`A   `&        authenticator name (and optional id and sender)
37290 &`C   `&        SMTP confirmation on delivery
37291 &`    `&        command list for &"no mail in SMTP session"&
37292 &`CV  `&        certificate verification status
37293 &`D   `&        duration of &"no mail in SMTP session"&
37294 &`DKIM`&        domain verified in incoming message
37295 &`DN  `&        distinguished name from peer certificate
37296 &`DS  `&        DNSSEC secured lookups
37297 &`DT  `&        on &`=>`& lines: time taken for a delivery
37298 &`F   `&        sender address (on delivery lines)
37299 &`H   `&        host name and IP address
37300 &`I   `&        local interface used
37301 &`id  `&        message id (from header) for incoming message
37302 &`K   `&        CHUNKING extension used
37303 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37304 &`M8S `&        8BITMIME status for incoming message
37305 &`P   `&        on &`<=`& lines: protocol used
37306 &`    `&        on &`=>`& and &`**`& lines: return path
37307 &`PRDR`&        PRDR extension used
37308 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37309 &`Q   `&        alternate queue name
37310 &`QT  `&        on &`=>`& lines: time spent on queue so far
37311 &`    `&        on &"Completed"& lines: time spent on queue
37312 &`R   `&        on &`<=`& lines: reference for local bounce
37313 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37314 &`RT  `&        on &`<=`& lines: time taken for reception
37315 &`S   `&        size of message in bytes
37316 &`SNI `&        server name indication from TLS client hello
37317 &`ST  `&        shadow transport name
37318 &`T   `&        on &`<=`& lines: message subject (topic)
37319 &`TFO `&        connection took advantage of TCP Fast Open
37320 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37321 &`U   `&        local user or RFC 1413 identity
37322 &`X   `&        TLS cipher suite
37323 .endd
37324
37325
37326 .section "Other log entries" "SECID259"
37327 Various other types of log entry are written from time to time. Most should be
37328 self-explanatory. Among the more common are:
37329
37330 .ilist
37331 .cindex "retry" "time not reached"
37332 &'retry time not reached'&&~&~An address previously suffered a temporary error
37333 during routing or local delivery, and the time to retry has not yet arrived.
37334 This message is not written to an individual message log file unless it happens
37335 during the first delivery attempt.
37336 .next
37337 &'retry time not reached for any host'&&~&~An address previously suffered
37338 temporary errors during remote delivery, and the retry time has not yet arrived
37339 for any of the hosts to which it is routed.
37340 .next
37341 .cindex "spool directory" "file locked"
37342 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37343 some other Exim process is already working on the message. This can be quite
37344 common if queue running processes are started at frequent intervals. The
37345 &'exiwhat'& utility script can be used to find out what Exim processes are
37346 doing.
37347 .next
37348 .cindex "error" "ignored"
37349 &'error ignored'&&~&~There are several circumstances that give rise to this
37350 message:
37351 .olist
37352 Exim failed to deliver a bounce message whose age was greater than
37353 &%ignore_bounce_errors_after%&. The bounce was discarded.
37354 .next
37355 A filter file set up a delivery using the &"noerror"& option, and the delivery
37356 failed. The delivery was discarded.
37357 .next
37358 A delivery set up by a router configured with
37359 . ==== As this is a nested list, any displays it contains must be indented
37360 . ==== as otherwise they are too far to the left.
37361 .code
37362     errors_to = <>
37363 .endd
37364 failed. The delivery was discarded.
37365 .endlist olist
37366 .next
37367 .cindex DKIM "log line"
37368 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37369 logging and the message has a DKIM signature header.
37370 .endlist ilist
37371
37372
37373
37374
37375
37376 .section "Reducing or increasing what is logged" "SECTlogselector"
37377 .cindex "log" "selectors"
37378 By setting the &%log_selector%& global option, you can disable some of Exim's
37379 default logging, or you can request additional logging. The value of
37380 &%log_selector%& is made up of names preceded by plus or minus characters. For
37381 example:
37382 .code
37383 log_selector = +arguments -retry_defer
37384 .endd
37385 The list of optional log items is in the following table, with the default
37386 selection marked by asterisks:
37387 .display
37388 &` 8bitmime                   `&  received 8BITMIME status
37389 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37390 &` address_rewrite            `&  address rewriting
37391 &` all_parents                `&  all parents in => lines
37392 &` arguments                  `&  command line arguments
37393 &`*connection_reject          `&  connection rejections
37394 &`*delay_delivery             `&  immediate delivery delayed
37395 &` deliver_time               `&  time taken to perform delivery
37396 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37397 &`*dkim                       `&  DKIM verified domain on <= lines
37398 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37399 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37400 &` dnssec                     `&  DNSSEC secured lookups
37401 &`*etrn                       `&  ETRN commands
37402 &`*host_lookup_failed         `&  as it says
37403 &` ident_timeout              `&  timeout for ident connection
37404 &` incoming_interface         `&  local interface on <= and => lines
37405 &` incoming_port              `&  remote port on <= lines
37406 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37407 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37408 &`*msg_id                     `&  on <= lines, Message-ID: header value
37409 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37410 &` outgoing_interface         `&  local interface on => lines
37411 &` outgoing_port              `&  add remote port to => lines
37412 &`*queue_run                  `&  start and end queue runs
37413 &` queue_time                 `&  time on queue for one recipient
37414 &` queue_time_overall         `&  time on queue for whole message
37415 &` pid                        `&  Exim process id
37416 &` pipelining                 `&  PIPELINING use, on <= and => lines
37417 &` proxy                      `&  proxy address on <= and => lines
37418 &` receive_time               `&  time taken to receive message
37419 &` received_recipients        `&  recipients on <= lines
37420 &` received_sender            `&  sender on <= lines
37421 &`*rejected_header            `&  header contents on reject log
37422 &`*retry_defer                `&  &"retry time not reached"&
37423 &` return_path_on_delivery    `&  put return path on => and ** lines
37424 &` sender_on_delivery         `&  add sender to => lines
37425 &`*sender_verify_fail         `&  sender verification failures
37426 &`*size_reject                `&  rejection because too big
37427 &`*skip_delivery              `&  delivery skipped in a queue run
37428 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37429 &` smtp_connection            `&  incoming SMTP connections
37430 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37431 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37432 &` smtp_no_mail               `&  session with no MAIL commands
37433 &` smtp_protocol_error        `&  SMTP protocol errors
37434 &` smtp_syntax_error          `&  SMTP syntax errors
37435 &` subject                    `&  contents of &'Subject:'& on <= lines
37436 &`*tls_certificate_verified   `&  certificate verification status
37437 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37438 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37439 &` tls_sni                    `&  TLS SNI on <= lines
37440 &` unknown_in_list            `&  DNS lookup failed in list match
37441
37442 &` all                        `&  all of the above
37443 .endd
37444 See also the &%slow_lookup_log%& main configuration option,
37445 section &<<SECID99>>&
37446
37447 More details on each of these items follows:
37448
37449 .ilist
37450 .cindex "8BITMIME"
37451 .cindex "log" "8BITMIME"
37452 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37453 which may help in tracking down interoperability issues with ancient MTAs
37454 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37455 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37456 &`7BIT`& and &`8BITMIME`& respectively.
37457 .next
37458 .cindex "&%warn%& ACL verb" "log when skipping"
37459 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37460 its conditions cannot be evaluated, a log line to this effect is written if
37461 this log selector is set.
37462 .next
37463 .cindex "log" "rewriting"
37464 .cindex "rewriting" "logging"
37465 &%address_rewrite%&: This applies both to global rewrites and per-transport
37466 rewrites, but not to rewrites in filters run as an unprivileged user (because
37467 such users cannot access the log).
37468 .next
37469 .cindex "log" "full parentage"
37470 &%all_parents%&: Normally only the original and final addresses are logged on
37471 delivery lines; with this selector, intermediate parents are given in
37472 parentheses between them.
37473 .next
37474 .cindex "log" "Exim arguments"
37475 .cindex "Exim arguments, logging"
37476 &%arguments%&: This causes Exim to write the arguments with which it was called
37477 to the main log, preceded by the current working directory. This is a debugging
37478 feature, added to make it easier to find out how certain MUAs call
37479 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37480 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37481 that are empty or that contain white space are quoted. Non-printing characters
37482 are shown as escape sequences. This facility cannot log unrecognized arguments,
37483 because the arguments are checked before the configuration file is read. The
37484 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37485 between the caller and Exim.
37486 .next
37487 .cindex "log" "connection rejections"
37488 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37489 connection is rejected, for whatever reason.
37490 .next
37491 .cindex "log" "delayed delivery"
37492 .cindex "delayed delivery, logging"
37493 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37494 started for an incoming message because the load is too high or too many
37495 messages were received on one connection. Logging does not occur if no delivery
37496 process is started because &%queue_only%& is set or &%-odq%& was used.
37497 .next
37498 .cindex "log" "delivery duration"
37499 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37500 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37501 If millisecond logging is enabled, short times will be shown with greater
37502 precision, eg. &`DT=0.304s`&.
37503 .next
37504 .cindex "log" "message size on delivery"
37505 .cindex "size" "of message"
37506 &%delivery_size%&: For each delivery, the size of message delivered is added to
37507 the &"=>"& line, tagged with S=.
37508 .next
37509 .cindex log "DKIM verification"
37510 .cindex DKIM "verification logging"
37511 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37512 verifies successfully a tag of DKIM is added, with one of the verified domains.
37513 .next
37514 .cindex log "DKIM verification"
37515 .cindex DKIM "verification logging"
37516 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37517 .next
37518 .cindex "log" "dnslist defer"
37519 .cindex "DNS list" "logging defer"
37520 .cindex "black list (DNS)"
37521 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37522 DNS black list suffers a temporary error.
37523 .next
37524 .cindex log dnssec
37525 .cindex dnssec logging
37526 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37527 dns lookups gave secure results a tag of DS is added.
37528 For acceptance this covers the reverse and forward lookups for host name verification.
37529 It does not cover helo-name verification.
37530 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37531 .next
37532 .cindex "log" "ETRN commands"
37533 .cindex "ETRN" "logging"
37534 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37535 is run to determine whether or not it is actually accepted. An invalid ETRN
37536 command, or one received within a message transaction is not logged by this
37537 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37538 .next
37539 .cindex "log" "host lookup failure"
37540 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37541 any addresses, or when a lookup of an IP address fails to find a host name, a
37542 log line is written. This logging does not apply to direct DNS lookups when
37543 routing email addresses, but it does apply to &"byname"& lookups.
37544 .next
37545 .cindex "log" "ident timeout"
37546 .cindex "RFC 1413" "logging timeout"
37547 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37548 client's ident port times out.
37549 .next
37550 .cindex "log" "incoming interface"
37551 .cindex "log" "local interface"
37552 .cindex "log" "local address and port"
37553 .cindex "TCP/IP" "logging local address and port"
37554 .cindex "interface" "logging"
37555 &%incoming_interface%&: The interface on which a message was received is added
37556 to the &"<="& line as an IP address in square brackets, tagged by I= and
37557 followed by a colon and the port number. The local interface and port are also
37558 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37559 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37560 The latter can be disabled by turning off the &%outgoing_interface%& option.
37561 .next
37562 .cindex log "incoming proxy address"
37563 .cindex proxy "logging proxy address"
37564 .cindex "TCP/IP" "logging proxy address"
37565 &%proxy%&: The internal (closest to the system running Exim) IP address
37566 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37567 on a proxied connection
37568 or the &"=>"& line for a message delivered on a proxied connection.
37569 See &<<SECTproxyInbound>>& for more information.
37570 .next
37571 .cindex "log" "incoming remote port"
37572 .cindex "port" "logging remote"
37573 .cindex "TCP/IP" "logging incoming remote port"
37574 .vindex "&$sender_fullhost$&"
37575 .vindex "&$sender_rcvhost$&"
37576 &%incoming_port%&: The remote port number from which a message was received is
37577 added to log entries and &'Received:'& header lines, following the IP address
37578 in square brackets, and separated from it by a colon. This is implemented by
37579 changing the value that is put in the &$sender_fullhost$& and
37580 &$sender_rcvhost$& variables. Recording the remote port number has become more
37581 important with the widening use of NAT (see RFC 2505).
37582 .next
37583 .cindex "log" "dropped connection"
37584 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37585 connection is unexpectedly dropped.
37586 .next
37587 .cindex "log" "millisecond timestamps"
37588 .cindex millisecond logging
37589 .cindex timestamps "millisecond, in logs"
37590 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37591 appended to the seconds value.
37592 .next
37593 .new
37594 .cindex "log" "message id"
37595 &%msg_id%&: The value of the Message-ID: header.
37596 .next
37597 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37598 This will be either because the message is a bounce, or was submitted locally
37599 (submission mode) without one.
37600 The field identifier will have an asterix appended: &"id*="&.
37601 .wen
37602 .next
37603 .cindex "log" "outgoing interface"
37604 .cindex "log" "local interface"
37605 .cindex "log" "local address and port"
37606 .cindex "TCP/IP" "logging local address and port"
37607 .cindex "interface" "logging"
37608 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37609 interface on which a message was sent is added to delivery lines as an I= tag
37610 followed by IP address in square brackets. You can disable this by turning
37611 off the &%outgoing_interface%& option.
37612 .next
37613 .cindex "log" "outgoing remote port"
37614 .cindex "port" "logging outgoing remote"
37615 .cindex "TCP/IP" "logging outgoing remote port"
37616 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37617 containing => tags) following the IP address.
37618 The local port is also added if &%incoming_interface%& and
37619 &%outgoing_interface%& are both enabled.
37620 This option is not included in the default setting, because for most ordinary
37621 configurations, the remote port number is always 25 (the SMTP port), and the
37622 local port is a random ephemeral port.
37623 .next
37624 .cindex "log" "process ids in"
37625 .cindex "pid (process id)" "in log lines"
37626 &%pid%&: The current process id is added to every log line, in square brackets,
37627 immediately after the time and date.
37628 .next
37629 .cindex log pipelining
37630 .cindex pipelining "logging outgoing"
37631 &%pipelining%&: A field is added to delivery and accept
37632 log lines when the ESMTP PIPELINING extension was used.
37633 The field is a single "L".
37634
37635 On accept lines, where PIPELINING was offered but not used by the client,
37636 the field has a minus appended.
37637
37638 .new
37639 .cindex "pipelining" "early connection"
37640 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37641 accept "L" fields have a period appended if the feature was
37642 offered but not used, or an asterisk appended if used.
37643 Delivery "L" fields have an asterisk appended if used.
37644 .wen
37645
37646 .next
37647 .cindex "log" "queue run"
37648 .cindex "queue runner" "logging"
37649 &%queue_run%&: The start and end of every queue run are logged.
37650 .next
37651 .cindex "log" "queue time"
37652 &%queue_time%&: The amount of time the message has been in the queue on the
37653 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37654 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37655 includes reception time as well as the delivery time for the current address.
37656 This means that it may be longer than the difference between the arrival and
37657 delivery log line times, because the arrival log line is not written until the
37658 message has been successfully received.
37659 If millisecond logging is enabled, short times will be shown with greater
37660 precision, eg. &`QT=1.578s`&.
37661 .next
37662 &%queue_time_overall%&: The amount of time the message has been in the queue on
37663 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37664 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37665 message, so it includes reception time as well as the total delivery time.
37666 .next
37667 .cindex "log" "receive duration"
37668 &%receive_time%&: For each message, the amount of real time it has taken to
37669 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37670 If millisecond logging is enabled, short times will be shown with greater
37671 precision, eg. &`RT=0.204s`&.
37672 .next
37673 .cindex "log" "recipients"
37674 &%received_recipients%&: The recipients of a message are listed in the main log
37675 as soon as the message is received. The list appears at the end of the log line
37676 that is written when a message is received, preceded by the word &"for"&. The
37677 addresses are listed after they have been qualified, but before any rewriting
37678 has taken place.
37679 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37680 in the list.
37681 .next
37682 .cindex "log" "sender reception"
37683 &%received_sender%&: The unrewritten original sender of a message is added to
37684 the end of the log line that records the message's arrival, after the word
37685 &"from"& (before the recipients if &%received_recipients%& is also set).
37686 .next
37687 .cindex "log" "header lines for rejection"
37688 &%rejected_header%&: If a message's header has been received at the time a
37689 rejection is written to the reject log, the complete header is added to the
37690 log. Header logging can be turned off individually for messages that are
37691 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37692 .next
37693 .cindex "log" "retry defer"
37694 &%retry_defer%&: A log line is written if a delivery is deferred because a
37695 retry time has not yet been reached. However, this &"retry time not reached"&
37696 message is always omitted from individual message logs after the first delivery
37697 attempt.
37698 .next
37699 .cindex "log" "return path"
37700 &%return_path_on_delivery%&: The return path that is being transmitted with
37701 the message is included in delivery and bounce lines, using the tag P=.
37702 This is omitted if no delivery actually happens, for example, if routing fails,
37703 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37704 .next
37705 .cindex "log" "sender on delivery"
37706 &%sender_on_delivery%&: The message's sender address is added to every delivery
37707 and bounce line, tagged by F= (for &"from"&).
37708 This is the original sender that was received with the message; it is not
37709 necessarily the same as the outgoing return path.
37710 .next
37711 .cindex "log" "sender verify failure"
37712 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37713 gives details of a sender verification failure is not written. Log lines for
37714 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37715 detail is lost.
37716 .next
37717 .cindex "log" "size rejection"
37718 &%size_reject%&: A log line is written whenever a message is rejected because
37719 it is too big.
37720 .next
37721 .cindex "log" "frozen messages; skipped"
37722 .cindex "frozen messages" "logging skipping"
37723 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37724 queue run because it is frozen or because another process is already delivering
37725 it.
37726 .cindex "&""spool file is locked""&"
37727 The message that is written is &"spool file is locked"&.
37728 .next
37729 .cindex "log" "smtp confirmation"
37730 .cindex "SMTP" "logging confirmation"
37731 .cindex "LMTP" "logging confirmation"
37732 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37733 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37734 A number of MTAs (including Exim) return an identifying string in this
37735 response.
37736 .next
37737 .cindex "log" "SMTP connections"
37738 .cindex "SMTP" "logging connections"
37739 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37740 established or closed, unless the connection is from a host that matches
37741 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37742 only when the closure is unexpected.) This applies to connections from local
37743 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37744 dropped in the middle of a message, a log line is always written, whether or
37745 not this selector is set, but otherwise nothing is written at the start and end
37746 of connections unless this selector is enabled.
37747
37748 For TCP/IP connections to an Exim daemon, the current number of connections is
37749 included in the log message for each new connection, but note that the count is
37750 reset if the daemon is restarted.
37751 Also, because connections are closed (and the closure is logged) in
37752 subprocesses, the count may not include connections that have been closed but
37753 whose termination the daemon has not yet noticed. Thus, while it is possible to
37754 match up the opening and closing of connections in the log, the value of the
37755 logged counts may not be entirely accurate.
37756 .next
37757 .cindex "log" "SMTP transaction; incomplete"
37758 .cindex "SMTP" "logging incomplete transactions"
37759 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37760 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37761 and the message sender plus any accepted recipients are included in the log
37762 line. This can provide evidence of dictionary attacks.
37763 .next
37764 .cindex "log" "non-MAIL SMTP sessions"
37765 .cindex "MAIL" "logging session without"
37766 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37767 connection terminates without having issued a MAIL command. This includes both
37768 the case when the connection is dropped, and the case when QUIT is used. It
37769 does not include cases where the connection is rejected right at the start (by
37770 an ACL, or because there are too many connections, or whatever). These cases
37771 already have their own log lines.
37772
37773 The log line that is written contains the identity of the client in the usual
37774 way, followed by D= and a time, which records the duration of the connection.
37775 If the connection was authenticated, this fact is logged exactly as it is for
37776 an incoming message, with an A= item. If the connection was encrypted, CV=,
37777 DN=, and X= items may appear as they do for an incoming message, controlled by
37778 the same logging options.
37779
37780 Finally, if any SMTP commands were issued during the connection, a C= item
37781 is added to the line, listing the commands that were used. For example,
37782 .code
37783 C=EHLO,QUIT
37784 .endd
37785 shows that the client issued QUIT straight after EHLO. If there were fewer
37786 than 20 commands, they are all listed. If there were more than 20 commands,
37787 the last 20 are listed, preceded by &"..."&. However, with the default
37788 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37789 have been aborted before 20 non-mail commands are processed.
37790 .next
37791 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37792 colon-separated, is appended to the A= item for a message arrival or delivery
37793 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37794 was accepted or used.
37795 .next
37796 .cindex "log" "SMTP protocol error"
37797 .cindex "SMTP" "logging protocol error"
37798 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37799 encountered. Exim does not have perfect detection of all protocol errors
37800 because of transmission delays and the use of pipelining. If PIPELINING has
37801 been advertised to a client, an Exim server assumes that the client will use
37802 it, and therefore it does not count &"expected"& errors (for example, RCPT
37803 received after rejecting MAIL) as protocol errors.
37804 .next
37805 .cindex "SMTP" "logging syntax errors"
37806 .cindex "SMTP" "syntax errors; logging"
37807 .cindex "SMTP" "unknown command; logging"
37808 .cindex "log" "unknown SMTP command"
37809 .cindex "log" "SMTP syntax error"
37810 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37811 encountered. An unrecognized command is treated as a syntax error. For an
37812 external connection, the host identity is given; for an internal connection
37813 using &%-bs%& the sender identification (normally the calling user) is given.
37814 .next
37815 .cindex "log" "subject"
37816 .cindex "subject, logging"
37817 &%subject%&: The subject of the message is added to the arrival log line,
37818 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37819 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37820 specifies whether characters with values greater than 127 should be logged
37821 unchanged, or whether they should be rendered as escape sequences.
37822 .next
37823 .cindex "log" "certificate verification"
37824 .cindex log DANE
37825 .cindex DANE logging
37826 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37827 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37828 verified
37829 using a CA trust anchor,
37830 &`CA=dane`& if using a DNS trust anchor,
37831 and &`CV=no`& if not.
37832 .next
37833 .cindex "log" "TLS cipher"
37834 .cindex "TLS" "logging cipher"
37835 &%tls_cipher%&: When a message is sent or received over an encrypted
37836 connection, the cipher suite used is added to the log line, preceded by X=.
37837 .next
37838 .cindex "log" "TLS peer DN"
37839 .cindex "TLS" "logging peer DN"
37840 &%tls_peerdn%&: When a message is sent or received over an encrypted
37841 connection, and a certificate is supplied by the remote host, the peer DN is
37842 added to the log line, preceded by DN=.
37843 .next
37844 .cindex "log" "TLS SNI"
37845 .cindex "TLS" "logging SNI"
37846 &%tls_sni%&: When a message is received over an encrypted connection, and
37847 the remote host provided the Server Name Indication extension, the SNI is
37848 added to the log line, preceded by SNI=.
37849 .next
37850 .cindex "log" "DNS failure in list"
37851 &%unknown_in_list%&: This setting causes a log entry to be written when the
37852 result of a list match is failure because a DNS lookup failed.
37853 .endlist
37854
37855
37856 .section "Message log" "SECID260"
37857 .cindex "message" "log file for"
37858 .cindex "log" "message log; description of"
37859 .cindex "&_msglog_& directory"
37860 .oindex "&%preserve_message_logs%&"
37861 In addition to the general log files, Exim writes a log file for each message
37862 that it handles. The names of these per-message logs are the message ids, and
37863 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37864 message log contains copies of the log lines that apply to the message. This
37865 makes it easier to inspect the status of an individual message without having
37866 to search the main log. A message log is deleted when processing of the message
37867 is complete, unless &%preserve_message_logs%& is set, but this should be used
37868 only with great care because they can fill up your disk very quickly.
37869
37870 On a heavily loaded system, it may be desirable to disable the use of
37871 per-message logs, in order to reduce disk I/O. This can be done by setting the
37872 &%message_logs%& option false.
37873 .ecindex IIDloggen
37874
37875
37876
37877
37878 . ////////////////////////////////////////////////////////////////////////////
37879 . ////////////////////////////////////////////////////////////////////////////
37880
37881 .chapter "Exim utilities" "CHAPutils"
37882 .scindex IIDutils "utilities"
37883 A number of utility scripts and programs are supplied with Exim and are
37884 described in this chapter. There is also the Exim Monitor, which is covered in
37885 the next chapter. The utilities described here are:
37886
37887 .itable none 0 0 3  7* left  15* left  40* left
37888 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37889   "list what Exim processes are doing"
37890 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37891 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37892 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37893 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37894                                                 various criteria"
37895 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37896 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37897   "extract statistics from the log"
37898 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37899   "check address acceptance from given IP"
37900 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37901 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37902 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37903 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37904 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37905 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37906 .endtable
37907
37908 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37909 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37910 &url(https://duncanthrax.net/exilog/) for details.
37911
37912
37913
37914
37915 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37916 .cindex "&'exiwhat'&"
37917 .cindex "process, querying"
37918 .cindex "SIGUSR1"
37919 On operating systems that can restart a system call after receiving a signal
37920 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37921 a line describing what it is doing to the file &_exim-process.info_& in the
37922 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37923 processes it can find, having first emptied the file. It then waits for one
37924 second to allow the Exim processes to react before displaying the results. In
37925 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37926 send the signal to the Exim processes, so it is normally run as root.
37927
37928 &*Warning*&: This is not an efficient process. It is intended for occasional
37929 use by system administrators. It is not sensible, for example, to set up a
37930 script that sends SIGUSR1 signals to Exim processes at short intervals.
37931
37932
37933 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37934 varies in different operating systems. Not only are different options used,
37935 but the format of the output is different. For this reason, there are some
37936 system configuration options that configure exactly how &'exiwhat'& works. If
37937 it doesn't seem to be working for you, check the following compile-time
37938 options:
37939 .display
37940 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37941 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37942 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37943 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37944 .endd
37945 An example of typical output from &'exiwhat'& is
37946 .code
37947 164 daemon: -q1h, listening on port 25
37948 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37949 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37950   [10.19.42.42] (editor@ref.example)
37951 10592 handling incoming call from [192.168.243.242]
37952 10628 accepting a local non-SMTP message
37953 .endd
37954 The first number in the output line is the process number. The third line has
37955 been split here, in order to fit it on the page.
37956
37957
37958
37959 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37960 .cindex "&'exiqgrep'&"
37961 .cindex "queue" "grepping"
37962 This utility is a Perl script contributed by Matt Hubbard. It runs
37963 .code
37964 exim -bpu
37965 .endd
37966 or (in case &*-a*& switch is specified)
37967 .code
37968 exim -bp
37969 .endd
37970 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37971 contain alternate exim configuration the queue management might be using.
37972
37973 to obtain a queue listing, and then greps the output to select messages
37974 that match given criteria. The following selection options are available:
37975
37976 .vlist
37977 .vitem &*-f*&&~<&'regex'&>
37978 Match the sender address using a case-insensitive search. The field that is
37979 tested is enclosed in angle brackets, so you can test for bounce messages with
37980 .code
37981 exiqgrep -f '^<>$'
37982 .endd
37983 .vitem &*-r*&&~<&'regex'&>
37984 Match a recipient address using a case-insensitive search. The field that is
37985 tested is not enclosed in angle brackets.
37986
37987 .vitem &*-s*&&~<&'regex'&>
37988 Match against the size field.
37989
37990 .vitem &*-y*&&~<&'seconds'&>
37991 Match messages that are younger than the given time.
37992
37993 .vitem &*-o*&&~<&'seconds'&>
37994 Match messages that are older than the given time.
37995
37996 .vitem &*-z*&
37997 Match only frozen messages.
37998
37999 .vitem &*-x*&
38000 Match only non-frozen messages.
38001
38002 .new
38003 .vitem &*-G*&&~<&'queuename'&>
38004 Match only messages in the given queue.  Without this, the default queue is searched.
38005 .wen
38006 .endlist
38007
38008 The following options control the format of the output:
38009
38010 .vlist
38011 .vitem &*-c*&
38012 Display only the count of matching messages.
38013
38014 .vitem &*-l*&
38015 Long format &-- display the full message information as output by Exim. This is
38016 the default.
38017
38018 .vitem &*-i*&
38019 Display message ids only.
38020
38021 .vitem &*-b*&
38022 Brief format &-- one line per message.
38023
38024 .vitem &*-R*&
38025 Display messages in reverse order.
38026
38027 .vitem &*-a*&
38028 Include delivered recipients in queue listing.
38029 .endlist
38030
38031 There is one more option, &%-h%&, which outputs a list of options.
38032
38033
38034
38035 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38036 .cindex "&'exiqsumm'&"
38037 .cindex "queue" "summary"
38038 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38039 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38040 running a command such as
38041 .code
38042 exim -bp | exiqsumm
38043 .endd
38044 The output consists of one line for each domain that has messages waiting for
38045 it, as in the following example:
38046 .code
38047 3   2322   74m   66m  msn.com.example
38048 .endd
38049 Each line lists the number of pending deliveries for a domain, their total
38050 volume, and the length of time that the oldest and the newest messages have
38051 been waiting. Note that the number of pending deliveries is greater than the
38052 number of messages when messages have more than one recipient.
38053
38054 A summary line is output at the end. By default the output is sorted on the
38055 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38056 the output to be sorted by oldest message and by count of messages,
38057 respectively. There are also three options that split the messages for each
38058 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38059 separates frozen messages, and &%-s%& separates messages according to their
38060 sender.
38061
38062 The output of &'exim -bp'& contains the original addresses in the message, so
38063 this also applies to the output from &'exiqsumm'&. No domains from addresses
38064 generated by aliasing or forwarding are included (unless the &%one_time%&
38065 option of the &(redirect)& router has been used to convert them into &"top
38066 level"& addresses).
38067
38068
38069
38070
38071 .section "Extracting specific information from the log (exigrep)" &&&
38072          "SECTextspeinf"
38073 .cindex "&'exigrep'&"
38074 .cindex "log" "extracts; grepping for"
38075 The &'exigrep'& utility is a Perl script that searches one or more main log
38076 files for entries that match a given pattern. When it finds a match, it
38077 extracts all the log entries for the relevant message, not just those that
38078 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38079 given message, or all mail for a given user, or for a given host, for example.
38080 The input files can be in Exim log format or syslog format.
38081 If a matching log line is not associated with a specific message, it is
38082 included in &'exigrep'&'s output without any additional lines. The usage is:
38083 .display
38084 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38085 .endd
38086 If no log filenames are given on the command line, the standard input is read.
38087
38088 The &%-t%& argument specifies a number of seconds. It adds an additional
38089 condition for message selection. Messages that are complete are shown only if
38090 they spent more than <&'n'&> seconds in the queue.
38091
38092 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38093 makes it case-sensitive. This may give a performance improvement when searching
38094 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38095 option; with &%-I%& they do not. In both cases it is possible to change the
38096 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38097
38098 The &%-l%& option means &"literal"&, that is, treat all characters in the
38099 pattern as standing for themselves. Otherwise the pattern must be a Perl
38100 regular expression.
38101
38102 The &%-v%& option inverts the matching condition. That is, a line is selected
38103 if it does &'not'& match the pattern.
38104
38105 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38106 that are generated as a result/response to a message that &'exigrep'& matched
38107 normally.
38108
38109 Example of &%-M%&:
38110 user_a sends a message to user_b, which generates a bounce back to user_b. If
38111 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38112 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38113 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38114 when searching for &"user_a"& will show both messages since the bounce is
38115 &"related"& to or a &"result"& of the first message that was found by the
38116 search term.
38117
38118 If the location of a &'zcat'& command is known from the definition of
38119 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38120 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38121 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38122 autodetection of some well known compression extensions.
38123
38124
38125 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38126 .cindex "&'exipick'&"
38127 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38128 lists messages from the queue according to a variety of criteria. For details
38129 of &'exipick'&'s facilities, run &'exipick'& with
38130 the &%--help%& option.
38131
38132
38133 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38134 .cindex "log" "cycling local files"
38135 .cindex "cycling logs"
38136 .cindex "&'exicyclog'&"
38137 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38138 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38139 you are using log files with datestamps in their names (see section
38140 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38141 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38142 There are two command line options for &'exicyclog'&:
38143 .ilist
38144 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38145 default that is set when Exim is built. The default default is 10.
38146 .next
38147 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38148 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38149 overriding the script's default, which is to find the setting from Exim's
38150 configuration.
38151 .endlist
38152
38153 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38154 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38155 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38156 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38157 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38158 logs are handled similarly.
38159
38160 If the limit is greater than 99, the script uses 3-digit numbers such as
38161 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38162 to one that is greater, or &'vice versa'&, you will have to fix the names of
38163 any existing log files.
38164
38165 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38166 the end are deleted. All files with numbers greater than 01 are compressed,
38167 using a compression command which is configured by the COMPRESS_COMMAND
38168 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38169 root &%crontab%& entry of the form
38170 .code
38171 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38172 .endd
38173 assuming you have used the name &"exim"& for the Exim user. You can run
38174 &'exicyclog'& as root if you wish, but there is no need.
38175
38176
38177
38178 .section "Mail statistics (eximstats)" "SECTmailstat"
38179 .cindex "statistics"
38180 .cindex "&'eximstats'&"
38181 A Perl script called &'eximstats'& is provided for extracting statistical
38182 information from log files. The output is either plain text, or HTML.
38183 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38184 . --- 404 error and everything else points to that.
38185
38186 The &'eximstats'& script has been hacked about quite a bit over time. The
38187 latest version is the result of some extensive revision by Steve Campbell. A
38188 lot of information is given by default, but there are options for suppressing
38189 various parts of it. Following any options, the arguments to the script are a
38190 list of files, which should be main log files. For example:
38191 .code
38192 eximstats -nr /var/spool/exim/log/mainlog.01
38193 .endd
38194 By default, &'eximstats'& extracts information about the number and volume of
38195 messages received from or delivered to various hosts. The information is sorted
38196 both by message count and by volume, and the top fifty hosts in each category
38197 are listed on the standard output. Similar information, based on email
38198 addresses or domains instead of hosts can be requested by means of various
38199 options. For messages delivered and received locally, similar statistics are
38200 also produced per user.
38201
38202 The output also includes total counts and statistics about delivery errors, and
38203 histograms showing the number of messages received and deliveries made in each
38204 hour of the day. A delivery with more than one address in its envelope (for
38205 example, an SMTP transaction with more than one RCPT command) is counted
38206 as a single delivery by &'eximstats'&.
38207
38208 Though normally more deliveries than receipts are reported (as messages may
38209 have multiple recipients), it is possible for &'eximstats'& to report more
38210 messages received than delivered, even though the queue is empty at the start
38211 and end of the period in question. If an incoming message contains no valid
38212 recipients, no deliveries are recorded for it. A bounce message is handled as
38213 an entirely separate message.
38214
38215 &'eximstats'& always outputs a grand total summary giving the volume and number
38216 of messages received and deliveries made, and the number of hosts involved in
38217 each case. It also outputs the number of messages that were delayed (that is,
38218 not completely delivered at the first attempt), and the number that had at
38219 least one address that failed.
38220
38221 The remainder of the output is in sections that can be independently disabled
38222 or modified by various options. It consists of a summary of deliveries by
38223 transport, histograms of messages received and delivered per time interval
38224 (default per hour), information about the time messages spent in the queue,
38225 a list of relayed messages, lists of the top fifty sending hosts, local
38226 senders, destination hosts, and destination local users by count and by volume,
38227 and a list of delivery errors that occurred.
38228
38229 The relay information lists messages that were actually relayed, that is, they
38230 came from a remote host and were directly delivered to some other remote host,
38231 without being processed (for example, for aliasing or forwarding) locally.
38232
38233 There are quite a few options for &'eximstats'& to control exactly what it
38234 outputs. These are documented in the Perl script itself, and can be extracted
38235 by running the command &(perldoc)& on the script. For example:
38236 .code
38237 perldoc /usr/exim/bin/eximstats
38238 .endd
38239
38240 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38241 .cindex "&'exim_checkaccess'&"
38242 .cindex "policy control" "checking access"
38243 .cindex "checking access"
38244 The &%-bh%& command line argument allows you to run a fake SMTP session with
38245 debugging output, in order to check what Exim is doing when it is applying
38246 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38247 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38248 sometimes you just want to answer the question &"Does this address have
38249 access?"& without bothering with any further details.
38250
38251 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38252 two arguments, an IP address and an email address:
38253 .code
38254 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38255 .endd
38256 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38257 given email address would be accepted in a RCPT command in a TCP/IP
38258 connection from the host with the given IP address. The output of the utility
38259 is either the word &"accepted"&, or the SMTP error response, for example:
38260 .code
38261 Rejected:
38262 550 Relay not permitted
38263 .endd
38264 When running this test, the utility uses &`<>`& as the envelope sender address
38265 for the MAIL command, but you can change this by providing additional
38266 options. These are passed directly to the Exim command. For example, to specify
38267 that the test is to be run with the sender address &'himself@there.example'&
38268 you can use:
38269 .code
38270 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38271                  -f himself@there.example
38272 .endd
38273 Note that these additional Exim command line items must be given after the two
38274 mandatory arguments.
38275
38276 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38277 while running its checks. You can run checks that include callouts by using
38278 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38279
38280
38281
38282 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38283 .cindex "DBM" "building dbm files"
38284 .cindex "building DBM files"
38285 .cindex "&'exim_dbmbuild'&"
38286 .cindex "lower casing"
38287 .cindex "binary zero" "in lookup key"
38288 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38289 the format used by the &(lsearch)& lookup (see section
38290 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38291 names as keys and the remainder of the information as data. The lower-casing
38292 can be prevented by calling the program with the &%-nolc%& option.
38293
38294 A terminating zero is included as part of the key string. This is expected by
38295 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38296 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38297 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38298 files.
38299
38300 The program requires two arguments: the name of the input file (which can be a
38301 single hyphen to indicate the standard input), and the name of the output file.
38302 It creates the output under a temporary name, and then renames it if all went
38303 well.
38304
38305 .cindex "USE_DB"
38306 If the native DB interface is in use (USE_DB is set in a compile-time
38307 configuration file &-- this is common in free versions of Unix) the two
38308 filenames must be different, because in this mode the Berkeley DB functions
38309 create a single output file using exactly the name given. For example,
38310 .code
38311 exim_dbmbuild /etc/aliases /etc/aliases.db
38312 .endd
38313 reads the system alias file and creates a DBM version of it in
38314 &_/etc/aliases.db_&.
38315
38316 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38317 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38318 environment, the suffixes are added to the second argument of
38319 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38320 when the Berkeley functions are used in compatibility mode (though this is not
38321 recommended), because in that case it adds a &_.db_& suffix to the filename.
38322
38323 If a duplicate key is encountered, the program outputs a warning, and when it
38324 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38325 option is used. By default, only the first of a set of duplicates is used &--
38326 this makes it compatible with &(lsearch)& lookups. There is an option
38327 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38328 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38329 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38330 return code is 2.
38331
38332
38333
38334
38335 .section "Finding individual retry times (exinext)" "SECTfinindret"
38336 .cindex "retry" "times"
38337 .cindex "&'exinext'&"
38338 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38339 fish specific information out of the retry database. Given a mail domain (or a
38340 complete address), it looks up the hosts for that domain, and outputs any retry
38341 information for the hosts or for the domain. At present, the retry information
38342 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38343 output. For example:
38344 .code
38345 $ exinext piglet@milne.fict.example
38346 kanga.milne.example:192.168.8.1 error 146: Connection refused
38347   first failed: 21-Feb-1996 14:57:34
38348   last tried:   21-Feb-1996 14:57:34
38349   next try at:  21-Feb-1996 15:02:34
38350 roo.milne.example:192.168.8.3 error 146: Connection refused
38351   first failed: 20-Jan-1996 13:12:08
38352   last tried:   21-Feb-1996 11:42:03
38353   next try at:  21-Feb-1996 19:42:03
38354   past final cutoff time
38355 .endd
38356 You can also give &'exinext'& a local part, without a domain, and it
38357 will give any retry information for that local part in your default domain.
38358 A message id can be used to obtain retry information pertaining to a specific
38359 message. This exists only when an attempt to deliver a message to a remote host
38360 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38361 &'exinext'& is not particularly efficient, but then it is not expected to be
38362 run very often.
38363
38364 The &'exinext'& utility calls Exim to find out information such as the location
38365 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38366 passed on to the &'exim'& commands. The first specifies an alternate Exim
38367 configuration file, and the second sets macros for use within the configuration
38368 file. These features are mainly to help in testing, but might also be useful in
38369 environments where more than one configuration file is in use.
38370
38371
38372
38373 .section "Hints database maintenance" "SECThindatmai"
38374 .cindex "hints database" "maintenance"
38375 .cindex "maintaining Exim's hints database"
38376 Three utility programs are provided for maintaining the DBM files that Exim
38377 uses to contain its delivery hint information. Each program requires two
38378 arguments. The first specifies the name of Exim's spool directory, and the
38379 second is the name of the database it is to operate on. These are as follows:
38380
38381 .ilist
38382 &'retry'&: the database of retry information
38383 .next
38384 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38385 for remote hosts
38386 .next
38387 &'callout'&: the callout cache
38388 .next
38389 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38390 .next
38391 &'misc'&: other hints data
38392 .endlist
38393
38394 The &'misc'& database is used for
38395
38396 .ilist
38397 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38398 .next
38399 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38400 &(smtp)& transport)
38401 .next
38402 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38403 in a transport)
38404 .endlist
38405
38406
38407
38408 .section "exim_dumpdb" "SECID261"
38409 .cindex "&'exim_dumpdb'&"
38410 The entire contents of a database are written to the standard output by the
38411 &'exim_dumpdb'& program, which has no options or arguments other than the
38412 spool and database names. For example, to dump the retry database:
38413 .code
38414 exim_dumpdb /var/spool/exim retry
38415 .endd
38416 Two lines of output are produced for each entry:
38417 .code
38418 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38419 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38420 .endd
38421 The first item on the first line is the key of the record. It starts with one
38422 of the letters R, or T, depending on whether it refers to a routing or
38423 transport retry. For a local delivery, the next part is the local address; for
38424 a remote delivery it is the name of the remote host, followed by its failing IP
38425 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38426 transport). If the remote port is not the standard one (port 25), it is added
38427 to the IP address. Then there follows an error code, an additional error code,
38428 and a textual description of the error.
38429
38430 The three times on the second line are the time of first failure, the time of
38431 the last delivery attempt, and the computed time for the next attempt. The line
38432 ends with an asterisk if the cutoff time for the last retry rule has been
38433 exceeded.
38434
38435 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38436 consists of a host name followed by a list of ids for messages that are or were
38437 waiting to be delivered to that host. If there are a very large number for any
38438 one host, continuation records, with a sequence number added to the host name,
38439 may be seen. The data in these records is often out of date, because a message
38440 may be routed to several alternative hosts, and Exim makes no effort to keep
38441 cross-references.
38442
38443
38444
38445 .section "exim_tidydb" "SECID262"
38446 .cindex "&'exim_tidydb'&"
38447 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38448 database. If run with no options, it removes all records that are more than 30
38449 days old. The age is calculated from the date and time that the record was last
38450 updated. Note that, in the case of the retry database, it is &'not'& the time
38451 since the first delivery failure. Information about a host that has been down
38452 for more than 30 days will remain in the database, provided that the record is
38453 updated sufficiently often.
38454
38455 The cutoff date can be altered by means of the &%-t%& option, which must be
38456 followed by a time. For example, to remove all records older than a week from
38457 the retry database:
38458 .code
38459 exim_tidydb -t 7d /var/spool/exim retry
38460 .endd
38461 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38462 message ids. In the former these appear as data in records keyed by host &--
38463 they were messages that were waiting for that host &-- and in the latter they
38464 are the keys for retry information for messages that have suffered certain
38465 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38466 message ids in database records are those of messages that are still on the
38467 queue. Message ids for messages that no longer exist are removed from
38468 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38469 For the &'retry'& database, records whose keys are non-existent message ids are
38470 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38471 whenever it removes information from the database.
38472
38473 Certain records are automatically removed by Exim when they are no longer
38474 needed, but others are not. For example, if all the MX hosts for a domain are
38475 down, a retry record is created for each one. If the primary MX host comes back
38476 first, its record is removed when Exim successfully delivers to it, but the
38477 records for the others remain because Exim has not tried to use those hosts.
38478
38479 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38480 hints databases. You should do this at a quiet time of day, because it requires
38481 a database to be locked (and therefore inaccessible to Exim) while it does its
38482 work. Removing records from a DBM file does not normally make the file smaller,
38483 but all the common DBM libraries are able to re-use the space that is released.
38484 After an initial phase of increasing in size, the databases normally reach a
38485 point at which they no longer get any bigger, as long as they are regularly
38486 tidied.
38487
38488 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38489 databases is likely to keep on increasing.
38490
38491
38492
38493
38494 .section "exim_fixdb" "SECID263"
38495 .cindex "&'exim_fixdb'&"
38496 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38497 Its main use is for testing Exim, but it might also be occasionally useful for
38498 getting round problems in a live system. It has no options, and its interface
38499 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38500 key of a database record can then be entered, and the data for that record is
38501 displayed.
38502
38503 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38504 except the &'retry'& database, that is the only operation that can be carried
38505 out. For the &'retry'& database, each field is output preceded by a number, and
38506 data for individual fields can be changed by typing the field number followed
38507 by new data, for example:
38508 .code
38509 > 4 951102:1000
38510 .endd
38511 resets the time of the next delivery attempt. Time values are given as a
38512 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38513 used as optional separators.
38514
38515
38516
38517
38518 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38519 .cindex "mailbox" "maintenance"
38520 .cindex "&'exim_lock'&"
38521 .cindex "locking mailboxes"
38522 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38523 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38524 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38525 a user agent while investigating a problem. The utility requires the name of
38526 the file as its first argument. If the locking is successful, the second
38527 argument is run as a command (using C's &[system()]& function); if there is no
38528 second argument, the value of the SHELL environment variable is used; if this
38529 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38530 is unlocked and the utility ends. The following options are available:
38531
38532 .vlist
38533 .vitem &%-fcntl%&
38534 Use &[fcntl()]& locking on the open mailbox.
38535
38536 .vitem &%-flock%&
38537 Use &[flock()]& locking on the open mailbox, provided the operating system
38538 supports it.
38539
38540 .vitem &%-interval%&
38541 This must be followed by a number, which is a number of seconds; it sets the
38542 interval to sleep between retries (default 3).
38543
38544 .vitem &%-lockfile%&
38545 Create a lock file before opening the mailbox.
38546
38547 .vitem &%-mbx%&
38548 Lock the mailbox using MBX rules.
38549
38550 .vitem &%-q%&
38551 Suppress verification output.
38552
38553 .vitem &%-retries%&
38554 This must be followed by a number; it sets the number of times to try to get
38555 the lock (default 10).
38556
38557 .vitem &%-restore_time%&
38558 This option causes &%exim_lock%& to restore the modified and read times to the
38559 locked file before exiting. This allows you to access a locked mailbox (for
38560 example, to take a backup copy) without disturbing the times that the user
38561 subsequently sees.
38562
38563 .vitem &%-timeout%&
38564 This must be followed by a number, which is a number of seconds; it sets a
38565 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38566 default), a non-blocking call is used.
38567
38568 .vitem &%-v%&
38569 Generate verbose output.
38570 .endlist
38571
38572 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38573 default is to create a lock file and also to use &[fcntl()]& locking on the
38574 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38575 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38576 requires that the directory containing the file be writeable. Locking by lock
38577 file does not last forever; Exim assumes that a lock file is expired if it is
38578 more than 30 minutes old.
38579
38580 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38581 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38582 to be taken out on the open mailbox, and an exclusive lock on the file
38583 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38584 number of the mailbox file. When the locking is released, if an exclusive lock
38585 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38586
38587 The default output contains verification of the locking that takes place. The
38588 &%-v%& option causes some additional information to be given. The &%-q%& option
38589 suppresses all output except error messages.
38590
38591 A command such as
38592 .code
38593 exim_lock /var/spool/mail/spqr
38594 .endd
38595 runs an interactive shell while the file is locked, whereas
38596 .display
38597 &`exim_lock -q /var/spool/mail/spqr <<End`&
38598 <&'some commands'&>
38599 &`End`&
38600 .endd
38601 runs a specific non-interactive sequence of commands while the file is locked,
38602 suppressing all verification output. A single command can be run by a command
38603 such as
38604 .code
38605 exim_lock -q /var/spool/mail/spqr \
38606   "cp /var/spool/mail/spqr /some/where"
38607 .endd
38608 Note that if a command is supplied, it must be entirely contained within the
38609 second argument &-- hence the quotes.
38610 .ecindex IIDutils
38611
38612
38613 . ////////////////////////////////////////////////////////////////////////////
38614 . ////////////////////////////////////////////////////////////////////////////
38615
38616 .chapter "The Exim monitor" "CHAPeximon"
38617 .scindex IIDeximon "Exim monitor" "description"
38618 .cindex "X-windows"
38619 .cindex "&'eximon'&"
38620 .cindex "Local/eximon.conf"
38621 .cindex "&_exim_monitor/EDITME_&"
38622 The Exim monitor is an application which displays in an X window information
38623 about the state of Exim's queue and what Exim is doing. An admin user can
38624 perform certain operations on messages from this GUI interface; however all
38625 such facilities are also available from the command line, and indeed, the
38626 monitor itself makes use of the command line to perform any actions requested.
38627
38628
38629
38630 .section "Running the monitor" "SECID264"
38631 The monitor is started by running the script called &'eximon'&. This is a shell
38632 script that sets up a number of environment variables, and then runs the
38633 binary called &_eximon.bin_&. The default appearance of the monitor window can
38634 be changed by editing the &_Local/eximon.conf_& file created by editing
38635 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38636 parameters are for.
38637
38638 The parameters that get built into the &'eximon'& script can be overridden for
38639 a particular invocation by setting up environment variables of the same names,
38640 preceded by &`EXIMON_`&. For example, a shell command such as
38641 .code
38642 EXIMON_LOG_DEPTH=400 eximon
38643 .endd
38644 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38645 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38646 overrides the Exim log file configuration. This makes it possible to have
38647 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38648 syslog messages are routed to a file on the local host.
38649
38650 X resources can be used to change the appearance of the window in the normal
38651 way. For example, a resource setting of the form
38652 .code
38653 Eximon*background: gray94
38654 .endd
38655 changes the colour of the background to light grey rather than white. The
38656 stripcharts are drawn with both the data lines and the reference lines in
38657 black. This means that the reference lines are not visible when on top of the
38658 data. However, their colour can be changed by setting a resource called
38659 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38660 For example, if your X server is running Unix, you could set up lighter
38661 reference lines in the stripcharts by obeying
38662 .code
38663 xrdb -merge <<End
38664 Eximon*highlight: gray
38665 End
38666 .endd
38667 .cindex "admin user"
38668 In order to see the contents of messages in the queue, and to operate on them,
38669 &'eximon'& must either be run as root or by an admin user.
38670
38671 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38672 contain X11 resource parameters interpreted by the X11 library.  In addition,
38673 if the first parameter starts with the string "gdb" then it is removed and the
38674 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38675 versioned variants of gdb can be invoked).
38676
38677 The monitor's window is divided into three parts. The first contains one or
38678 more stripcharts and two action buttons, the second contains a &"tail"& of the
38679 main log file, and the third is a display of the queue of messages awaiting
38680 delivery, with two more action buttons. The following sections describe these
38681 different parts of the display.
38682
38683
38684
38685
38686 .section "The stripcharts" "SECID265"
38687 .cindex "stripchart"
38688 The first stripchart is always a count of messages in the queue. Its name can
38689 be configured by setting QUEUE_STRIPCHART_NAME in the
38690 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38691 configuration script by regular expression matches on log file entries, making
38692 it possible to display, for example, counts of messages delivered to certain
38693 hosts or using certain transports. The supplied defaults display counts of
38694 received and delivered messages, and of local and SMTP deliveries. The default
38695 period between stripchart updates is one minute; this can be adjusted by a
38696 parameter in the &_Local/eximon.conf_& file.
38697
38698 The stripchart displays rescale themselves automatically as the value they are
38699 displaying changes. There are always 10 horizontal lines in each chart; the
38700 title string indicates the value of each division when it is greater than one.
38701 For example, &"x2"& means that each division represents a value of 2.
38702
38703 It is also possible to have a stripchart which shows the percentage fullness of
38704 a particular disk partition, which is useful when local deliveries are confined
38705 to a single partition.
38706
38707 .cindex "&%statvfs%& function"
38708 This relies on the availability of the &[statvfs()]& function or equivalent in
38709 the operating system. Most, but not all versions of Unix that support Exim have
38710 this. For this particular stripchart, the top of the chart always represents
38711 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38712 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38713 &_Local/eximon.conf_& file.
38714
38715
38716
38717
38718 .section "Main action buttons" "SECID266"
38719 .cindex "size" "of monitor window"
38720 .cindex "Exim monitor" "window size"
38721 .cindex "window size"
38722 Below the stripcharts there is an action button for quitting the monitor. Next
38723 to this is another button marked &"Size"&. They are placed here so that
38724 shrinking the window to its default minimum size leaves just the queue count
38725 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38726 the window to expand to its maximum size, unless it is already at the maximum,
38727 in which case it is reduced to its minimum.
38728
38729 When expanding to the maximum, if the window cannot be fully seen where it
38730 currently is, it is moved back to where it was the last time it was at full
38731 size. When it is expanding from its minimum size, the old position is
38732 remembered, and next time it is reduced to the minimum it is moved back there.
38733
38734 The idea is that you can keep a reduced window just showing one or two
38735 stripcharts at a convenient place on your screen, easily expand it to show
38736 the full window when required, and just as easily put it back to what it was.
38737 The idea is copied from what the &'twm'& window manager does for its
38738 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38739 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38740
38741 Normally, the monitor starts up with the window at its full size, but it can be
38742 built so that it starts up with the window at its smallest size, by setting
38743 START_SMALL=yes in &_Local/eximon.conf_&.
38744
38745
38746
38747 .section "The log display" "SECID267"
38748 .cindex "log" "tail of; in monitor"
38749 The second section of the window is an area in which a display of the tail of
38750 the main log is maintained.
38751 To save space on the screen, the timestamp on each log line is shortened by
38752 removing the date and, if &%log_timezone%& is set, the timezone.
38753 The log tail is not available when the only destination for logging data is
38754 syslog, unless the syslog lines are routed to a local file whose name is passed
38755 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38756
38757 The log sub-window has a scroll bar at its lefthand side which can be used to
38758 move back to look at earlier text, and the up and down arrow keys also have a
38759 scrolling effect. The amount of log that is kept depends on the setting of
38760 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38761 to use. When this is full, the earlier 50% of data is discarded &-- this is
38762 much more efficient than throwing it away line by line. The sub-window also has
38763 a horizontal scroll bar for accessing the ends of long log lines. This is the
38764 only means of horizontal scrolling; the right and left arrow keys are not
38765 available. Text can be cut from this part of the window using the mouse in the
38766 normal way. The size of this subwindow is controlled by parameters in the
38767 configuration file &_Local/eximon.conf_&.
38768
38769 Searches of the text in the log window can be carried out by means of the ^R
38770 and ^S keystrokes, which default to a reverse and a forward search,
38771 respectively. The search covers only the text that is displayed in the window.
38772 It cannot go further back up the log.
38773
38774 The point from which the search starts is indicated by a caret marker. This is
38775 normally at the end of the text in the window, but can be positioned explicitly
38776 by pointing and clicking with the left mouse button, and is moved automatically
38777 by a successful search. If new text arrives in the window when it is scrolled
38778 back, the caret remains where it is, but if the window is not scrolled back,
38779 the caret is moved to the end of the new text.
38780
38781 Pressing ^R or ^S pops up a window into which the search text can be typed.
38782 There are buttons for selecting forward or reverse searching, for carrying out
38783 the search, and for cancelling. If the &"Search"& button is pressed, the search
38784 happens and the window remains so that further searches can be done. If the
38785 &"Return"& key is pressed, a single search is done and the window is closed. If
38786 ^C is typed the search is cancelled.
38787
38788 The searching facility is implemented using the facilities of the Athena text
38789 widget. By default this pops up a window containing both &"search"& and
38790 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38791 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38792 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38793 provided version of &%TextPop%& when the remaining parts of the text widget
38794 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38795 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38796 on these systems, at the expense of having unwanted items in the search popup
38797 window.
38798
38799
38800
38801 .section "The queue display" "SECID268"
38802 .cindex "queue" "display in monitor"
38803 The bottom section of the monitor window contains a list of all messages that
38804 are in the queue, which includes those currently being received or delivered,
38805 as well as those awaiting delivery. The size of this subwindow is controlled by
38806 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38807 at which it is updated is controlled by another parameter in the same file &--
38808 the default is 5 minutes, since queue scans can be quite expensive. However,
38809 there is an &"Update"& action button just above the display which can be used
38810 to force an update of the queue display at any time.
38811
38812 When a host is down for some time, a lot of pending mail can build up for it,
38813 and this can make it hard to deal with other messages in the queue. To help
38814 with this situation there is a button next to &"Update"& called &"Hide"&. If
38815 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38816 type anything in here and press &"Return"&, the text is added to a chain of
38817 such texts, and if every undelivered address in a message matches at least one
38818 of the texts, the message is not displayed.
38819
38820 If there is an address that does not match any of the texts, all the addresses
38821 are displayed as normal. The matching happens on the ends of addresses so, for
38822 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38823 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38824 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38825 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38826 a hide request is automatically cancelled after one hour.
38827
38828 While the dialogue box is displayed, you can't press any buttons or do anything
38829 else to the monitor window. For this reason, if you want to cut text from the
38830 queue display to use in the dialogue box, you have to do the cutting before
38831 pressing the &"Hide"& button.
38832
38833 The queue display contains, for each unhidden queued message, the length of
38834 time it has been in the queue, the size of the message, the message id, the
38835 message sender, and the first undelivered recipient, all on one line. If it is
38836 a bounce message, the sender is shown as &"<>"&. If there is more than one
38837 recipient to which the message has not yet been delivered, subsequent ones are
38838 listed on additional lines, up to a maximum configured number, following which
38839 an ellipsis is displayed. Recipients that have already received the message are
38840 not shown.
38841
38842 .cindex "frozen messages" "display"
38843 If a message is frozen, an asterisk is displayed at the left-hand side.
38844
38845 The queue display has a vertical scroll bar, and can also be scrolled by means
38846 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38847 The text searching facilities, as described above for the log window, are also
38848 available, but the caret is always moved to the end of the text when the queue
38849 display is updated.
38850
38851
38852
38853 .section "The queue menu" "SECID269"
38854 .cindex "queue" "menu in monitor"
38855 If the &%shift%& key is held down and the left button is clicked when the mouse
38856 pointer is over the text for any message, an action menu pops up, and the first
38857 line of the queue display for the message is highlighted. This does not affect
38858 any selected text.
38859
38860 If you want to use some other event for popping up the menu, you can set the
38861 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38862 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38863 value set in this parameter is a standard X event description. For example, to
38864 run eximon using &%ctrl%& rather than &%shift%& you could use
38865 .code
38866 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38867 .endd
38868 The title of the menu is the message id, and it contains entries which act as
38869 follows:
38870
38871 .ilist
38872 &'message log'&: The contents of the message log for the message are displayed
38873 in a new text window.
38874 .next
38875 &'headers'&: Information from the spool file that contains the envelope
38876 information and headers is displayed in a new text window. See chapter
38877 &<<CHAPspool>>& for a description of the format of spool files.
38878 .next
38879 &'body'&: The contents of the spool file containing the body of the message are
38880 displayed in a new text window. There is a default limit of 20,000 bytes to the
38881 amount of data displayed. This can be changed by setting the BODY_MAX
38882 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38883 .next
38884 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38885 delivery of the message. This causes an automatic thaw if the message is
38886 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38887 a new text window. The delivery is run in a separate process, to avoid holding
38888 up the monitor while the delivery proceeds.
38889 .next
38890 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38891 that the message be frozen.
38892 .next
38893 .cindex "thawing messages"
38894 .cindex "unfreezing messages"
38895 .cindex "frozen messages" "thawing"
38896 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38897 that the message be thawed.
38898 .next
38899 .cindex "delivery" "forcing failure"
38900 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38901 that Exim gives up trying to deliver the message. A bounce message is generated
38902 for any remaining undelivered addresses.
38903 .next
38904 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38905 that the message be deleted from the system without generating a bounce
38906 message.
38907 .next
38908 &'add recipient'&: A dialog box is displayed into which a recipient address can
38909 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38910 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38911 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38912 causes a call to Exim to be made using the &%-Mar%& option to request that an
38913 additional recipient be added to the message, unless the entry box is empty, in
38914 which case no action is taken.
38915 .next
38916 &'mark delivered'&: A dialog box is displayed into which a recipient address
38917 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38918 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38919 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38920 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38921 recipient address as already delivered, unless the entry box is empty, in which
38922 case no action is taken.
38923 .next
38924 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38925 mark all recipient addresses as already delivered.
38926 .next
38927 &'edit sender'&: A dialog box is displayed initialized with the current
38928 sender's address. Pressing RETURN causes a call to Exim to be made using the
38929 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38930 in which case no action is taken. If you want to set an empty sender (as in
38931 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38932 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38933 the address is qualified with that domain.
38934 .endlist
38935
38936 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38937 other cases when a call to Exim is made, if there is any output from Exim (in
38938 particular, if the command fails) a window containing the command and the
38939 output is displayed. Otherwise, the results of the action are normally apparent
38940 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38941 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38942 if no output is generated.
38943
38944 The queue display is automatically updated for actions such as freezing and
38945 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38946 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38947 force an update of the display after one of these actions.
38948
38949 In any text window that is displayed as result of a menu action, the normal
38950 cut-and-paste facility is available, and searching can be carried out using ^R
38951 and ^S, as described above for the log tail window.
38952 .ecindex IIDeximon
38953
38954
38955
38956
38957
38958 . ////////////////////////////////////////////////////////////////////////////
38959 . ////////////////////////////////////////////////////////////////////////////
38960
38961 .chapter "Security considerations" "CHAPsecurity"
38962 .scindex IIDsecurcon "security" "discussion of"
38963 This chapter discusses a number of issues concerned with security, some of
38964 which are also covered in other parts of this manual.
38965
38966 For reasons that this author does not understand, some people have promoted
38967 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38968 existence of this chapter in the documentation. However, the intent of the
38969 chapter is simply to describe the way Exim works in relation to certain
38970 security concerns, not to make any specific claims about the effectiveness of
38971 its security as compared with other MTAs.
38972
38973 What follows is a description of the way Exim is supposed to be. Best efforts
38974 have been made to try to ensure that the code agrees with the theory, but an
38975 absence of bugs can never be guaranteed. Any that are reported will get fixed
38976 as soon as possible.
38977
38978
38979 .section "Building a more &""hardened""& Exim" "SECID286"
38980 .cindex "security" "build-time features"
38981 There are a number of build-time options that can be set in &_Local/Makefile_&
38982 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38983 Exim administrator who does not have the root password, or by someone who has
38984 penetrated the Exim (but not the root) account. These options are as follows:
38985
38986 .ilist
38987 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38988 start of any filenames used with the &%-C%& option. When it is set, these
38989 filenames are also not allowed to contain the sequence &"/../"&. (However, if
38990 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38991 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38992 default setting for &%ALT_CONFIG_PREFIX%&.
38993
38994 If the permitted configuration files are confined to a directory to
38995 which only root has access, this guards against someone who has broken
38996 into the Exim account from running a privileged Exim with an arbitrary
38997 configuration file, and using it to break into other accounts.
38998 .next
38999
39000 If a non-trusted configuration file (i.e. not the default configuration file
39001 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39002 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39003 the next item), then root privilege is retained only if the caller of Exim is
39004 root. This locks out the possibility of testing a configuration using &%-C%&
39005 right through message reception and delivery, even if the caller is root. The
39006 reception works, but by that time, Exim is running as the Exim user, so when
39007 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39008 privilege to be lost. However, root can test reception and delivery using two
39009 separate commands.
39010
39011 .next
39012 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39013 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39014 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39015 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39016 the restrictive side.  Requiring build-time selection of safe macros is onerous
39017 but this option is intended solely as a transition mechanism to permit
39018 previously-working configurations to continue to work after release 4.73.
39019 .next
39020 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39021 is disabled.
39022 .next
39023 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39024 never to be used for any deliveries. This is like the &%never_users%& runtime
39025 option, but it cannot be overridden; the runtime option adds additional users
39026 to the list. The default setting is &"root"&; this prevents a non-root user who
39027 is permitted to modify the runtime file from using Exim as a way to get root.
39028 .endlist
39029
39030
39031
39032 .section "Root privilege" "SECID270"
39033 .cindex "setuid"
39034 .cindex "root privilege"
39035 The Exim binary is normally setuid to root, which means that it gains root
39036 privilege (runs as root) when it starts execution. In some special cases (for
39037 example, when the daemon is not in use and there are no local deliveries), it
39038 may be possible to run Exim setuid to some user other than root. This is
39039 discussed in the next section. However, in most installations, root privilege
39040 is required for two things:
39041
39042 .ilist
39043 To set up a socket connected to the standard SMTP port (25) when initialising
39044 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39045 not required.
39046 .next
39047 To be able to change uid and gid in order to read users' &_.forward_& files and
39048 perform local deliveries as the receiving user or as specified in the
39049 configuration.
39050 .endlist
39051
39052 It is not necessary to be root to do any of the other things Exim does, such as
39053 receiving messages and delivering them externally over SMTP, and it is
39054 obviously more secure if Exim does not run as root except when necessary.
39055 For this reason, a user and group for Exim to use must be defined in
39056 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39057 group"&. Their values can be changed by the runtime configuration, though this
39058 is not recommended. Often a user called &'exim'& is used, but some sites use
39059 &'mail'& or another user name altogether.
39060
39061 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39062 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39063 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39064
39065 After a new Exim process has interpreted its command line options, it changes
39066 uid and gid in the following cases:
39067
39068 .ilist
39069 .oindex "&%-C%&"
39070 .oindex "&%-D%&"
39071 If the &%-C%& option is used to specify an alternate configuration file, or if
39072 the &%-D%& option is used to define macro values for the configuration, and the
39073 calling process is not running as root, the uid and gid are changed to those of
39074 the calling process.
39075 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39076 option may not be used at all.
39077 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39078 can be supplied if the calling process is running as root, the Exim run-time
39079 user or CONFIGURE_OWNER, if defined.
39080 .next
39081 .oindex "&%-be%&"
39082 .oindex "&%-bf%&"
39083 .oindex "&%-bF%&"
39084 If the expansion test option (&%-be%&) or one of the filter testing options
39085 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39086 calling process.
39087 .next
39088 If the process is not a daemon process or a queue runner process or a delivery
39089 process or a process for testing address routing (started with &%-bt%&), the
39090 uid and gid are changed to the Exim user and group. This means that Exim always
39091 runs under its own uid and gid when receiving messages. This also applies when
39092 testing address verification
39093 .oindex "&%-bv%&"
39094 .oindex "&%-bh%&"
39095 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39096 option).
39097 .next
39098 For a daemon, queue runner, delivery, or address testing process, the uid
39099 remains as root at this stage, but the gid is changed to the Exim group.
39100 .endlist
39101
39102 The processes that initially retain root privilege behave as follows:
39103
39104 .ilist
39105 A daemon process changes the gid to the Exim group and the uid to the Exim
39106 user after setting up one or more listening sockets. The &[initgroups()]&
39107 function is called, so that if the Exim user is in any additional groups, they
39108 will be used during message reception.
39109 .next
39110 A queue runner process retains root privilege throughout its execution. Its
39111 job is to fork a controlled sequence of delivery processes.
39112 .next
39113 A delivery process retains root privilege throughout most of its execution,
39114 but any actual deliveries (that is, the transports themselves) are run in
39115 subprocesses which always change to a non-root uid and gid. For local
39116 deliveries this is typically the uid and gid of the owner of the mailbox; for
39117 remote deliveries, the Exim uid and gid are used. Once all the delivery
39118 subprocesses have been run, a delivery process changes to the Exim uid and gid
39119 while doing post-delivery tidying up such as updating the retry database and
39120 generating bounce and warning messages.
39121
39122 While the recipient addresses in a message are being routed, the delivery
39123 process runs as root. However, if a user's filter file has to be processed,
39124 this is done in a subprocess that runs under the individual user's uid and
39125 gid. A system filter is run as root unless &%system_filter_user%& is set.
39126 .next
39127 A process that is testing addresses (the &%-bt%& option) runs as root so that
39128 the routing is done in the same environment as a message delivery.
39129 .endlist
39130
39131
39132
39133
39134 .section "Running Exim without privilege" "SECTrunexiwitpri"
39135 .cindex "privilege, running without"
39136 .cindex "unprivileged running"
39137 .cindex "root privilege" "running without"
39138 Some installations like to run Exim in an unprivileged state for more of its
39139 operation, for added security. Support for this mode of operation is provided
39140 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39141 gid are changed to the Exim user and group at the start of a delivery process
39142 (and also queue runner and address testing processes). This means that address
39143 routing is no longer run as root, and the deliveries themselves cannot change
39144 to any other uid.
39145
39146 .cindex SIGHUP
39147 .cindex "daemon" "restarting"
39148 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39149 that the daemon can still be started in the usual way, and it can respond
39150 correctly to SIGHUP because the re-invocation regains root privilege.
39151
39152 An alternative approach is to make Exim setuid to the Exim user and also setgid
39153 to the Exim group. If you do this, the daemon must be started from a root
39154 process. (Calling Exim from a root process makes it behave in the way it does
39155 when it is setuid root.) However, the daemon cannot restart itself after a
39156 SIGHUP signal because it cannot regain privilege.
39157
39158 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39159 stops Exim from trying to re-invoke itself to do a delivery after a message has
39160 been received. Such a re-invocation is a waste of resources because it has no
39161 effect.
39162
39163 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39164 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39165 to the Exim user seems a clean approach, but there is one complication:
39166
39167 In this style of operation, Exim is running with the real uid and gid set to
39168 those of the calling process, and the effective uid/gid set to Exim's values.
39169 Ideally, any association with the calling process' uid/gid should be dropped,
39170 that is, the real uid/gid should be reset to the effective values so as to
39171 discard any privileges that the caller may have. While some operating systems
39172 have a function that permits this action for a non-root effective uid, quite a
39173 number of them do not. Because of this lack of standardization, Exim does not
39174 address this problem at this time.
39175
39176 For this reason, the recommended approach for &"mostly unprivileged"& running
39177 is to keep the Exim binary setuid to root, and to set
39178 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39179 be used in the most straightforward way.
39180
39181 If you configure Exim not to run delivery processes as root, there are a
39182 number of restrictions on what you can do:
39183
39184 .ilist
39185 You can deliver only as the Exim user/group. You should  explicitly use the
39186 &%user%& and &%group%& options to override routers or local transports that
39187 normally deliver as the recipient. This makes sure that configurations that
39188 work in this mode function the same way in normal mode. Any implicit or
39189 explicit specification of another user causes an error.
39190 .next
39191 Use of &_.forward_& files is severely restricted, such that it is usually
39192 not worthwhile to include them in the configuration.
39193 .next
39194 Users who wish to use &_.forward_& would have to make their home directory and
39195 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39196 and their equivalents in Exim filters, cannot be used. While they could be
39197 enabled in the Exim user's name, that would be insecure and not very useful.
39198 .next
39199 Unless the local user mailboxes are all owned by the Exim user (possible in
39200 some POP3 or IMAP-only environments):
39201
39202 .olist
39203 They must be owned by the Exim group and be writeable by that group. This
39204 implies you must set &%mode%& in the appendfile configuration, as well as the
39205 mode of the mailbox files themselves.
39206 .next
39207 You must set &%no_check_owner%&, since most or all of the files will not be
39208 owned by the Exim user.
39209 .next
39210 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39211 on a newly created mailbox when unprivileged. This also implies that new
39212 mailboxes need to be created manually.
39213 .endlist olist
39214 .endlist ilist
39215
39216
39217 These restrictions severely restrict what can be done in local deliveries.
39218 However, there are no restrictions on remote deliveries. If you are running a
39219 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39220 gives more security at essentially no cost.
39221
39222 If you are using the &%mua_wrapper%& facility (see chapter
39223 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39224
39225
39226
39227
39228 .section "Delivering to local files" "SECID271"
39229 Full details of the checks applied by &(appendfile)& before it writes to a file
39230 are given in chapter &<<CHAPappendfile>>&.
39231
39232
39233
39234 .section "Running local commands" "SECTsecconslocalcmds"
39235 .cindex "security" "local commands"
39236 .cindex "security" "command injection attacks"
39237 There are a number of ways in which an administrator can configure Exim to run
39238 commands based upon received, untrustworthy, data. Further, in some
39239 configurations a user who can control a &_.forward_& file can also arrange to
39240 run commands. Configuration to check includes, but is not limited to:
39241
39242 .ilist
39243 Use of &%use_shell%& in the pipe transport: various forms of shell command
39244 injection may be possible with this option present. It is dangerous and should
39245 be used only with considerable caution. Consider constraints which whitelist
39246 allowed characters in a variable which is to be used in a pipe transport that
39247 has &%use_shell%& enabled.
39248 .next
39249 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39250 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39251 &_.forward_& files in a redirect router. If Exim is running on a central mail
39252 hub to which ordinary users do not have shell access, but home directories are
39253 NFS mounted (for instance) then administrators should review the list of these
39254 forbid options available, and should bear in mind that the options that may
39255 need forbidding can change as new features are added between releases.
39256 .next
39257 The &%${run...}%& expansion item does not use a shell by default, but
39258 administrators can configure use of &_/bin/sh_& as part of the command.
39259 Such invocations should be viewed with prejudicial suspicion.
39260 .next
39261 Administrators who use embedded Perl are advised to explore how Perl's
39262 taint checking might apply to their usage.
39263 .next
39264 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39265 administrators are well advised to view its use with suspicion, in case (for
39266 instance) it allows a local-part to contain embedded Exim directives.
39267 .next
39268 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39269 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39270 each can reference arbitrary lists and files, rather than just being a list
39271 of opaque strings.
39272 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39273 real-world security vulnerabilities caused by its use with untrustworthy data
39274 injected in, for SQL injection attacks.
39275 Consider the use of the &%inlisti%& expansion condition instead.
39276 .endlist
39277
39278
39279
39280
39281 .section "Trust in configuration data" "SECTsecconfdata"
39282 .cindex "security" "data sources"
39283 .cindex "security" "regular expressions"
39284 .cindex "regular expressions" "security"
39285 .cindex "PCRE" "security"
39286 If configuration data for Exim can come from untrustworthy sources, there
39287 are some issues to be aware of:
39288
39289 .ilist
39290 Use of &%${expand...}%& may provide a path for shell injection attacks.
39291 .next
39292 Letting untrusted data provide a regular expression is unwise.
39293 .next
39294 Using &%${match...}%& to apply a fixed regular expression against untrusted
39295 data may result in pathological behaviour within PCRE.  Be aware of what
39296 "backtracking" means and consider options for being more strict with a regular
39297 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39298 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39299 possessive quantifiers or just not using regular expressions against untrusted
39300 data.
39301 .next
39302 It can be important to correctly use &%${quote:...}%&,
39303 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39304 items to ensure that data is correctly constructed.
39305 .next
39306 Some lookups might return multiple results, even though normal usage is only
39307 expected to yield one result.
39308 .endlist
39309
39310
39311
39312
39313 .section "IPv4 source routing" "SECID272"
39314 .cindex "source routing" "in IP packets"
39315 .cindex "IP source routing"
39316 Many operating systems suppress IP source-routed packets in the kernel, but
39317 some cannot be made to do this, so Exim does its own check. It logs incoming
39318 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39319 IPv6. No special checking is currently done.
39320
39321
39322
39323 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39324 Support for these SMTP commands is disabled by default. If required, they can
39325 be enabled by defining suitable ACLs.
39326
39327
39328
39329
39330 .section "Privileged users" "SECID274"
39331 .cindex "trusted users"
39332 .cindex "admin user"
39333 .cindex "privileged user"
39334 .cindex "user" "trusted"
39335 .cindex "user" "admin"
39336 Exim recognizes two sets of users with special privileges. Trusted users are
39337 able to submit new messages to Exim locally, but supply their own sender
39338 addresses and information about a sending host. For other users submitting
39339 local messages, Exim sets up the sender address from the uid, and doesn't
39340 permit a remote host to be specified.
39341
39342 .oindex "&%-f%&"
39343 However, an untrusted user is permitted to use the &%-f%& command line option
39344 in the special form &%-f <>%& to indicate that a delivery failure for the
39345 message should not cause an error report. This affects the message's envelope,
39346 but it does not affect the &'Sender:'& header. Untrusted users may also be
39347 permitted to use specific forms of address with the &%-f%& option by setting
39348 the &%untrusted_set_sender%& option.
39349
39350 Trusted users are used to run processes that receive mail messages from some
39351 other mail domain and pass them on to Exim for delivery either locally, or over
39352 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39353 as any user listed in the &%trusted_users%& configuration option, or under any
39354 group listed in the &%trusted_groups%& option.
39355
39356 Admin users are permitted to do things to the messages on Exim's queue. They
39357 can freeze or thaw messages, cause them to be returned to their senders, remove
39358 them entirely, or modify them in various ways. In addition, admin users can run
39359 the Exim monitor and see all the information it is capable of providing, which
39360 includes the contents of files on the spool.
39361
39362 .oindex "&%-M%&"
39363 .oindex "&%-q%&"
39364 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39365 delivery of messages on its queue is restricted to admin users. This
39366 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39367 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39368 queue is also restricted to admin users. This restriction can be relaxed by
39369 setting &%no_queue_list_requires_admin%&.
39370
39371 Exim recognizes an admin user if the calling process is running as root or as
39372 the Exim user or if any of the groups associated with the calling process is
39373 the Exim group. It is not necessary actually to be running under the Exim
39374 group. However, if admin users who are not root or the Exim user are to access
39375 the contents of files on the spool via the Exim monitor (which runs
39376 unprivileged), Exim must be built to allow group read access to its spool
39377 files.
39378
39379 By default, regular users are trusted to perform basic testing and
39380 introspection commands, as themselves.  This setting can be tightened by
39381 setting the &%commandline_checks_require_admin%& option.
39382 This affects most of the checking options,
39383 such as &%-be%& and anything else &%-b*%&.
39384
39385
39386 .section "Spool files" "SECID275"
39387 .cindex "spool directory" "files"
39388 Exim's spool directory and everything it contains is owned by the Exim user and
39389 set to the Exim group. The mode for spool files is defined in the
39390 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39391 any user who is a member of the Exim group can access these files.
39392
39393
39394
39395 .section "Use of argv[0]" "SECID276"
39396 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39397 of specific strings, Exim assumes certain options. For example, calling Exim
39398 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39399 to calling it with the option &%-bS%&. There are no security implications in
39400 this.
39401
39402
39403
39404 .section "Use of %f formatting" "SECID277"
39405 The only use made of &"%f"& by Exim is in formatting load average values. These
39406 are actually stored in integer variables as 1000 times the load average.
39407 Consequently, their range is limited and so therefore is the length of the
39408 converted output.
39409
39410
39411
39412 .section "Embedded Exim path" "SECID278"
39413 Exim uses its own path name, which is embedded in the code, only when it needs
39414 to re-exec in order to regain root privilege. Therefore, it is not root when it
39415 does so. If some bug allowed the path to get overwritten, it would lead to an
39416 arbitrary program's being run as exim, not as root.
39417
39418
39419
39420 .section "Dynamic module directory" "SECTdynmoddir"
39421 Any dynamically loadable modules must be installed into the directory
39422 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39423 loading it.
39424
39425
39426 .section "Use of sprintf()" "SECID279"
39427 .cindex "&[sprintf()]&"
39428 A large number of occurrences of &"sprintf"& in the code are actually calls to
39429 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39430 The intermediate formatting is done into a large fixed buffer by a function
39431 that runs through the format string itself, and checks the length of each
39432 conversion before performing it, thus preventing buffer overruns.
39433
39434 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39435 the output buffer is known to be sufficiently long to contain the converted
39436 string.
39437
39438
39439
39440 .section "Use of debug_printf() and log_write()" "SECID280"
39441 Arbitrary strings are passed to both these functions, but they do their
39442 formatting by calling the function &'string_vformat()'&, which runs through
39443 the format string itself, and checks the length of each conversion.
39444
39445
39446
39447 .section "Use of strcat() and strcpy()" "SECID281"
39448 These are used only in cases where the output buffer is known to be large
39449 enough to hold the result.
39450 .ecindex IIDsecurcon
39451
39452
39453
39454
39455 . ////////////////////////////////////////////////////////////////////////////
39456 . ////////////////////////////////////////////////////////////////////////////
39457
39458 .chapter "Format of spool files" "CHAPspool"
39459 .scindex IIDforspo1 "format" "spool files"
39460 .scindex IIDforspo2 "spool directory" "format of files"
39461 .scindex IIDforspo3 "spool files" "format of"
39462 .cindex "spool files" "editing"
39463 A message on Exim's queue consists of two files, whose names are the message id
39464 followed by -D and -H, respectively. The data portion of the message is kept in
39465 the -D file on its own. The message's envelope, status, and headers are all
39466 kept in the -H file, whose format is described in this chapter. Each of these
39467 two files contains the final component of its own name as its first line. This
39468 is insurance against disk crashes where the directory is lost but the files
39469 themselves are recoverable.
39470
39471 The file formats may be changed, or new formats added, at any release.
39472 Spool files are not intended as an interface to other programs
39473 and should not be used as such.
39474
39475 Some people are tempted into editing -D files in order to modify messages. You
39476 need to be extremely careful if you do this; it is not recommended and you are
39477 on your own if you do it. Here are some of the pitfalls:
39478
39479 .ilist
39480 You must ensure that Exim does not try to deliver the message while you are
39481 fiddling with it. The safest way is to take out a write lock on the -D file,
39482 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39483 place, the lock will be retained. If you write a new file and rename it, the
39484 lock will be lost at the instant of rename.
39485 .next
39486 .vindex "&$body_linecount$&"
39487 If you change the number of lines in the file, the value of
39488 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39489 cause incomplete transmission of messages or undeliverable messages.
39490 .next
39491 If the message is in MIME format, you must take care not to break it.
39492 .next
39493 If the message is cryptographically signed, any change will invalidate the
39494 signature.
39495 .endlist
39496 All in all, modifying -D files is fraught with danger.
39497
39498 Files whose names end with -J may also be seen in the &_input_& directory (or
39499 its subdirectories when &%split_spool_directory%& is set). These are journal
39500 files, used to record addresses to which the message has been delivered during
39501 the course of a delivery attempt. If there are still undelivered recipients at
39502 the end, the -H file is updated, and the -J file is deleted. If, however, there
39503 is some kind of crash (for example, a power outage) before this happens, the -J
39504 file remains in existence. When Exim next processes the message, it notices the
39505 -J file and uses it to update the -H file before starting the next delivery
39506 attempt.
39507
39508 Files whose names end with -K or .eml may also be seen in the spool.
39509 These are temporaries used for DKIM or malware processing, when that is used.
39510 They should be tidied up by normal operations; any old ones are probably
39511 relics of crashes and can be removed.
39512
39513 .section "Format of the -H file" "SECID282"
39514 .cindex "uid (user id)" "in spool file"
39515 .cindex "gid (group id)" "in spool file"
39516 The second line of the -H file contains the login name for the uid of the
39517 process that called Exim to read the message, followed by the numerical uid and
39518 gid. For a locally generated message, this is normally the user who sent the
39519 message. For a message received over TCP/IP via the daemon, it is
39520 normally the Exim user.
39521
39522 The third line of the file contains the address of the message's sender as
39523 transmitted in the envelope, contained in angle brackets. The sender address is
39524 empty for bounce messages. For incoming SMTP mail, the sender address is given
39525 in the MAIL command. For locally generated mail, the sender address is
39526 created by Exim from the login name of the current user and the configured
39527 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39528 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39529 &"<>"& or an address that matches &%untrusted_set_senders%&.
39530
39531 The fourth line contains two numbers. The first is the time that the message
39532 was received, in the conventional Unix form &-- the number of seconds since the
39533 start of the epoch. The second number is a count of the number of messages
39534 warning of delayed delivery that have been sent to the sender.
39535
39536 There follow a number of lines starting with a hyphen. These can appear in any
39537 order, and are omitted when not relevant:
39538
39539 .vlist
39540 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39541 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39542 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39543 recognized, to provide backward compatibility. In the old format, a line of
39544 this form is present for every ACL variable that is not empty. The number
39545 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39546 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39547 the data string for the variable. The string itself starts at the beginning of
39548 the next line, and is followed by a newline character. It may contain internal
39549 newlines.
39550
39551 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39552 A line of this form is present for every ACL connection variable that is
39553 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39554 The length is the length of the data string for the variable. The string itself
39555 starts at the beginning of the next line, and is followed by a newline
39556 character. It may contain internal newlines.
39557
39558 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39559 A line of this form is present for every ACL message variable that is defined.
39560 Note that there is a space between &%-aclm%& and the rest of the name. The
39561 length is the length of the data string for the variable. The string itself
39562 starts at the beginning of the next line, and is followed by a newline
39563 character. It may contain internal newlines.
39564
39565 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39566 This is present if, when the message was received over SMTP, the value of
39567 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39568
39569 .vitem &%-allow_unqualified_recipient%&
39570 This is present if unqualified recipient addresses are permitted in header
39571 lines (to stop such addresses from being qualified if rewriting occurs at
39572 transport time). Local messages that were input using &%-bnq%& and remote
39573 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39574
39575 .vitem &%-allow_unqualified_sender%&
39576 This is present if unqualified sender addresses are permitted in header lines
39577 (to stop such addresses from being qualified if rewriting occurs at transport
39578 time). Local messages that were input using &%-bnq%& and remote messages from
39579 hosts that match &%sender_unqualified_hosts%& set this flag.
39580
39581 .vitem "&%-auth_id%&&~<&'text'&>"
39582 The id information for a message received on an authenticated SMTP connection
39583 &-- the value of the &$authenticated_id$& variable.
39584
39585 .vitem "&%-auth_sender%&&~<&'address'&>"
39586 The address of an authenticated sender &-- the value of the
39587 &$authenticated_sender$& variable.
39588
39589 .vitem "&%-body_linecount%&&~<&'number'&>"
39590 This records the number of lines in the body of the message, and is
39591 present unless &%-spool_file_wireformat%& is.
39592
39593 .vitem "&%-body_zerocount%&&~<&'number'&>"
39594 This records the number of binary zero bytes in the body of the message, and is
39595 present if the number is greater than zero.
39596
39597 .vitem &%-deliver_firsttime%&
39598 This is written when a new message is first added to the spool. When the spool
39599 file is updated after a deferral, it is omitted.
39600
39601 .vitem "&%-frozen%&&~<&'time'&>"
39602 .cindex "frozen messages" "spool data"
39603 The message is frozen, and the freezing happened at <&'time'&>.
39604
39605 .vitem "&%-helo_name%&&~<&'text'&>"
39606 This records the host name as specified by a remote host in a HELO or EHLO
39607 command.
39608
39609 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39610 This records the IP address of the host from which the message was received and
39611 the remote port number that was used. It is omitted for locally generated
39612 messages.
39613
39614 .vitem "&%-host_auth%&&~<&'text'&>"
39615 If the message was received on an authenticated SMTP connection, this records
39616 the name of the authenticator &-- the value of the
39617 &$sender_host_authenticated$& variable.
39618
39619 .vitem &%-host_lookup_failed%&
39620 This is present if an attempt to look up the sending host's name from its IP
39621 address failed. It corresponds to the &$host_lookup_failed$& variable.
39622
39623 .vitem "&%-host_name%&&~<&'text'&>"
39624 .cindex "reverse DNS lookup"
39625 .cindex "DNS" "reverse lookup"
39626 This records the name of the remote host from which the message was received,
39627 if the host name was looked up from the IP address when the message was being
39628 received. It is not present if no reverse lookup was done.
39629
39630 .vitem "&%-ident%&&~<&'text'&>"
39631 For locally submitted messages, this records the login of the originating user,
39632 unless it was a trusted user and the &%-oMt%& option was used to specify an
39633 ident value. For messages received over TCP/IP, this records the ident string
39634 supplied by the remote host, if any.
39635
39636 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39637 This records the IP address of the local interface and the port number through
39638 which a message was received from a remote host. It is omitted for locally
39639 generated messages.
39640
39641 .vitem &%-local%&
39642 The message is from a local sender.
39643
39644 .vitem &%-localerror%&
39645 The message is a locally-generated bounce message.
39646
39647 .vitem "&%-local_scan%&&~<&'string'&>"
39648 This records the data string that was returned by the &[local_scan()]& function
39649 when the message was received &-- the value of the &$local_scan_data$&
39650 variable. It is omitted if no data was returned.
39651
39652 .vitem &%-manual_thaw%&
39653 The message was frozen but has been thawed manually, that is, by an explicit
39654 Exim command rather than via the auto-thaw process.
39655
39656 .vitem &%-N%&
39657 A testing delivery process was started using the &%-N%& option to suppress any
39658 actual deliveries, but delivery was deferred. At any further delivery attempts,
39659 &%-N%& is assumed.
39660
39661 .vitem &%-received_protocol%&
39662 This records the value of the &$received_protocol$& variable, which contains
39663 the name of the protocol by which the message was received.
39664
39665 .vitem &%-sender_set_untrusted%&
39666 The envelope sender of this message was set by an untrusted local caller (used
39667 to ensure that the caller is displayed in queue listings).
39668
39669 .vitem "&%-spam_score_int%&&~<&'number'&>"
39670 If a message was scanned by SpamAssassin, this is present. It records the value
39671 of &$spam_score_int$&.
39672
39673 .vitem &%-spool_file_wireformat%&
39674 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39675 rather than Unix-format.
39676 The line-ending is CRLF rather than newline.
39677 There is still, however, no leading-dot-stuffing.
39678
39679 .vitem &%-tls_certificate_verified%&
39680 A TLS certificate was received from the client that sent this message, and the
39681 certificate was verified by the server.
39682
39683 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39684 When the message was received over an encrypted connection, this records the
39685 name of the cipher suite that was used.
39686
39687 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39688 When the message was received over an encrypted connection, and a certificate
39689 was received from the client, this records the Distinguished Name from that
39690 certificate.
39691 .endlist
39692
39693 .new
39694 Any of the above may have an extra hyphen prepended, to indicate the the
39695 corresponding data is untrusted.
39696 .wen
39697
39698 Following the options there is a list of those addresses to which the message
39699 is not to be delivered. This set of addresses is initialized from the command
39700 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39701 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39702 the address is added to this set. The addresses are kept internally as a
39703 balanced binary tree, and it is a representation of that tree which is written
39704 to the spool file. If an address is expanded via an alias or forward file, the
39705 original address is added to the tree when deliveries to all its child
39706 addresses are complete.
39707
39708 If the tree is empty, there is a single line in the spool file containing just
39709 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39710 Y or N, followed by an address. The address is the value for the node of the
39711 tree, and the letters indicate whether the node has a left branch and/or a
39712 right branch attached to it, respectively. If branches exist, they immediately
39713 follow. Here is an example of a three-node tree:
39714 .code
39715 YY darcy@austen.fict.example
39716 NN alice@wonderland.fict.example
39717 NN editor@thesaurus.ref.example
39718 .endd
39719 After the non-recipients tree, there is a list of the message's recipients.
39720 This is a simple list, preceded by a count. It includes all the original
39721 recipients of the message, including those to whom the message has already been
39722 delivered. In the simplest case, the list contains one address per line. For
39723 example:
39724 .code
39725 4
39726 editor@thesaurus.ref.example
39727 darcy@austen.fict.example
39728 rdo@foundation
39729 alice@wonderland.fict.example
39730 .endd
39731 However, when a child address has been added to the top-level addresses as a
39732 result of the use of the &%one_time%& option on a &(redirect)& router, each
39733 line is of the following form:
39734 .display
39735 <&'top-level address'&> <&'errors_to address'&> &&&
39736   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39737 .endd
39738 The 01 flag bit indicates the presence of the three other fields that follow
39739 the top-level address. Other bits may be used in future to support additional
39740 fields. The <&'parent number'&> is the offset in the recipients list of the
39741 original parent of the &"one time"& address. The first two fields are the
39742 envelope sender that is associated with this address and its length. If the
39743 length is zero, there is no special envelope sender (there are then two space
39744 characters in the line). A non-empty field can arise from a &(redirect)& router
39745 that has an &%errors_to%& setting.
39746
39747
39748 A blank line separates the envelope and status information from the headers
39749 which follow. A header may occupy several lines of the file, and to save effort
39750 when reading it in, each header is preceded by a number and an identifying
39751 character. The number is the number of characters in the header, including any
39752 embedded newlines and the terminating newline. The character is one of the
39753 following:
39754
39755 .table2 50pt
39756 .row <&'blank'&>         "header in which Exim has no special interest"
39757 .row &`B`&               "&'Bcc:'& header"
39758 .row &`C`&               "&'Cc:'& header"
39759 .row &`F`&               "&'From:'& header"
39760 .row &`I`&               "&'Message-id:'& header"
39761 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39762 .row &`R`&               "&'Reply-To:'& header"
39763 .row &`S`&               "&'Sender:'& header"
39764 .row &`T`&               "&'To:'& header"
39765 .row &`*`&               "replaced or deleted header"
39766 .endtable
39767
39768 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39769 purposes. They are not transmitted when the message is delivered. Here is a
39770 typical set of headers:
39771 .code
39772 111P Received: by hobbit.fict.example with local (Exim 4.00)
39773 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39774 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39775 038* X-rewrote-sender: bb@hobbit.fict.example
39776 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39777 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39778 099* To: alice@wonderland.fict.example, rdo@foundation,
39779 darcy@austen.fict.example, editor@thesaurus.ref.example
39780 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39781 darcy@austen.fict.example, editor@thesaurus.ref.example
39782 038  Date: Fri, 11 May 2001 10:28:59 +0100
39783 .endd
39784 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39785 &'To:'& header have been rewritten, the last one because routing expanded the
39786 unqualified domain &'foundation'&.
39787 .ecindex IIDforspo1
39788 .ecindex IIDforspo2
39789 .ecindex IIDforspo3
39790
39791 .section "Format of the -D file" "SECID282a"
39792 The data file is traditionally in Unix-standard format: lines are ended with
39793 an ASCII newline character.
39794 However, when the &%spool_wireformat%& main option is used some -D files
39795 can have an alternate format.
39796 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39797 The -D file lines (not including the first name-component line) are
39798 suitable for direct copying to the wire when transmitting using the
39799 ESMTP CHUNKING option, meaning lower processing overhead.
39800 Lines are terminated with an ASCII CRLF pair.
39801 There is no dot-stuffing (and no dot-termination).
39802
39803 . ////////////////////////////////////////////////////////////////////////////
39804 . ////////////////////////////////////////////////////////////////////////////
39805
39806 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
39807          "DKIM, SPF and DMARC Support"
39808
39809 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39810 .cindex "DKIM"
39811
39812 DKIM is a mechanism by which messages sent by some entity can be provably
39813 linked to a domain which that entity controls.  It permits reputation to
39814 be tracked on a per-domain basis, rather than merely upon source IP address.
39815 DKIM is documented in RFC 6376.
39816
39817 As DKIM relies on the message being unchanged in transit, messages handled
39818 by a mailing-list (which traditionally adds to the message) will not match
39819 any original DKIM signature.
39820
39821 DKIM support is compiled into Exim by default if TLS support is present.
39822 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39823
39824 Exim's DKIM implementation allows for
39825 .olist
39826 Signing outgoing messages: This function is implemented in the SMTP transport.
39827 It can co-exist with all other Exim features
39828 (including transport filters)
39829 except cutthrough delivery.
39830 .next
39831 Verifying signatures in incoming messages: This is implemented by an additional
39832 ACL (acl_smtp_dkim), which can be called several times per message, with
39833 different signature contexts.
39834 .endlist
39835
39836 In typical Exim style, the verification implementation does not include any
39837 default "policy". Instead it enables you to build your own policy using
39838 Exim's standard controls.
39839
39840 Please note that verification of DKIM signatures in incoming mail is turned
39841 on by default for logging (in the <= line) purposes.
39842
39843 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39844 When set, for each signature in incoming email,
39845 exim will log a line displaying the most important signature details, and the
39846 signature status. Here is an example (with line-breaks added for clarity):
39847 .code
39848 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39849     d=facebookmail.com s=q1-2009b
39850     c=relaxed/relaxed a=rsa-sha1
39851     i=@facebookmail.com t=1252484542 [verification succeeded]
39852 .endd
39853
39854 You might want to turn off DKIM verification processing entirely for internal
39855 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39856 control modifier. This should typically be done in the RCPT ACL, at points
39857 where you accept mail from relay sources (internal hosts or authenticated
39858 senders).
39859
39860
39861 .section "Signing outgoing messages" "SECDKIMSIGN"
39862 .cindex "DKIM" "signing"
39863
39864 For signing to be usable you must have published a DKIM record in DNS.
39865 Note that RFC 8301 (which does not cover EC keys) says:
39866 .code
39867 rsa-sha1 MUST NOT be used for signing or verifying.
39868
39869 Signers MUST use RSA keys of at least 1024 bits for all keys.
39870 Signers SHOULD use RSA keys of at least 2048 bits.
39871 .endd
39872
39873 Note also that the key content (the 'p=' field)
39874 in the DNS record is different between RSA and EC keys;
39875 for the former it is the base64 of the ASN.1 for the RSA public key
39876 (equivalent to the private-key .pem with the header/trailer stripped)
39877 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39878
39879 Signing is enabled by setting private options on the SMTP transport.
39880 These options take (expandable) strings as arguments.
39881
39882 .option dkim_domain smtp string list&!! unset
39883 The domain(s) you want to sign with.
39884 After expansion, this can be a list.
39885 Each element in turn,
39886 .new
39887 lowercased,
39888 .wen
39889 is put into the &%$dkim_domain%& expansion variable
39890 while expanding the remaining signing options.
39891 If it is empty after expansion, DKIM signing is not done,
39892 and no error will result even if &%dkim_strict%& is set.
39893
39894 .option dkim_selector smtp string list&!! unset
39895 This sets the key selector string.
39896 After expansion, which can use &$dkim_domain$&, this can be a list.
39897 Each element in turn is put in the expansion
39898 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39899 option along with &%$dkim_domain%&.
39900 If the option is empty after expansion, DKIM signing is not done for this domain,
39901 and no error will result even if &%dkim_strict%& is set.
39902
39903 .option dkim_private_key smtp string&!! unset
39904 This sets the private key to use.
39905 You can use the &%$dkim_domain%& and
39906 &%$dkim_selector%& expansion variables to determine the private key to use.
39907 The result can either
39908 .ilist
39909 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39910 .next
39911 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39912 be a valid Ed25519 private key (same format as above)
39913 .next
39914 start with a slash, in which case it is treated as a file that contains
39915 the private key
39916 .next
39917 be "0", "false" or the empty string, in which case the message will not
39918 be signed. This case will not result in an error, even if &%dkim_strict%&
39919 is set.
39920 .endlist
39921
39922 To generate keys under OpenSSL:
39923 .code
39924 openssl genrsa -out dkim_rsa.private 2048
39925 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39926 .endd
39927 Take the base-64 lines from the output of the second command, concatenated,
39928 for the DNS TXT record.
39929 See section 3.6 of RFC6376 for the record specification.
39930
39931 Under GnuTLS:
39932 .code
39933 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39934 certtool --load-privkey=dkim_rsa.private --pubkey-info
39935 .endd
39936
39937 Note that RFC 8301 says:
39938 .code
39939 Signers MUST use RSA keys of at least 1024 bits for all keys.
39940 Signers SHOULD use RSA keys of at least 2048 bits.
39941 .endd
39942
39943 .new
39944 EC keys for DKIM are defined by RFC 8463.
39945 .wen
39946 They are considerably smaller than RSA keys for equivalent protection.
39947 As they are a recent development, users should consider dual-signing
39948 (by setting a list of selectors, and an expansion for this option)
39949 for some transition period.
39950 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39951 for EC keys.
39952
39953 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39954 .code
39955 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39956 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39957 .endd
39958
39959 To produce the required public key value for a DNS record:
39960 .code
39961 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39962 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39963 .endd
39964
39965 .new
39966 Exim also supports an alternate format
39967 of Ed25519 keys in DNS which was a candidate during development
39968 of the standard, but not adopted.
39969 A future release will probably drop that support.
39970 .wen
39971
39972 .option dkim_hash smtp string&!! sha256
39973 Can be set to any one of the supported hash methods, which are:
39974 .ilist
39975 &`sha1`& &-- should not be used, is old and insecure
39976 .next
39977 &`sha256`& &-- the default
39978 .next
39979 &`sha512`& &-- possibly more secure but less well supported
39980 .endlist
39981
39982 Note that RFC 8301 says:
39983 .code
39984 rsa-sha1 MUST NOT be used for signing or verifying.
39985 .endd
39986
39987 .option dkim_identity smtp string&!! unset
39988 If set after expansion, the value is used to set an "i=" tag in
39989 the signing header.  The DKIM standards restrict the permissible
39990 syntax of this optional tag to a mail address, with possibly-empty
39991 local part, an @, and a domain identical to or subdomain of the "d="
39992 tag value.  Note that Exim does not check the value.
39993
39994 .option dkim_canon smtp string&!! unset
39995 This option sets the canonicalization method used when signing a message.
39996 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39997 The option defaults to "relaxed" when unset. Note: the current implementation
39998 only supports signing with the same canonicalization method for both headers and body.
39999
40000 .option dkim_strict smtp string&!! unset
40001 This  option  defines  how  Exim  behaves  when  signing a message that
40002 should be signed fails for some reason.  When the expansion evaluates to
40003 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40004 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40005 variables here.
40006
40007 .option dkim_sign_headers smtp string&!! "see below"
40008 If set, this option must expand to a colon-separated
40009 list of header names.
40010 Headers with these names, or the absence or such a header, will be included
40011 in the message signature.
40012 When unspecified, the header names listed in RFC4871 will be used,
40013 whether or not each header is present in the message.
40014 The default list is available for the expansion in the macro
40015 "_DKIM_SIGN_HEADERS".
40016
40017 If a name is repeated, multiple headers by that name (or the absence thereof)
40018 will be signed.  The textually later headers in the headers part of the
40019 message are signed first, if there are multiples.
40020
40021 A name can be prefixed with either an '=' or a '+' character.
40022 If an '=' prefix is used, all headers that are present with this name
40023 will be signed.
40024 If a '+' prefix if used, all headers that are present with this name
40025 will be signed, and one signature added for a missing header with the
40026 name will be appended.
40027
40028 .option dkim_timestamps smtp integer&!! unset
40029 This option controls the inclusion of timestamp information in the signature.
40030 If not set, no such information will be included.
40031 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40032 for the expiry tag
40033 (eg. 1209600 for two weeks);
40034 both creation (t=) and expiry (x=) tags will be included.
40035
40036 RFC 6376 lists these tags as RECOMMENDED.
40037
40038
40039 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40040 .cindex "DKIM" "verification"
40041
40042 Verification of DKIM signatures in SMTP incoming email is done for all
40043 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40044 .new
40045 .cindex DKIM "selecting signature algorithms"
40046 Individual classes of signature algorithm can be ignored by changing
40047 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40048 The &%dkim_verify_minimal%& option can be set to cease verification
40049 processing for a message once the first passing signature is found.
40050 .wen
40051
40052 .cindex authentication "expansion item"
40053 Performing verification sets up information used by the
40054 &%authresults%& expansion item.
40055
40056 .new
40057 For most purposes the default option settings suffice and the remainder
40058 of this section can be ignored.
40059 .wen
40060
40061 The results of verification are made available to the
40062 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40063 A missing ACL definition defaults to accept.
40064 By default, the ACL is called once for each
40065 syntactically(!) correct signature in the incoming message.
40066 If any ACL call does not accept, the message is not accepted.
40067 If a cutthrough delivery was in progress for the message, that is
40068 summarily dropped (having wasted the transmission effort).
40069
40070 To evaluate the verification result in the ACL
40071 a large number of expansion variables
40072 containing the signature status and its details are set up during the
40073 runtime of the ACL.
40074
40075 Calling the ACL only for existing signatures is not sufficient to build
40076 more advanced policies. For that reason, the main option
40077 &%dkim_verify_signers%&, and an expansion variable
40078 &%$dkim_signers%& exist.
40079
40080 The main option &%dkim_verify_signers%& can be set to a colon-separated
40081 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40082 called. It is expanded when the message has been received. At this point,
40083 the expansion variable &%$dkim_signers%& already contains a colon-separated
40084 list of signer domains and identities for the message. When
40085 &%dkim_verify_signers%& is not specified in the main configuration,
40086 it defaults as:
40087 .code
40088 dkim_verify_signers = $dkim_signers
40089 .endd
40090 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40091 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40092 call the ACL for known domains or identities. This would be achieved as follows:
40093 .code
40094 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40095 .endd
40096 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40097 and "ebay.com", plus all domains and identities that have signatures in the message.
40098 You can also be more creative in constructing your policy. For example:
40099 .code
40100 dkim_verify_signers = $sender_address_domain:$dkim_signers
40101 .endd
40102
40103 If a domain or identity is listed several times in the (expanded) value of
40104 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40105
40106 .new
40107 Note that if the option is set using untrustworthy data
40108 (such as the From: header)
40109 care should be taken to force lowercase for domains
40110 and for the domain part if identities.
40111 The default setting can be regarded as trustworthy in this respect.
40112 .wen
40113
40114 If multiple signatures match a domain (or identity), the ACL is called once
40115 for each matching signature.
40116
40117
40118 Inside the DKIM ACL, the following expansion variables are
40119 available (from most to least important):
40120
40121
40122 .vlist
40123 .vitem &%$dkim_cur_signer%&
40124 The signer that is being evaluated in this ACL run. This can be a domain or
40125 an identity. This is one of the list items from the expanded main option
40126 &%dkim_verify_signers%& (see above).
40127
40128 .vitem &%$dkim_verify_status%&
40129 Within the DKIM ACL,
40130 a string describing the general status of the signature. One of
40131 .ilist
40132 &%none%&: There is no signature in the message for the current domain or
40133 identity (as reflected by &%$dkim_cur_signer%&).
40134 .next
40135 &%invalid%&: The signature could not be verified due to a processing error.
40136 More detail is available in &%$dkim_verify_reason%&.
40137 .next
40138 &%fail%&: Verification of the signature failed.  More detail is
40139 available in &%$dkim_verify_reason%&.
40140 .next
40141 &%pass%&: The signature passed verification. It is valid.
40142 .endlist
40143
40144 This variable can be overwritten using an ACL 'set' modifier.
40145 This might, for instance, be done to enforce a policy restriction on
40146 hash-method or key-size:
40147 .code
40148   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40149        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40150        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40151                                   {< {$dkim_key_length}{1024}}}}
40152        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40153        set dkim_verify_status = fail
40154        set dkim_verify_reason = hash too weak or key too short
40155 .endd
40156
40157 So long as a DKIM ACL is defined (it need do no more than accept),
40158 after all the DKIM ACL runs have completed, the value becomes a
40159 colon-separated list of the values after each run.
40160 This is maintained for the mime, prdr and data ACLs.
40161
40162 .vitem &%$dkim_verify_reason%&
40163 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40164 "fail" or "invalid". One of
40165 .ilist
40166 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40167 key for the domain could not be retrieved. This may be a temporary problem.
40168 .next
40169 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40170 record for the domain is syntactically invalid.
40171 .next
40172 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40173 body hash does not match the one specified in the signature header. This
40174 means that the message body was modified in transit.
40175 .next
40176 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40177 could not be verified. This may mean that headers were modified,
40178 re-written or otherwise changed in a way which is incompatible with
40179 DKIM verification. It may of course also mean that the signature is forged.
40180 .endlist
40181
40182 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40183
40184 .vitem &%$dkim_domain%&
40185 The signing domain. IMPORTANT: This variable is only populated if there is
40186 an actual signature in the message for the current domain or identity (as
40187 reflected by &%$dkim_cur_signer%&).
40188
40189 .vitem &%$dkim_identity%&
40190 The signing identity, if present. IMPORTANT: This variable is only populated
40191 if there is an actual signature in the message for the current domain or
40192 identity (as reflected by &%$dkim_cur_signer%&).
40193
40194 .vitem &%$dkim_selector%&
40195 The key record selector string.
40196
40197 .vitem &%$dkim_algo%&
40198 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40199 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40200 may also be 'ed25519-sha256'.
40201 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40202 for EC keys.
40203
40204 Note that RFC 8301 says:
40205 .code
40206 rsa-sha1 MUST NOT be used for signing or verifying.
40207
40208 DKIM signatures identified as having been signed with historic
40209 algorithms (currently, rsa-sha1) have permanently failed evaluation
40210 .endd
40211
40212 To enforce this you must either have a DKIM ACL which checks this variable
40213 and overwrites the &$dkim_verify_status$& variable as discussed above,
40214 .new
40215 or have set the main option &%dkim_verify_hashes%& to exclude
40216 processing of such signatures.
40217 .wen
40218
40219 .vitem &%$dkim_canon_body%&
40220 The body canonicalization method. One of 'relaxed' or 'simple'.
40221
40222 .vitem &%$dkim_canon_headers%&
40223 The header canonicalization method. One of 'relaxed' or 'simple'.
40224
40225 .vitem &%$dkim_copiedheaders%&
40226 A transcript of headers and their values which are included in the signature
40227 (copied from the 'z=' tag of the signature).
40228 Note that RFC6376 requires that verification fail if the From: header is
40229 not included in the signature.  Exim does not enforce this; sites wishing
40230 strict enforcement should code the check explicitly.
40231
40232 .vitem &%$dkim_bodylength%&
40233 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40234 limit was set by the signer, "9999999999999" is returned. This makes sure
40235 that this variable always expands to an integer value.
40236 &*Note:*& The presence of the signature tag specifying a signing body length
40237 is one possible route to spoofing of valid DKIM signatures.
40238 A paranoid implementation might wish to regard signature where this variable
40239 shows less than the "no limit" return as being invalid.
40240
40241 .vitem &%$dkim_created%&
40242 UNIX timestamp reflecting the date and time when the signature was created.
40243 When this was not specified by the signer, "0" is returned.
40244
40245 .vitem &%$dkim_expires%&
40246 UNIX timestamp reflecting the date and time when the signer wants the
40247 signature to be treated as "expired". When this was not specified by the
40248 signer, "9999999999999" is returned. This makes it possible to do useful
40249 integer size comparisons against this value.
40250 Note that Exim does not check this value.
40251
40252 .vitem &%$dkim_headernames%&
40253 A colon-separated list of names of headers included in the signature.
40254
40255 .vitem &%$dkim_key_testing%&
40256 "1" if the key record has the "testing" flag set, "0" if not.
40257
40258 .vitem &%$dkim_key_nosubdomains%&
40259 "1" if the key record forbids subdomaining, "0" otherwise.
40260
40261 .vitem &%$dkim_key_srvtype%&
40262 Service type (tag s=) from the key record. Defaults to "*" if not specified
40263 in the key record.
40264
40265 .vitem &%$dkim_key_granularity%&
40266 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40267 in the key record.
40268
40269 .vitem &%$dkim_key_notes%&
40270 Notes from the key record (tag n=).
40271
40272 .vitem &%$dkim_key_length%&
40273 Number of bits in the key.
40274
40275 Note that RFC 8301 says:
40276 .code
40277 Verifiers MUST NOT consider signatures using RSA keys of
40278 less than 1024 bits as valid signatures.
40279 .endd
40280
40281 To enforce this you must have a DKIM ACL which checks this variable
40282 and overwrites the &$dkim_verify_status$& variable as discussed above.
40283 As EC keys are much smaller, the check should only do this for RSA keys.
40284
40285 .endlist
40286
40287 In addition, two ACL conditions are provided:
40288
40289 .vlist
40290 .vitem &%dkim_signers%&
40291 ACL condition that checks a colon-separated list of domains or identities
40292 for a match against the domain or identity that the ACL is currently verifying
40293 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40294 verb to a group of domains or identities. For example:
40295
40296 .code
40297 # Warn when Mail purportedly from GMail has no gmail signature
40298 warn log_message = GMail sender without gmail.com DKIM signature
40299      sender_domains = gmail.com
40300      dkim_signers = gmail.com
40301      dkim_status = none
40302 .endd
40303
40304 Note that the above does not check for a total lack of DKIM signing;
40305 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40306
40307 .vitem &%dkim_status%&
40308 ACL condition that checks a colon-separated list of possible DKIM verification
40309 results against the actual result of verification. This is typically used
40310 to restrict an ACL verb to a list of verification outcomes, for example:
40311
40312 .code
40313 deny message = Mail from Paypal with invalid/missing signature
40314      sender_domains = paypal.com:paypal.de
40315      dkim_signers = paypal.com:paypal.de
40316      dkim_status = none:invalid:fail
40317 .endd
40318
40319 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40320 see the documentation of the &%$dkim_verify_status%& expansion variable above
40321 for more information of what they mean.
40322 .endlist
40323
40324
40325
40326
40327 .section "SPF (Sender Policy Framework)" SECSPF
40328 .cindex SPF verification
40329
40330 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40331 messages with its domain in the envelope from, documented by RFC 7208.
40332 For more information on SPF see &url(http://www.openspf.org).
40333 . --- 2018-09-07: still not https
40334
40335 Messages sent by a system not authorised will fail checking of such assertions.
40336 This includes retransmissions done by traditional forwarders.
40337
40338 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40339 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40340 &url(https://www.libspf2.org/).
40341 There is no Exim involvement in the transmission of messages;
40342 publishing certain DNS records is all that is required.
40343
40344 For verification, an ACL condition and an expansion lookup are provided.
40345 .cindex authentication "expansion item"
40346 Performing verification sets up information used by the
40347 &%authresults%& expansion item.
40348
40349
40350 .cindex SPF "ACL condition"
40351 .cindex ACL "spf condition"
40352 The ACL condition "spf" can be used at or after the MAIL ACL.
40353 It takes as an argument a list of strings giving the outcome of the SPF check,
40354 and will succeed for any matching outcome.
40355 Valid strings are:
40356 .vlist
40357 .vitem &%pass%&
40358 The SPF check passed, the sending host is positively verified by SPF.
40359
40360 .vitem &%fail%&
40361 The SPF check failed, the sending host is NOT allowed to send mail for the
40362 domain in the envelope-from address.
40363
40364 .vitem &%softfail%&
40365 The SPF check failed, but the queried domain can't absolutely confirm that this
40366 is a forgery.
40367
40368 .vitem &%none%&
40369 The queried domain does not publish SPF records.
40370
40371 .vitem &%neutral%&
40372 The SPF check returned a "neutral" state.  This means the queried domain has
40373 published a SPF record, but wants to allow outside servers to send mail under
40374 its domain as well.  This should be treated like "none".
40375
40376 .vitem &%permerror%&
40377 This indicates a syntax error in the SPF record of the queried domain.
40378 You may deny messages when this occurs.
40379
40380 .vitem &%temperror%&
40381 This indicates a temporary error during all processing, including Exim's
40382 SPF processing.  You may defer messages when this occurs.
40383 .endlist
40384
40385 You can prefix each string with an exclamation mark to  invert
40386 its meaning,  for example  "!fail" will  match all  results but
40387 "fail".  The  string  list is  evaluated  left-to-right,  in a
40388 short-circuit fashion.
40389
40390 Example:
40391 .code
40392 deny spf = fail
40393      message = $sender_host_address is not allowed to send mail from \
40394                ${if def:sender_address_domain \
40395                     {$sender_address_domain}{$sender_helo_name}}.  \
40396                Please see http://www.openspf.org/Why?scope=\
40397                ${if def:sender_address_domain {mfrom}{helo}};\
40398                identity=${if def:sender_address_domain \
40399                              {$sender_address}{$sender_helo_name}};\
40400                ip=$sender_host_address
40401 .endd
40402
40403 When the spf condition has run, it sets up several expansion
40404 variables:
40405
40406 .cindex SPF "verification variables"
40407 .vlist
40408 .vitem &$spf_header_comment$&
40409 .vindex &$spf_header_comment$&
40410   This contains a human-readable string describing the outcome
40411   of the SPF check. You can add it to a custom header or use
40412   it for logging purposes.
40413
40414 .vitem &$spf_received$&
40415 .vindex &$spf_received$&
40416   This contains a complete Received-SPF: header that can be
40417   added to the message. Please note that according to the SPF
40418   draft, this header must be added at the top of the header
40419   list. Please see section 10 on how you can do this.
40420
40421   Note: in case of "Best-guess" (see below), the convention is
40422   to put this string in a header called X-SPF-Guess: instead.
40423
40424 .vitem &$spf_result$&
40425 .vindex &$spf_result$&
40426   This contains the outcome of the SPF check in string form,
40427   one of pass, fail, softfail, none, neutral, permerror or
40428   temperror.
40429
40430 .vitem &$spf_result_guessed$&
40431 .vindex &$spf_result_guessed$&
40432   This boolean is true only if a best-guess operation was used
40433   and required in order to obtain a result.
40434
40435 .vitem &$spf_smtp_comment$&
40436 .vindex &$spf_smtp_comment$&
40437   This contains a string that can be used in a SMTP response
40438   to the calling party. Useful for "fail".
40439 .endlist
40440
40441
40442 .cindex SPF "ACL condition"
40443 .cindex ACL "spf_guess condition"
40444 .cindex SPF "best guess"
40445 In addition to SPF, you can also perform checks for so-called
40446 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40447 SPF, but it is supported by the same framework that enables SPF
40448 capability.
40449 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
40450 for a description of what it means.
40451 . --- 2018-09-07: still not https:
40452
40453 To access this feature, simply use the spf_guess condition in place
40454 of the spf one.  For example:
40455
40456 .code
40457 deny spf_guess = fail
40458      message = $sender_host_address doesn't look trustworthy to me
40459 .endd
40460
40461 In case you decide to reject messages based on this check, you
40462 should note that although it uses the same framework, "Best-guess"
40463 is not SPF, and therefore you should not mention SPF at all in your
40464 reject message.
40465
40466 When the spf_guess condition has run, it sets up the same expansion
40467 variables as when spf condition is run, described above.
40468
40469 Additionally, since Best-guess is not standardized, you may redefine
40470 what "Best-guess" means to you by redefining the main configuration
40471 &%spf_guess%& option.
40472 For example, the following:
40473
40474 .code
40475 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40476 .endd
40477
40478 would relax host matching rules to a broader network range.
40479
40480
40481 .cindex SPF "lookup expansion"
40482 .cindex lookup spf
40483 A lookup expansion is also available. It takes an email
40484 address as the key and an IP address
40485 .new
40486 (v4 or v6)
40487 .wen
40488 as the database:
40489
40490 .code
40491   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40492 .endd
40493
40494 The lookup will return the same result strings as can appear in
40495 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40496
40497
40498
40499
40500
40501 .new
40502 .section DMARC SECDMARC
40503 .cindex DMARC verification
40504
40505 DMARC combines feedback from SPF, DKIM, and header From: in order
40506 to attempt to provide better indicators of the authenticity of an
40507 email.  This document does not explain the fundamentals; you
40508 should read and understand how it works by visiting the website at
40509 &url(http://www.dmarc.org/).
40510
40511 If Exim is built with DMARC support,
40512 the libopendmarc library is used.
40513
40514 For building Exim yourself, obtain the library from
40515 &url(http://sourceforge.net/projects/opendmarc/)
40516 to obtain a copy, or find it in your favorite rpm package
40517 repository.  You will need to attend to the local/Makefile feature
40518 SUPPORT_DMARC and the associated LDFLAGS addition.
40519 This description assumes
40520 that headers will be in /usr/local/include, and that the libraries
40521 are in /usr/local/lib.
40522
40523 . subsection
40524
40525 There are three main-configuration options:
40526 .cindex DMARC "configuration options"
40527
40528 The &%dmarc_tld_file%& option
40529 .oindex &%dmarc_tld_file%&
40530 defines the location of a text file of valid
40531 top level domains the opendmarc library uses
40532 during domain parsing. Maintained by Mozilla,
40533 the most current version can be downloaded
40534 from a link at &url(https://publicsuffix.org/list/, currently pointing
40535 at https://publicsuffix.org/list/public_suffix_list.dat)
40536 See also util/renew-opendmarc-tlds.sh script.
40537 The default for the option is /etc/exim/opendmarc.tlds.
40538
40539
40540 The &%dmarc_history_file%& option, if set
40541 .oindex &%dmarc_history_file%&
40542 defines the location of a file to log results
40543 of dmarc verification on inbound emails. The
40544 contents are importable by the opendmarc tools
40545 which will manage the data, send out DMARC
40546 reports, and expire the data. Make sure the
40547 directory of this file is writable by the user
40548 exim runs as.
40549 The default is unset.
40550
40551 The &%dmarc_forensic_sender%& option
40552 .oindex &%dmarc_forensic_sender%&
40553 defines an alternate email address to use when sending a
40554 forensic report detailing alignment failures
40555 if a sender domain's dmarc record specifies it
40556 and you have configured Exim to send them.
40557 If set, this is expanded and used for the
40558 From: header line; the address is extracted
40559 from it and used for the envelope from.
40560 If not set (the default), the From: header is expanded from
40561 the dsn_from option, and <> is used for the
40562 envelope from.
40563
40564 . I wish we had subsections...
40565
40566 .cindex DMARC controls
40567 By default, the DMARC processing will run for any remote,
40568 non-authenticated user.  It makes sense to only verify DMARC
40569 status of messages coming from remote, untrusted sources.  You can
40570 use standard conditions such as hosts, senders, etc, to decide that
40571 DMARC verification should *not* be performed for them and disable
40572 DMARC with a control setting:
40573 .code
40574   control = dmarc_disable_verify
40575 .endd
40576 A DMARC record can also specify a "forensic address", which gives
40577 exim an email address to submit reports about failed alignment.
40578 Exim does not do this by default because in certain conditions it
40579 results in unintended information leakage (what lists a user might
40580 be subscribed to, etc).  You must configure exim to submit forensic
40581 reports to the owner of the domain.  If the DMARC record contains a
40582 forensic address and you specify the control statement below, then
40583 exim will send these forensic emails.  It's also advised that you
40584 configure a dmarc_forensic_sender because the default sender address
40585 construction might be inadequate.
40586 .code
40587   control = dmarc_enable_forensic
40588 .endd
40589 (AGAIN: You can choose not to send these forensic reports by simply
40590 not putting the dmarc_enable_forensic control line at any point in
40591 your exim config.  If you don't tell it to send them, it will not
40592 send them.)
40593
40594 There are no options to either control.  Both must appear before
40595 the DATA acl.
40596
40597 . subsection
40598
40599 DMARC checks cam be run on incoming SMTP  messages by using the
40600 "dmarc_status" ACL condition in the DATA ACL.  You are required to
40601 call the "spf" condition first in the ACLs, then the "dmarc_status"
40602 condition.  Putting this condition in the ACLs is required in order
40603 for a DMARC check to actually occur.  All of the variables are set
40604 up before the DATA ACL, but there is no actual DMARC check that
40605 occurs until a "dmarc_status" condition is encountered in the ACLs.
40606
40607 The dmarc_status condition takes a list of strings on its
40608 right-hand side.  These strings describe recommended action based
40609 on the DMARC check.  To understand what the policy recommendations
40610 mean, refer to the DMARC website above.  Valid strings are:
40611 .display
40612 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40613 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40614 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40615 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40616 &'norecord    '& No policy section in the DMARC record for this sender domain.
40617 &'nofrom      '& Unable to determine the domain of the sender.
40618 &'temperror   '& Library error or dns error.
40619 &'off         '& The DMARC check was disabled for this email.
40620 .endd
40621 You can prefix each string with an exclamation mark to invert its
40622 meaning, for example "!accept" will match all results but
40623 "accept".  The string list is evaluated left-to-right in a
40624 short-circuit fashion.  When a string matches the outcome of the
40625 DMARC check, the condition succeeds.  If none of the listed
40626 strings matches the outcome of the DMARC check, the condition
40627 fails.
40628
40629 Of course, you can also use any other lookup method that Exim
40630 supports, including LDAP, Postgres, MySQL, etc, as long as the
40631 result is a list of colon-separated strings.
40632
40633 Performing the check sets up information used by the
40634 &%authresults%& expansion item.
40635
40636 Several expansion variables are set before the DATA ACL is
40637 processed, and you can use them in this ACL.  The following
40638 expansion variables are available:
40639
40640 &$dmarc_status$&
40641 .vindex &$dmarc_status$&
40642 .cindex DMARC result
40643 is a one word status indicating what the DMARC library
40644 thinks of the email.  It is a combination of the results of
40645 DMARC record lookup and the SPF/DKIM/DMARC processing results
40646 (if a DMARC record was found).  The actual policy declared
40647 in the DMARC record is in a separate expansion variable.
40648
40649 &$dmarc_status_text$&
40650 .vindex &$dmarc_status_text$&
40651 is a slightly longer, human readable status.
40652
40653 &$dmarc_used_domain$&
40654 .vindex &$dmarc_used_domain$&
40655 is the domain which DMARC used to look up the DMARC policy record.
40656
40657 &$dmarc_domain_policy$&
40658 .vindex &$dmarc_domain_policy$&
40659 is the policy declared in the DMARC record.  Valid values
40660 are "none", "reject" and "quarantine".  It is blank when there
40661 is any error, including no DMARC record.
40662
40663 . subsection
40664
40665 By default, Exim's DMARC configuration is intended to be
40666 non-intrusive and conservative.  To facilitate this, Exim will not
40667 create any type of logging files without explicit configuration by
40668 you, the admin.  Nor will Exim send out any emails/reports about
40669 DMARC issues without explicit configuration by you, the admin (other
40670 than typical bounce messages that may come about due to ACL
40671 processing or failure delivery issues).
40672
40673 In order to log statistics suitable to be imported by the opendmarc
40674 tools, you need to:
40675 .ilist
40676 Configure the global setting dmarc_history_file
40677 .next
40678 Configure cron jobs to call the appropriate opendmarc history
40679 import scripts and truncating the dmarc_history_file
40680 .endlist
40681
40682 In order to send forensic reports, you need to:
40683 .ilist
40684 Configure the global setting dmarc_forensic_sender
40685 .next
40686 Configure, somewhere before the DATA ACL, the control option to
40687 enable sending DMARC forensic reports
40688 .endlist
40689
40690 . subsection
40691
40692 Example usage:
40693 .code
40694 (RCPT ACL)
40695   warn    domains        = +local_domains
40696           hosts          = +local_hosts
40697           control        = dmarc_disable_verify
40698
40699   warn    !domains       = +screwed_up_dmarc_records
40700           control        = dmarc_enable_forensic
40701
40702   warn    condition      = (lookup if destined to mailing list)
40703           set acl_m_mailing_list = 1
40704
40705 (DATA ACL)
40706   warn    dmarc_status   = accept : none : off
40707           !authenticated = *
40708           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40709
40710   warn    dmarc_status   = !accept
40711           !authenticated = *
40712           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40713
40714   warn    dmarc_status   = quarantine
40715           !authenticated = *
40716           set $acl_m_quarantine = 1
40717           # Do something in a transport with this flag variable
40718
40719   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40720           condition      = ${if eq{$acl_m_mailing_list}{1}}
40721           message        = Messages from $dmarc_used_domain break mailing lists
40722
40723   deny    dmarc_status   = reject
40724           !authenticated = *
40725           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40726
40727   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40728 .endd
40729
40730 .wen
40731
40732
40733
40734
40735 . ////////////////////////////////////////////////////////////////////////////
40736 . ////////////////////////////////////////////////////////////////////////////
40737
40738 .chapter "Proxies" "CHAPproxies" &&&
40739          "Proxy support"
40740 .cindex "proxy support"
40741 .cindex "proxy" "access via"
40742
40743 A proxy is an intermediate system through which communication is passed.
40744 Proxies may provide a security, availability or load-distribution function.
40745
40746
40747 .section "Inbound proxies" SECTproxyInbound
40748 .cindex proxy inbound
40749 .cindex proxy "server side"
40750 .cindex proxy "Proxy protocol"
40751 .cindex "Proxy protocol" proxy
40752
40753 Exim has support for receiving inbound SMTP connections via a proxy
40754 that uses &"Proxy Protocol"& to speak to it.
40755 To include this support, include &"SUPPORT_PROXY=yes"&
40756 in Local/Makefile.
40757
40758 It was built on the HAProxy specification, found at
40759 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40760
40761 The purpose of this facility is so that an application load balancer,
40762 such as HAProxy, can sit in front of several Exim servers
40763 to distribute load.
40764 Exim uses the local protocol communication with the proxy to obtain
40765 the remote SMTP system IP address and port information.
40766 There is no logging if a host passes or
40767 fails Proxy Protocol negotiation, but it can easily be determined and
40768 recorded in an ACL (example is below).
40769
40770 Use of a proxy is enabled by setting the &%hosts_proxy%&
40771 main configuration option to a hostlist; connections from these
40772 hosts will use Proxy Protocol.
40773 Exim supports both version 1 and version 2 of the Proxy Protocol and
40774 automatically determines which version is in use.
40775
40776 The Proxy Protocol header is the first data received on a TCP connection
40777 and is inserted before any TLS-on-connect handshake from the client; Exim
40778 negotiates TLS between Exim-as-server and the remote client, not between
40779 Exim and the proxy server.
40780
40781 The following expansion variables are usable
40782 (&"internal"& and &"external"& here refer to the interfaces
40783 of the proxy):
40784 .display
40785 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40786 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40787 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40788 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40789 &'proxy_session            '& boolean: SMTP connection via proxy
40790 .endd
40791 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40792 there was a protocol error.
40793 The variables &$sender_host_address$& and &$sender_host_port$&
40794 will have values for the actual client system, not the proxy.
40795
40796 Since the real connections are all coming from the proxy, and the
40797 per host connection tracking is done before Proxy Protocol is
40798 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40799 handle all of the parallel volume you expect per inbound proxy.
40800 With the option set so high, you lose the ability
40801 to protect your server from many connections from one IP.
40802 In order to prevent your server from overload, you
40803 need to add a per connection ratelimit to your connect ACL.
40804 A possible solution is:
40805 .display
40806   # Set max number of connections per host
40807   LIMIT   = 5
40808   # Or do some kind of IP lookup in a flat file or database
40809   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40810
40811   defer   message        = Too many connections from this IP right now
40812           ratelimit      = LIMIT / 5s / per_conn / strict
40813 .endd
40814
40815
40816
40817 .section "Outbound proxies" SECTproxySOCKS
40818 .cindex proxy outbound
40819 .cindex proxy "client side"
40820 .cindex proxy SOCKS
40821 .cindex SOCKS proxy
40822 Exim has support for sending outbound SMTP via a proxy
40823 using a protocol called SOCKS5 (defined by RFC1928).
40824 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40825 Local/Makefile.
40826
40827 Use of a proxy is enabled by setting the &%socks_proxy%& option
40828 on an smtp transport.
40829 The option value is expanded and should then be a list
40830 (colon-separated by default) of proxy specifiers.
40831 Each proxy specifier is a list
40832 (space-separated by default) where the initial element
40833 is an IP address and any subsequent elements are options.
40834
40835 Options are a string <name>=<value>.
40836 The list of options is in the following table:
40837 .display
40838 &'auth   '& authentication method
40839 &'name   '& authentication username
40840 &'pass   '& authentication password
40841 &'port   '& tcp port
40842 &'tmo    '& connection timeout
40843 &'pri    '& priority
40844 &'weight '& selection bias
40845 .endd
40846
40847 More details on each of these options follows:
40848
40849 .ilist
40850 .cindex authentication "to proxy"
40851 .cindex proxy authentication
40852 &%auth%&: Either &"none"& (default) or &"name"&.
40853 Using &"name"& selects username/password authentication per RFC 1929
40854 for access to the proxy.
40855 Default is &"none"&.
40856 .next
40857 &%name%&: sets the username for the &"name"& authentication method.
40858 Default is empty.
40859 .next
40860 &%pass%&: sets the password for the &"name"& authentication method.
40861 Default is empty.
40862 .next
40863 &%port%&: the TCP port number to use for the connection to the proxy.
40864 Default is 1080.
40865 .next
40866 &%tmo%&: sets a connection timeout in seconds for this proxy.
40867 Default is 5.
40868 .next
40869 &%pri%&: specifies a priority for the proxy within the list,
40870 higher values being tried first.
40871 The default priority is 1.
40872 .next
40873 &%weight%&: specifies a selection bias.
40874 Within a priority set servers are queried in a random fashion,
40875 weighted by this value.
40876 The default value for selection bias is 1.
40877 .endlist
40878
40879 Proxies from the list are tried according to their priority
40880 and weight settings until one responds.  The timeout for the
40881 overall connection applies to the set of proxied attempts.
40882
40883 .section Logging SECTproxyLog
40884 To log the (local) IP of a proxy in the incoming or delivery logline,
40885 add &"+proxy"& to the &%log_selector%& option.
40886 This will add a component tagged with &"PRX="& to the line.
40887
40888 . ////////////////////////////////////////////////////////////////////////////
40889 . ////////////////////////////////////////////////////////////////////////////
40890
40891 .chapter "Internationalisation" "CHAPi18n" &&&
40892          "Internationalisation""
40893 .cindex internationalisation "email address"
40894 .cindex EAI
40895 .cindex i18n
40896 .cindex utf8 "mail name handling"
40897
40898 Exim has support for Internationalised mail names.
40899 To include this it must be built with SUPPORT_I18N and the libidn library.
40900 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40901
40902 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40903 instead of it) then IDNA2008 is supported; this adds an extra library
40904 requirement, upon libidn2.
40905
40906 .section "MTA operations" SECTi18nMTA
40907 .cindex SMTPUTF8 "ESMTP option"
40908 The main configuration option &%smtputf8_advertise_hosts%& specifies
40909 a host list.  If this matches the sending host and
40910 accept_8bitmime is true (the default) then the ESMTP option
40911 SMTPUTF8 will be advertised.
40912
40913 If the sender specifies the SMTPUTF8 option on a MAIL command
40914 international handling for the message is enabled and
40915 the expansion variable &$message_smtputf8$& will have value TRUE.
40916
40917 The option &%allow_utf8_domains%& is set to true for this
40918 message. All DNS lookups are converted to a-label form
40919 whatever the setting of &%allow_utf8_domains%&
40920 when Exim is built with SUPPORT_I18N.
40921
40922 Both localparts and domain are maintained as the original
40923 UTF-8 form internally; any comparison or regular-expression use will
40924 require appropriate care.  Filenames created, eg. by
40925 the appendfile transport, will have UTF-8 names.
40926
40927 HELO names sent by the smtp transport will have any UTF-8
40928 components expanded to a-label form,
40929 and any certificate name checks will be done using the a-label
40930 form of the name.
40931
40932 .cindex log protocol
40933 .cindex SMTPUTF8 logging
40934 .cindex i18n logging
40935 Log lines and Received-by: header lines will acquire a "utf8"
40936 prefix on the protocol element, eg. utf8esmtp.
40937
40938 The following expansion operators can be used:
40939 .code
40940 ${utf8_domain_to_alabel:str}
40941 ${utf8_domain_from_alabel:str}
40942 ${utf8_localpart_to_alabel:str}
40943 ${utf8_localpart_from_alabel:str}
40944 .endd
40945
40946 .cindex utf8 "address downconversion"
40947 .cindex i18n "utf8 address downconversion"
40948 The RCPT ACL
40949 may use the following modifier:
40950 .display
40951 control = utf8_downconvert
40952 control = utf8_downconvert/<value>
40953 .endd
40954 This sets a flag requiring that addresses are converted to
40955 a-label form before smtp delivery, for use in a
40956 Message Submission Agent context.
40957 If a value is appended it may be:
40958 .display
40959 &`1  `& (default) mandatory downconversion
40960 &`0  `& no downconversion
40961 &`-1 `& if SMTPUTF8 not supported by destination host
40962 .endd
40963
40964 If mua_wrapper is set, the utf8_downconvert control
40965 is initially set to -1.
40966
40967 The smtp transport has an option &%utf8_downconvert%&.
40968 If set it must expand to one of the three values described above,
40969 and it overrides any previously set value.
40970
40971
40972 There is no explicit support for VRFY and EXPN.
40973 Configurations supporting these should inspect
40974 &$smtp_command_argument$& for an SMTPUTF8 argument.
40975
40976 There is no support for LMTP on Unix sockets.
40977 Using the "lmtp" protocol option on an smtp transport,
40978 for LMTP over TCP, should work as expected.
40979
40980 There is no support for DSN unitext handling,
40981 and no provision for converting logging from or to UTF-8.
40982
40983
40984
40985 .section "MDA operations" SECTi18nMDA
40986 To aid in constructing names suitable for IMAP folders
40987 the following expansion operator can be used:
40988 .code
40989 ${imapfolder {<string>} {<sep>} {<specials>}}
40990 .endd
40991
40992 The string is converted from the charset specified by
40993 the "headers charset" command (in a filter file)
40994 or &%headers_charset%& main configuration option (otherwise),
40995 to the
40996 modified UTF-7 encoding specified by RFC 2060,
40997 with the following exception: All occurrences of <sep>
40998 (which has to be a single character)
40999 are replaced with periods ("."), and all periods and slashes that are not
41000 <sep> and are not in the <specials> string are BASE64 encoded.
41001
41002 The third argument can be omitted, defaulting to an empty string.
41003 The second argument can be omitted, defaulting to "/".
41004
41005 This is the encoding used by Courier for Maildir names on disk, and followed
41006 by many other IMAP servers.
41007
41008 Examples:
41009 .display
41010 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41011 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41012 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41013 .endd
41014
41015 Note that the source charset setting is vital, and also that characters
41016 must be representable in UTF-16.
41017
41018
41019 . ////////////////////////////////////////////////////////////////////////////
41020 . ////////////////////////////////////////////////////////////////////////////
41021
41022 .chapter "Events" "CHAPevents" &&&
41023          "Events"
41024 .cindex events
41025
41026 The events mechanism in Exim can be used to intercept processing at a number
41027 of points.  It was originally invented to give a way to do customised logging
41028 actions (for example, to a database) but can also be used to modify some
41029 processing actions.
41030
41031 Most installations will never need to use Events.
41032 The support can be left out of a build by defining DISABLE_EVENT=yes
41033 in &_Local/Makefile_&.
41034
41035 There are two major classes of events: main and transport.
41036 The main configuration option &%event_action%& controls reception events;
41037 a transport option &%event_action%& controls delivery events.
41038
41039 Both options are a string which is expanded when the event fires.
41040 An example might look like:
41041 .cindex logging custom
41042 .code
41043 event_action = ${if eq {msg:delivery}{$event_name} \
41044 {${lookup pgsql {SELECT * FROM record_Delivery( \
41045     '${quote_pgsql:$sender_address_domain}',\
41046     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41047     '${quote_pgsql:$domain}', \
41048     '${quote_pgsql:${lc:$local_part}}', \
41049     '${quote_pgsql:$host_address}', \
41050     '${quote_pgsql:${lc:$host}}', \
41051     '${quote_pgsql:$message_exim_id}')}} \
41052 } {}}
41053 .endd
41054
41055 Events have names which correspond to the point in process at which they fire.
41056 The name is placed in the variable &$event_name$& and the event action
41057 expansion must check this, as it will be called for every possible event type.
41058
41059 .new
41060 The current list of events is:
41061 .wen
41062 .display
41063 &`dane:fail              after    transport  `& per connection
41064 &`msg:complete           after    main       `& per message
41065 &`msg:delivery           after    transport  `& per recipient
41066 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41067 &`msg:rcpt:defer         after    transport  `& per recipient
41068 &`msg:host:defer         after    transport  `& per attempt
41069 &`msg:fail:delivery      after    transport  `& per recipient
41070 &`msg:fail:internal      after    main       `& per recipient
41071 &`tcp:connect            before   transport  `& per connection
41072 &`tcp:close              after    transport  `& per connection
41073 &`tls:cert               before   both       `& per certificate in verification chain
41074 &`smtp:connect           after    transport  `& per connection
41075 &`smtp:ehlo              after    transport  `& per connection
41076 .endd
41077 New event types may be added in future.
41078
41079 The event name is a colon-separated list, defining the type of
41080 event in a tree of possibilities.  It may be used as a list
41081 or just matched on as a whole.  There will be no spaces in the name.
41082
41083 The second column in the table above describes whether the event fires
41084 before or after the action is associates with.  Those which fire before
41085 can be used to affect that action (more on this below).
41086
41087 The third column in the table above says what section of the configuration
41088 should define the event action.
41089
41090 An additional variable, &$event_data$&, is filled with information varying
41091 with the event type:
41092 .display
41093 &`dane:fail            `& failure reason
41094 &`msg:delivery         `& smtp confirmation message
41095 &`msg:fail:internal    `& failure reason
41096 &`msg:fail:delivery    `& smtp error message
41097 &`msg:rcpt:host:defer  `& error string
41098 &`msg:rcpt:defer       `& error string
41099 &`msg:host:defer       `& error string
41100 &`tls:cert             `& verification chain depth
41101 &`smtp:connect         `& smtp banner
41102 &`smtp:ehlo            `& smtp ehlo response
41103 .endd
41104
41105 The :defer events populate one extra variable: &$event_defer_errno$&.
41106
41107 For complex operations an ACL expansion can be used in &%event_action%&
41108 however due to the multiple contexts that Exim operates in during
41109 the course of its processing:
41110 .ilist
41111 variables set in transport events will not be visible outside that
41112 transport call
41113 .next
41114 acl_m variables in a server context are lost on a new connection,
41115 and after smtp helo/ehlo/mail/starttls/rset commands
41116 .endlist
41117 Using an ACL expansion with the logwrite modifier can be
41118 a useful way of writing to the main log.
41119
41120 The expansion of the event_action option should normally
41121 return an empty string.  Should it return anything else the
41122 following will be forced:
41123 .display
41124 &`tcp:connect      `&  do not connect
41125 &`tls:cert         `&  refuse verification
41126 &`smtp:connect     `&  close connection
41127 .endd
41128 All other message types ignore the result string, and
41129 no other use is made of it.
41130
41131 For a tcp:connect event, if the connection is being made to a proxy
41132 then the address and port variables will be that of the proxy and not
41133 the target system.
41134
41135 For tls:cert events, if GnuTLS is in use this will trigger only per
41136 chain element received on the connection.
41137 For OpenSSL it will trigger for every chain element including those
41138 loaded locally.
41139
41140 . ////////////////////////////////////////////////////////////////////////////
41141 . ////////////////////////////////////////////////////////////////////////////
41142
41143 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41144          "Adding drivers or lookups"
41145 .cindex "adding drivers"
41146 .cindex "new drivers, adding"
41147 .cindex "drivers" "adding new"
41148 The following actions have to be taken in order to add a new router, transport,
41149 authenticator, or lookup type to Exim:
41150
41151 .olist
41152 Choose a name for the driver or lookup type that does not conflict with any
41153 existing name; I will use &"newdriver"& in what follows.
41154 .next
41155 Add to &_src/EDITME_& the line:
41156 .display
41157 <&'type'&>&`_NEWDRIVER=yes`&
41158 .endd
41159 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41160 code is not to be included in the binary by default, comment this line out. You
41161 should also add any relevant comments about the driver or lookup type.
41162 .next
41163 Add to &_src/config.h.defaults_& the line:
41164 .code
41165 #define <type>_NEWDRIVER
41166 .endd
41167 .next
41168 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41169 and create a table entry as is done for all the other drivers and lookup types.
41170 .next
41171 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41172 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41173 Add your &`NEWDRIVER`& to that list.
41174 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41175 simple form that most lookups have.
41176 .next
41177 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41178 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41179 driver or lookup type and add it to the definition of OBJ.
41180 .next
41181 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41182 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41183 .next
41184 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41185 &_src_&.
41186 .next
41187 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41188 as for other drivers and lookups.
41189 .endlist
41190
41191 Then all you need to do is write the code! A good way to start is to make a
41192 proforma by copying an existing module of the same type, globally changing all
41193 occurrences of the name, and cutting out most of the code. Note that any
41194 options you create must be listed in alphabetical order, because the tables are
41195 searched using a binary chop procedure.
41196
41197 There is a &_README_& file in each of the sub-directories of &_src_& describing
41198 the interface that is expected.
41199
41200
41201
41202
41203 . ////////////////////////////////////////////////////////////////////////////
41204 . ////////////////////////////////////////////////////////////////////////////
41205
41206 . /////////////////////////////////////////////////////////////////////////////
41207 . These lines are processing instructions for the Simple DocBook Processor that
41208 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41209 . PDFs than using xmlto and fop. They will be ignored by all other XML
41210 . processors.
41211 . /////////////////////////////////////////////////////////////////////////////
41212
41213 .literal xml
41214 <?sdop
41215   format="newpage"
41216   foot_right_recto="&chaptertitle;"
41217   foot_right_verso="&chaptertitle;"
41218 ?>
41219 .literal off
41220
41221 .makeindex "Options index"   "option"
41222 .makeindex "Variables index" "variable"
41223 .makeindex "Concept index"   "concept"
41224
41225
41226 . /////////////////////////////////////////////////////////////////////////////
41227 . /////////////////////////////////////////////////////////////////////////////